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