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