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  * © 2009-2011 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_FOCUS_CHANGE)
  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 #define xmacro(atom) xcb_atom_t A_ ## atom;
  49 #include "atoms.xmacro"
  50 #undef xmacro
  51
  52 extern unsigned int xcb_numlock_mask;
  53
  54 /**
  55  * Loads a font for usage, also getting its height. If fallback is true,
  56  * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
  57  * exiting.
  58  *
  59  */
  60 i3Font load_font(const char *pattern, bool fallback);
  61
  62 /**
  63  * Returns the colorpixel to use for the given hex color (think of HTML).
  64  *
  65  * The hex_color has to start with #, for example #FF00FF.
  66  *
  67  * NOTE that get_colorpixel() does _NOT_ check the given color code for
  68  * validity.  This has to be done by the caller.
  69  *
  70  */
  71 uint32_t get_colorpixel(char *hex);
  72
  73 /**
  74  * Convenience wrapper around xcb_create_window which takes care of depth,
  75  * generating an ID and checking for errors.
  76  *
  77  */
  78 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class,
  79         enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
  80
  81 /**
  82  * Changes a single value in the graphic context (so one doesn’t have to
  83  * define an array of values)
  84  *
  85  */
  86 void xcb_change_gc_single(xcb_connection_t *conn, xcb_gcontext_t gc,
  87                           uint32_t mask, uint32_t value);
  88
  89 /**
  90  * Draws a line from x,y to to_x,to_y using the given color
  91  *
  92  */
  93 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
  94                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  95                    uint32_t y, uint32_t to_x, uint32_t to_y);
  96
  97 /**
  98  * Draws a rectangle from x,y with width,height using the given color
  99  *
 100  */
 101 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
 102                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
 103                    uint32_t y, uint32_t width, uint32_t height);
 104
 105 /**
 106  * Generates a configure_notify event and sends it to the given window
 107  * Applications need this to think they’ve configured themselves correctly.
 108  * The truth is, however, that we will manage them.
 109  *
 110  */
 111 void fake_configure_notify(xcb_connection_t *conn, Rect r, xcb_window_t window);
 112
 113 /**
 114  * Generates a configure_notify_event with absolute coordinates (relative to
 115  * the X root window, not to the client’s frame) for the given client.
 116  *
 117  */
 118 void fake_absolute_configure_notify(Con *con);
 119
 120 /**
 121  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
 122  *
 123  */
 124 void send_take_focus(xcb_window_t window);
 125
 126 /**
 127  * Finds out which modifier mask is the one for numlock, as the user may
 128  * change this.
 129  *
 130  */
 131 void xcb_get_numlock_mask(xcb_connection_t *conn);
 132
 133 /**
 134  * Raises the given window (typically client->frame) above all other windows
 135  *
 136  */
 137 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 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(char *text, int length);
 145
 146 /**
 147  * Configures the given window to have the size/position specified by given rect
 148  *
 149  */
 150 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 151
 152
 153 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 154
 155 #endif