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  *
   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
  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_POINTER_MOTION |        /* …mouse is moved */ \
  41                           XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */ \
  42                           XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */ \
  43                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
  44                           XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */ \
  45                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
  46
  47
  48 enum {
  49     _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     NUM_ATOMS
  71 };
  72
  73 extern unsigned int xcb_numlock_mask;
  74
  75 /**
  76  * Loads a font for usage, also getting its height. If fallback is true,
  77  * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
  78  * exiting.
  79  *
  80  */
  81 i3Font load_font(const char *pattern, bool fallback);
  82
  83 /**
  84  * Returns the colorpixel to use for the given hex color (think of HTML).
  85  *
  86  * The hex_color has to start with #, for example #FF00FF.
  87  *
  88  * NOTE that get_colorpixel() does _NOT_ check the given color code for
  89  * validity.  This has to be done by the caller.
  90  *
  91  */
  92 uint32_t get_colorpixel(char *hex);
  93
  94 /**
  95  * Convenience wrapper around xcb_create_window which takes care of depth,
  96  * generating an ID and checking for errors.
  97  *
  98  */
  99 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class,
 100         enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
 101
 102 /**
 103  * Changes a single value in the graphic context (so one doesn’t have to
 104  * define an array of values)
 105  *
 106  */
 107 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc,
 108                           uint32_t mask, uint32_t value);
 109
 110 /**
 111  * Draws a line from x,y to to_x,to_y using the given color
 112  *
 113  */
 114 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
 115                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 116                    uint32_t y, uint32_t to_x, uint32_t to_y);
 117
 118 /**
 119  * Draws a rectangle from x,y with width,height using the given color
 120  *
 121  */
 122 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
 123                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 124                    uint32_t y, uint32_t width, uint32_t height);
 125
 126 /**
 127  * Generates a configure_notify event and sends it to the given window
 128  * Applications need this to think they’ve configured themselves correctly.
 129  * The truth is, however, that we will manage them.
 130  *
 131  */
 132 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
 133
 134 /**
 135  * Generates a configure_notify_event with absolute coordinates (relative to
 136  * the X root window, not to the client’s frame) for the given client.
 137  *
 138  */
 139 void fake_absolute_configure_notify(Con *con);
 140
 141 /**
 142  * Finds out which modifier mask is the one for numlock, as the user may
 143  * change this.
 144  *
 145  */
 146 void xcb_get_numlock_mask(xcb_connection_t *conn);
 147
 148 /**
 149  * Raises the given window (typically client->frame) above all other windows
 150  *
 151  */
 152 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 153
 154 /**
 155  *
 156  * Prepares the given Cached_Pixmap for usage (checks whether the size of the
 157  * object this pixmap is related to (e.g. a window) has changed and re-creates
 158  * the pixmap if so).
 159  *
 160  */
 161 void cached_pixmap_prepare(xcb_connection_t *conn, struct Cached_Pixmap *pixmap);
 162
 163 /**
 164  * Calculate the width of the given text (16-bit characters, UCS) with given
 165  * real length (amount of glyphs) using the given font.
 166  *
 167  */
 168 int predict_text_width(char *text, int length);
 169
 170 /**
 171  * Configures the given window to have the size/position specified by given rect
 172  *
 173  */
 174 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 175
 176
 177 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 178
 179 #endif