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

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2012 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * xcb.c: Helper functions for easier usage of XCB
   8  *
   9  */
  10 #ifndef I3_XCB_H
  11 #define I3_XCB_H
  12
  13 #include "data.h"
  14 #include "xcursor.h"
  15
  16 #define _NET_WM_STATE_REMOVE    0
  17 #define _NET_WM_STATE_ADD       1
  18 #define _NET_WM_STATE_TOGGLE    2
  19
  20 /** This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a
  21  * constant for that. */
  22 #define XCB_CURSOR_LEFT_PTR     68
  23 #define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
  24 #define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
  25 #define XCB_CURSOR_WATCH 150
  26
  27 /* from X11/keysymdef.h */
  28 #define XCB_NUM_LOCK                    0xff7f
  29
  30 /* The event masks are defined here because we don’t only set them once but we
  31    need to set slight variations of them (without XCB_EVENT_MASK_ENTER_WINDOW
  32    while rendering the layout) */
  33 /** The XCB_CW_EVENT_MASK for the child (= real window) */
  34 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
  35                           XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
  36                           XCB_EVENT_MASK_FOCUS_CHANGE)
  37
  38 /** The XCB_CW_EVENT_MASK for its frame */
  39 #define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS |          /* …mouse is pressed/released */ \
  40                           XCB_EVENT_MASK_BUTTON_RELEASE | \
  41                           XCB_EVENT_MASK_POINTER_MOTION |        /* …mouse is moved */ \
  42                           XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */ \
  43                           XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */ \
  44                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
  45                           XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */ \
  46                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
  47
  48 #define ROOT_EVENT_MASK   (XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | \
  49                            XCB_EVENT_MASK_BUTTON_PRESS | \
  50                            XCB_EVENT_MASK_STRUCTURE_NOTIFY |         /* when the user adds a screen (e.g. video \
  51                                                                             projector), the root window gets a \
  52                                                                             ConfigureNotify */ \
  53                            XCB_EVENT_MASK_POINTER_MOTION | \
  54                            XCB_EVENT_MASK_PROPERTY_CHANGE | \
  55                            XCB_EVENT_MASK_ENTER_WINDOW)
  56
  57 #define xmacro(atom) xcb_atom_t A_ ## atom;
  58 #include "atoms.xmacro"
  59 #undef xmacro
  60
  61 extern unsigned int xcb_numlock_mask;
  62
  63 /**
  64  * Convenience wrapper around xcb_create_window which takes care of depth,
  65  * generating an ID and checking for errors.
  66  *
  67  */
  68 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
  69         uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
  70
  71 /**
  72  * Draws a line from x,y to to_x,to_y using the given color
  73  *
  74  */
  75 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
  76                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  77                    uint32_t y, uint32_t to_x, uint32_t to_y);
  78
  79 /**
  80  * Draws a rectangle from x,y with width,height using the given color
  81  *
  82  */
  83 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
  84                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  85                    uint32_t y, uint32_t width, uint32_t height);
  86
  87 /**
  88  * Generates a configure_notify_event with absolute coordinates (relative to
  89  * the X root window, not to the client’s frame) for the given client.
  90  *
  91  */
  92 void fake_absolute_configure_notify(Con *con);
  93
  94 /**
  95  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
  96  *
  97  */
  98 void send_take_focus(xcb_window_t window);
  99
 100 /**
 101  * Raises the given window (typically client->frame) above all other windows
 102  *
 103  */
 104 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 105
 106 /**
 107  * Configures the given window to have the size/position specified by given rect
 108  *
 109  */
 110 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 111
 112
 113 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 114
 115 /**
 116  * Moves the mouse pointer into the middle of rect.
 117  *
 118  */
 119 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
 120
 121 /**
 122  * Set the cursor of the root window to the given cursor id.
 123  * This function should only be used if xcursor_supported == false.
 124  * Otherwise, use xcursor_set_root_cursor().
 125  *
 126  */
 127 void xcb_set_root_cursor(int cursor);
 128
 129 /**
 130  * Get depth of visual specified by visualid
 131  *
 132  */
 133 uint16_t get_visual_depth(xcb_visualid_t visual_id);
 134
 135 /**
 136  * Get visualid with specified depth
 137  *
 138  */
 139 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
 140
 141 #endif