git.sur5r.net Git - i3/i3/blob - include/floating.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * floating.c: Floating windows.
   8  *
   9  */
  10 #pragma once
  11
  12 #include "tree.h"
  13
  14 /** Callback for dragging */
  15 typedef void (*callback_t)(Con *, Rect *, uint32_t, uint32_t, const void *);
  16
  17 /** Macro to create a callback function for dragging */
  18 #define DRAGGING_CB(name)                                      \
  19     static void name(Con *con, Rect *old_rect, uint32_t new_x, \
  20                      uint32_t new_y, const void *extra)
  21
  22 /** On which border was the dragging initiated? */
  23 typedef enum { BORDER_LEFT = (1 << 0),
  24                BORDER_RIGHT = (1 << 1),
  25                BORDER_TOP = (1 << 2),
  26                BORDER_BOTTOM = (1 << 3) } border_t;
  27
  28 /**
  29  * Enables floating mode for the given container by detaching it from its
  30  * parent, creating a new container around it and storing this container in the
  31  * floating_windows list of the workspace.
  32  *
  33  */
  34 void floating_enable(Con *con, bool automatic);
  35
  36 /**
  37  * Disables floating mode for the given container by re-attaching the container
  38  * to its old parent.
  39  *
  40  */
  41 void floating_disable(Con *con, bool automatic);
  42
  43 /**
  44  * Calls floating_enable() for tiling containers and floating_disable() for
  45  * floating containers.
  46  *
  47  * If the automatic flag is set to true, this was an automatic update by a
  48  * change of the window class from the application which can be overwritten by
  49  * the user.
  50  *
  51  */
  52 void toggle_floating_mode(Con *con, bool automatic);
  53
  54 /**
  55  * Raises the given container in the list of floating containers
  56  *
  57  */
  58 void floating_raise_con(Con *con);
  59
  60 /**
  61  * Checks if con’s coordinates are within its workspace and re-assigns it to
  62  * the actual workspace if not.
  63  *
  64  */
  65 bool floating_maybe_reassign_ws(Con *con);
  66
  67 /**
  68  * Centers a floating con above the specified rect.
  69  *
  70  */
  71 void floating_center(Con *con, Rect rect);
  72
  73 #if 0
  74 /**
  75  * Removes the floating client from its workspace and attaches it to the new
  76  * workspace. This is centralized here because it may happen if you move it
  77  * via keyboard and if you move it using your mouse.
  78  *
  79  */
  80 void floating_assign_to_workspace(Client *client, Workspace *new_workspace);
  81
  82 /**
  83  * Called whenever the user clicks on a border (not the titlebar!) of a
  84  * floating window. Determines on which border the user clicked and launches
  85  * the drag_pointer function with the resize_callback.
  86  *
  87  */
  88 int floating_border_click(xcb_connection_t *conn, Client *client,
  89                           xcb_button_press_event_t *event);
  90
  91 #endif
  92 /**
  93  * Called when the user clicked on the titlebar of a floating window.
  94  * Calls the drag_pointer function with the drag_window callback
  95  *
  96  */
  97 void floating_drag_window(Con *con, const xcb_button_press_event_t *event);
  98
  99 /**
 100  * Called when the user clicked on a floating window while holding the
 101  * floating_modifier and the right mouse button.
 102  * Calls the drag_pointer function with the resize_window callback
 103  *
 104  */
 105 void floating_resize_window(Con *con, const bool proportional, const xcb_button_press_event_t *event);
 106
 107 /**
 108  * Called when a floating window is created or resized.
 109  * This function resizes the window if its size is higher or lower than the
 110  * configured maximum/minimum size, respectively.
 111  *
 112  */
 113 void floating_check_size(Con *floating_con);
 114
 115 #if 0
 116 /**
 117  * Changes focus in the given direction for floating clients.
 118  *
 119  * Changing to the left/right means going to the previous/next floating client,
 120  * changing to top/bottom means cycling through the Z-index.
 121  *
 122  */
 123 void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused,
 124                               direction_t direction);
 125
 126 /**
 127  * Moves the client 10px to the specified direction.
 128  *
 129  */
 130 void floating_move(xcb_connection_t *conn, Client *currently_focused,
 131                    direction_t direction);
 132
 133 /**
 134  * Hides all floating clients (or show them if they are currently hidden) on
 135  * the specified workspace.
 136  *
 137  */
 138 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace);
 139
 140 #endif
 141 /**
 142  * This is the return value of a drag operation like drag_pointer.
 143  *
 144  * DRAGGING will indicate the drag action is still in progress and can be
 145  * continued or resolved.
 146  *
 147  * DRAG_SUCCESS will indicate the intention of the drag action should be
 148  * carried out.
 149  *
 150  * DRAG_REVERT will indicate an attempt should be made to restore the state of
 151  * the involved windows to their condition before the drag.
 152  *
 153  * DRAG_ABORT will indicate that the intention of the drag action cannot be
 154  * carried out (e.g. because the window has been unmapped).
 155  *
 156  */
 157 typedef enum {
 158     DRAGGING = 0,
 159     DRAG_SUCCESS,
 160     DRAG_REVERT,
 161     DRAG_ABORT
 162 } drag_result_t;
 163
 164 /**
 165  * This function grabs your pointer and keyboard and lets you drag stuff around
 166  * (borders). Every time you move your mouse, an XCB_MOTION_NOTIFY event will
 167  * be received and the given callback will be called with the parameters
 168  * specified (client, border on which the click originally was), the original
 169  * rect of the client, the event and the new coordinates (x, y).
 170  *
 171  */
 172 drag_result_t drag_pointer(Con *con, const xcb_button_press_event_t *event,
 173                            xcb_window_t confine_to, border_t border, int cursor,
 174                            callback_t callback, const void *extra);
 175
 176 /**
 177  * Repositions the CT_FLOATING_CON to have the coordinates specified by
 178  * newrect, but only if the coordinates are not out-of-bounds. Also reassigns
 179  * the floating con to a different workspace if this move was across different
 180  * outputs.
 181  *
 182  */
 183 void floating_reposition(Con *con, Rect newrect);
 184
 185 /**
 186  * Fixes the coordinates of the floating window whenever the window gets
 187  * reassigned to a different output (or when the output’s rect changes).
 188  *
 189  */
 190 void floating_fix_coordinates(Con *con, Rect *old_rect, Rect *new_rect);