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

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #ifndef _FLOATING_H
  12 #define _FLOATING_H
  13
  14 /** Callback for dragging */
  15 typedef void(*callback_t)(xcb_connection_t*, Client*, Rect*, uint32_t, uint32_t, void*);
  16
  17 /** Macro to create a callback function for dragging */
  18 #define DRAGGING_CB(name) \
  19         static void name(xcb_connection_t *conn, Client *client, \
  20                          Rect *old_rect, uint32_t new_x, uint32_t new_y, \
  21                          void *extra)
  22
  23 /** On which border was the dragging initiated? */
  24 typedef enum { BORDER_LEFT, BORDER_RIGHT, BORDER_TOP, BORDER_BOTTOM} border_t;
  25
  26 /**
  27  * Enters floating mode for the given client.  Correctly takes care of the
  28  * position/size (separately stored for tiling/floating mode) and
  29  * repositions/resizes/redecorates the client.
  30  *
  31  * If the automatic flag is set to true, this was an automatic update by a
  32  * change of the window class from the application which can be overwritten by
  33  * the user.
  34  *
  35  */
  36 void toggle_floating_mode(xcb_connection_t *conn, Client *client,
  37                           bool automatic);
  38
  39 /**
  40  * Removes the floating client from its workspace and attaches it to the new
  41  * workspace. This is centralized here because it may happen if you move it
  42  * via keyboard and if you move it using your mouse.
  43  *
  44  */
  45 void floating_assign_to_workspace(Client *client, Workspace *new_workspace);
  46
  47 /**
  48  * Called whenever the user clicks on a border (not the titlebar!) of a
  49  * floating window. Determines on which border the user clicked and launches
  50  * the drag_pointer function with the resize_callback.
  51  *
  52  */
  53 int floating_border_click(xcb_connection_t *conn, Client *client,
  54                           xcb_button_press_event_t *event);
  55
  56 /**
  57  * Called when the user clicked on the titlebar of a floating window.
  58  * Calls the drag_pointer function with the drag_window callback
  59  *
  60  */
  61 void floating_drag_window(xcb_connection_t *conn, Client *client,
  62                           xcb_button_press_event_t *event);
  63
  64 /**
  65  * Called when the user clicked on a floating window while holding the
  66  * floating_modifier and the right mouse button.
  67  * Calls the drag_pointer function with the resize_window callback
  68  *
  69  */
  70 void floating_resize_window(xcb_connection_t *conn, Client *client,
  71                             xcb_button_press_event_t *event);
  72
  73 /**
  74  * Changes focus in the given direction for floating clients.
  75  *
  76  * Changing to the left/right means going to the previous/next floating client,
  77  * changing to top/bottom means cycling through the Z-index.
  78  *
  79  */
  80 void floating_focus_direction(xcb_connection_t *conn, Client *currently_focused,
  81                               direction_t direction);
  82
  83 /**
  84  * Moves the client 10px to the specified direction.
  85  *
  86  */
  87 void floating_move(xcb_connection_t *conn, Client *currently_focused,
  88                    direction_t direction);
  89
  90 /**
  91  * Hides all floating clients (or show them if they are currently hidden) on
  92  * the specified workspace.
  93  *
  94  */
  95 void floating_toggle_hide(xcb_connection_t *conn, Workspace *workspace);
  96
  97 /**
  98  * This function grabs your pointer and lets you drag stuff around (borders).
  99  * Every time you move your mouse, an XCB_MOTION_NOTIFY event will be received
 100  * and the given callback will be called with the parameters specified (client,
 101  * border on which the click originally was), the original rect of the client,
 102  * the event and the new coordinates (x, y).
 103  *
 104  */
 105 void drag_pointer(xcb_connection_t *conn, Client *client, xcb_button_press_event_t *event,
 106                   xcb_window_t confine_to, border_t border, callback_t callback,
 107                   void *extra);
 108
 109 #endif