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

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * (c) 2009 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  */
  11 #ifndef _XCB_H
  12 #define _XCB_H
  13
  14 #include "data.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 constant for that. */
  21 #define XCB_CURSOR_LEFT_PTR     68
  22 #define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
  23 #define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
  24
  25 /* from X11/keysymdef.h */
  26 #define XCB_NUM_LOCK                    0xff7f
  27
  28 /* The event masks are defined here because we don’t only set them once but we need to set slight
  29    variations of them (without XCB_EVENT_MASK_ENTER_WINDOW while rendering the layout) */
  30 /* The XCB_CW_EVENT_MASK for the child (= real window) */
  31 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
  32                           XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
  33                           XCB_EVENT_MASK_ENTER_WINDOW)
  34
  35 /* The XCB_CW_EVENT_MASK for its frame */
  36 #define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS |          /* …mouse is pressed/released */ \
  37                           XCB_EVENT_MASK_BUTTON_RELEASE | \
  38                           XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */ \
  39                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
  40                           XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */ \
  41                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
  42
  43
  44 enum { _NET_SUPPORTED = 0,
  45         _NET_SUPPORTING_WM_CHECK,
  46         _NET_WM_NAME,
  47         _NET_WM_STATE_FULLSCREEN,
  48         _NET_WM_STATE,
  49         _NET_WM_WINDOW_TYPE,
  50         _NET_WM_WINDOW_TYPE_DOCK,
  51         _NET_WM_DESKTOP,
  52         _NET_WM_STRUT_PARTIAL,
  53         WM_PROTOCOLS,
  54         WM_DELETE_WINDOW,
  55         UTF8_STRING,
  56         WM_STATE
  57 };
  58
  59 extern unsigned int xcb_numlock_mask;
  60
  61 /**
  62  * Loads a font for usage, getting its height. This function is used very often, so it
  63  * maintains a cache.
  64  *
  65  */
  66 i3Font *load_font(xcb_connection_t *conn, const char *pattern);
  67
  68 /**
  69  * Returns the colorpixel to use for the given hex color (think of HTML).
  70  *
  71  * The hex_color has to start with #, for example #FF00FF.
  72  *
  73  * NOTE that get_colorpixel() does _NOT_ check the given color code for validity.
  74  * This has to be done by the caller.
  75  *
  76  */
  77 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex);
  78
  79 /**
  80  * Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking
  81  * for errors.
  82  *
  83  */
  84 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class, int cursor,
  85                            uint32_t mask, uint32_t *values);
  86
  87 /**
  88  * Changes a single value in the graphic context (so one doesn’t have to define an array of values)
  89  *
  90  */
  91 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc, uint32_t mask, uint32_t value);
  92
  93 /**
  94  * Draws a line from x,y to to_x,to_y using the given color
  95  *
  96  */
  97 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
  98                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t to_x, uint32_t to_y);
  99
 100 /**
 101  * Draws a rectangle from x,y with width,height using the given color
 102  *
 103  */
 104 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable, xcb_gcontext_t gc,
 105                    uint32_t colorpixel, uint32_t x, uint32_t y, uint32_t width, uint32_t height);
 106
 107 /**
 108  * Generates a configure_notify event and sends it to the given window
 109  * Applications need this to think they’ve configured themselves correctly.
 110  * The truth is, however, that we will manage them.
 111  *
 112  */
 113 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
 114
 115 /**
 116  * Generates a configure_notify_event with absolute coordinates (relative to the X root
 117  * window, not to the client’s frame) for the given client.
 118  *
 119  */
 120 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client);
 121
 122 /**
 123  * Finds out which modifier mask is the one for numlock, as the user may change this.
 124  *
 125  */
 126 void xcb_get_numlock_mask(xcb_connection_t *conn);
 127
 128 #endif