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
  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
  26 /* from X11/keysymdef.h */
  27 #define XCB_NUM_LOCK                    0xff7f
  28
  29 /* The event masks are defined here because we don’t only set them once but we
  30    need to set slight variations of them (without XCB_EVENT_MASK_ENTER_WINDOW
  31    while rendering the layout) */
  32 /** The XCB_CW_EVENT_MASK for the child (= real window) */
  33 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
  34                           XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
  35                           XCB_EVENT_MASK_ENTER_WINDOW)
  36
  37 /** The XCB_CW_EVENT_MASK for its frame */
  38 #define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS |          /* …mouse is pressed/released */ \
  39                           XCB_EVENT_MASK_BUTTON_RELEASE | \
  40                           XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */ \
  41                           XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */ \
  42                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
  43                           XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */ \
  44                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
  45
  46 #define xmacro(atom) xcb_atom_t A_ ## atom;
  47 #include "atoms.xmacro"
  48 #undef xmacro
  49
  50 extern unsigned int xcb_numlock_mask;
  51
  52 /**
  53  * Loads a font for usage, getting its height. This function is used very
  54  * often, so it maintains a cache.
  55  *
  56  */
  57 i3Font *load_font(xcb_connection_t *conn, const char *pattern);
  58
  59 /**
  60  * Returns the colorpixel to use for the given hex color (think of HTML).
  61  *
  62  * The hex_color has to start with #, for example #FF00FF.
  63  *
  64  * NOTE that get_colorpixel() does _NOT_ check the given color code for
  65  * validity.  This has to be done by the caller.
  66  *
  67  */
  68 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex);
  69
  70 /**
  71  * Convenience wrapper around xcb_create_window which takes care of depth,
  72  * generating an ID and checking for errors.
  73  *
  74  */
  75 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class,
  76                            int cursor, bool map, uint32_t mask, uint32_t *values);
  77
  78 /**
  79  * Changes a single value in the graphic context (so one doesn’t have to
  80  * define an array of values)
  81  *
  82  */
  83 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc,
  84                           uint32_t mask, uint32_t value);
  85
  86 /**
  87  * Draws a line from x,y to to_x,to_y using the given color
  88  *
  89  */
  90 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
  91                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  92                    uint32_t y, uint32_t to_x, uint32_t to_y);
  93
  94 /**
  95  * Draws a rectangle from x,y with width,height using the given color
  96  *
  97  */
  98 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
  99                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 100                    uint32_t y, uint32_t width, uint32_t height);
 101
 102 /**
 103  * Generates a configure_notify event and sends it to the given window
 104  * Applications need this to think they’ve configured themselves correctly.
 105  * The truth is, however, that we will manage them.
 106  *
 107  */
 108 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
 109
 110 /**
 111  * Generates a configure_notify_event with absolute coordinates (relative to
 112  * the X root window, not to the client’s frame) for the given client.
 113  *
 114  */
 115 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client);
 116
 117 /**
 118  * Finds out which modifier mask is the one for numlock, as the user may
 119  * change this.
 120  *
 121  */
 122 void xcb_get_numlock_mask(xcb_connection_t *conn);
 123
 124 /**
 125  * Raises the given window (typically client->frame) above all other windows
 126  *
 127  */
 128 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 129
 130 /**
 131  *
 132  * Prepares the given Cached_Pixmap for usage (checks whether the size of the
 133  * object this pixmap is related to (e.g. a window) has changed and re-creates
 134  * the pixmap if so).
 135  *
 136  */
 137 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap);
 138
 139 /**
 140  * Calculate the width of the given text (16-bit characters, UCS) with given
 141  * real length (amount of glyphs) using the given font.
 142  *
 143  */
 144 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text,
 145                        int length);
 146
 147 /**
 148  * Configures the given window to have the size/position specified by given rect
 149  *
 150  */
 151 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 152
 153 #endif