2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * floating.c: Floating windows.
16 /** Callback for dragging */
17 typedef void (*callback_t)(Con *, Rect *, uint32_t, uint32_t, const void *);
19 /** Macro to create a callback function for dragging */
20 #define DRAGGING_CB(name) \
21 static void name(Con *con, Rect *old_rect, uint32_t new_x, \
22 uint32_t new_y, const void *extra)
24 /** On which border was the dragging initiated? */
25 typedef enum { BORDER_LEFT = (1 << 0),
26 BORDER_RIGHT = (1 << 1),
27 BORDER_TOP = (1 << 2),
28 BORDER_BOTTOM = (1 << 3) } border_t;
31 * Enables floating mode for the given container by detaching it from its
32 * parent, creating a new container around it and storing this container in the
33 * floating_windows list of the workspace.
36 void floating_enable(Con *con, bool automatic);
39 * Disables floating mode for the given container by re-attaching the container
43 void floating_disable(Con *con, bool automatic);
46 * Calls floating_enable() for tiling containers and floating_disable() for
47 * floating containers.
49 * If the automatic flag is set to true, this was an automatic update by a
50 * change of the window class from the application which can be overwritten by
54 void toggle_floating_mode(Con *con, bool automatic);
57 * Raises the given container in the list of floating containers
60 void floating_raise_con(Con *con);
63 * Checks if con’s coordinates are within its workspace and re-assigns it to
64 * the actual workspace if not.
67 bool floating_maybe_reassign_ws(Con *con);
70 * Centers a floating con above the specified rect.
73 void floating_center(Con *con, Rect rect);
76 * Moves the given floating con to the current pointer position.
79 void floating_move_to_pointer(Con *con);
82 * Called when the user clicked on the titlebar of a floating window.
83 * Calls the drag_pointer function with the drag_window callback
86 void floating_drag_window(Con *con, const xcb_button_press_event_t *event);
89 * Called when the user clicked on a floating window while holding the
90 * floating_modifier and the right mouse button.
91 * Calls the drag_pointer function with the resize_window callback
94 void floating_resize_window(Con *con, const bool proportional, const xcb_button_press_event_t *event);
97 * Called when a floating window is created or resized.
98 * This function resizes the window if its size is higher or lower than the
99 * configured maximum/minimum size, respectively.
102 void floating_check_size(Con *floating_con);
105 * This is the return value of a drag operation like drag_pointer.
107 * DRAGGING will indicate the drag action is still in progress and can be
108 * continued or resolved.
110 * DRAG_SUCCESS will indicate the intention of the drag action should be
113 * DRAG_REVERT will indicate an attempt should be made to restore the state of
114 * the involved windows to their condition before the drag.
116 * DRAG_ABORT will indicate that the intention of the drag action cannot be
117 * carried out (e.g. because the window has been unmapped).
128 * This function grabs your pointer and keyboard and lets you drag stuff around
129 * (borders). Every time you move your mouse, an XCB_MOTION_NOTIFY event will
130 * be received and the given callback will be called with the parameters
131 * specified (client, border on which the click originally was), the original
132 * rect of the client, the event and the new coordinates (x, y).
135 drag_result_t drag_pointer(Con *con, const xcb_button_press_event_t *event,
136 xcb_window_t confine_to, border_t border, int cursor,
137 callback_t callback, const void *extra);
140 * Repositions the CT_FLOATING_CON to have the coordinates specified by
141 * newrect, but only if the coordinates are not out-of-bounds. Also reassigns
142 * the floating con to a different workspace if this move was across different
146 void floating_reposition(Con *con, Rect newrect);
149 * Sets size of the CT_FLOATING_CON to specified dimensions. Might limit the
150 * actual size with regard to size constraints taken from user settings.
151 * Additionally, the dimensions may be upscaled until they're divisible by the
152 * window's size hints.
155 void floating_resize(Con *floating_con, int x, int y);
158 * Fixes the coordinates of the floating window whenever the window gets
159 * reassigned to a different output (or when the output’s rect changes).
162 void floating_fix_coordinates(Con *con, Rect *old_rect, Rect *new_rect);