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
  47 enum { _NET_SUPPORTED = 0,
  48         _NET_SUPPORTING_WM_CHECK,
  49         _NET_WM_NAME,
  50         _NET_WM_STATE_FULLSCREEN,
  51         _NET_WM_STATE,
  52         _NET_WM_WINDOW_TYPE,
  53         _NET_WM_WINDOW_TYPE_DOCK,
  54         _NET_WM_WINDOW_TYPE_DIALOG,
  55         _NET_WM_WINDOW_TYPE_UTILITY,
  56         _NET_WM_WINDOW_TYPE_TOOLBAR,
  57         _NET_WM_WINDOW_TYPE_SPLASH,
  58         _NET_WM_DESKTOP,
  59         _NET_WM_STRUT_PARTIAL,
  60         WM_PROTOCOLS,
  61         WM_DELETE_WINDOW,
  62         UTF8_STRING,
  63         WM_STATE,
  64         WM_CLIENT_LEADER,
  65         _NET_CURRENT_DESKTOP,
  66         _NET_ACTIVE_WINDOW,
  67         _NET_WORKAREA,
  68         WM_TAKE_FOCUS
  69 };
  70
  71 extern unsigned int xcb_numlock_mask;
  72
  73 /**
  74  * Loads a font for usage, getting its height. This function is used very
  75  * often, so it maintains a cache.
  76  *
  77  */
  78 i3Font *load_font(xcb_connection_t *conn, const char *pattern);
  79
  80 /**
  81  * Returns the colorpixel to use for the given hex color (think of HTML).
  82  *
  83  * The hex_color has to start with #, for example #FF00FF.
  84  *
  85  * NOTE that get_colorpixel() does _NOT_ check the given color code for
  86  * validity.  This has to be done by the caller.
  87  *
  88  */
  89 uint32_t get_colorpixel(xcb_connection_t *conn, char *hex);
  90
  91 /**
  92  * Convenience wrapper around xcb_create_window which takes care of depth,
  93  * generating an ID and checking for errors.
  94  *
  95  */
  96 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class,
  97                            int cursor, bool map, uint32_t mask, uint32_t *values);
  98
  99 /**
 100  * Changes a single value in the graphic context (so one doesn’t have to
 101  * define an array of values)
 102  *
 103  */
 104 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc,
 105                           uint32_t mask, uint32_t value);
 106
 107 /**
 108  * Draws a line from x,y to to_x,to_y using the given color
 109  *
 110  */
 111 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
 112                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 113                    uint32_t y, uint32_t to_x, uint32_t to_y);
 114
 115 /**
 116  * Draws a rectangle from x,y with width,height using the given color
 117  *
 118  */
 119 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
 120                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 121                    uint32_t y, uint32_t width, uint32_t height);
 122
 123 /**
 124  * Generates a configure_notify event and sends it to the given window
 125  * Applications need this to think they’ve configured themselves correctly.
 126  * The truth is, however, that we will manage them.
 127  *
 128  */
 129 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
 130
 131 /**
 132  * Generates a configure_notify_event with absolute coordinates (relative to
 133  * the X root window, not to the client’s frame) for the given client.
 134  *
 135  */
 136 void fake_absolute_configure_notify(xcb_connection_t *conn, Client *client);
 137
 138 /**
 139  * Finds out which modifier mask is the one for numlock, as the user may
 140  * change this.
 141  *
 142  */
 143 void xcb_get_numlock_mask(xcb_connection_t *conn);
 144
 145 /**
 146  * Raises the given window (typically client->frame) above all other windows
 147  *
 148  */
 149 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 150
 151 /**
 152  *
 153  * Prepares the given Cached_Pixmap for usage (checks whether the size of the
 154  * object this pixmap is related to (e.g. a window) has changed and re-creates
 155  * the pixmap if so).
 156  *
 157  */
 158 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap);
 159
 160 /**
 161  * Calculate the width of the given text (16-bit characters, UCS) with given
 162  * real length (amount of glyphs) using the given font.
 163  *
 164  */
 165 int predict_text_width(xcb_connection_t *conn, const char *font_pattern, char *text,
 166                        int length);
 167
 168 /**
 169  * Configures the given window to have the size/position specified by given rect
 170  *
 171  */
 172 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 173
 174 #endif