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  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * xcb.c: Helper functions for easier usage of XCB
   8  *
   9  */
  10 #pragma once
  11
  12 #include "data.h"
  13 #include "xcursor.h"
  14
  15 #define _NET_WM_STATE_REMOVE 0
  16 #define _NET_WM_STATE_ADD 1
  17 #define _NET_WM_STATE_TOGGLE 2
  18
  19 /** This is the equivalent of XC_left_ptr. I’m not sure why xcb doesn’t have a
  20  * constant for that. */
  21 #define XCB_CURSOR_LEFT_PTR 68
  22 #define XCB_CURSOR_SB_H_DOUBLE_ARROW 108
  23 #define XCB_CURSOR_SB_V_DOUBLE_ARROW 116
  24 #define XCB_CURSOR_WATCH 150
  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_FOCUS_CHANGE)
  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 #define ROOT_EVENT_MASK (XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |                                       \
  48                          XCB_EVENT_MASK_BUTTON_PRESS |                                                \
  49                          XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* when the user adds a screen (e.g. video \
  50                                                                   projector), the root window gets a  \
  51                                                                   ConfigureNotify */                  \
  52                          XCB_EVENT_MASK_POINTER_MOTION |                                              \
  53                          XCB_EVENT_MASK_PROPERTY_CHANGE |                                             \
  54                          XCB_EVENT_MASK_ENTER_WINDOW)
  55
  56 #define xmacro(atom) xcb_atom_t A_##atom;
  57 #include "atoms.xmacro"
  58 #undef xmacro
  59
  60 extern unsigned int xcb_numlock_mask;
  61
  62 /**
  63  * Convenience wrapper around xcb_create_window which takes care of depth,
  64  * generating an ID and checking for errors.
  65  *
  66  */
  67 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
  68                            uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
  69
  70 /**
  71  * Draws a line from x,y to to_x,to_y using the given color
  72  *
  73  */
  74 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
  75                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  76                    uint32_t y, uint32_t to_x, uint32_t to_y);
  77
  78 /**
  79  * Draws a rectangle from x,y with width,height using the given color
  80  *
  81  */
  82 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
  83                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
  84                    uint32_t y, uint32_t width, uint32_t height);
  85
  86 /**
  87  * Generates a configure_notify_event with absolute coordinates (relative to
  88  * the X root window, not to the client’s frame) for the given client.
  89  *
  90  */
  91 void fake_absolute_configure_notify(Con *con);
  92
  93 /**
  94  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
  95  *
  96  */
  97 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
  98
  99 /**
 100  * Raises the given window (typically client->frame) above all other windows
 101  *
 102  */
 103 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
 104
 105 /**
 106  * Configures the given window to have the size/position specified by given rect
 107  *
 108  */
 109 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
 110
 111 /**
 112  * Returns the first supported _NET_WM_WINDOW_TYPE atom.
 113  *
 114  */
 115 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
 116
 117 /**
 118  * Returns true if the given reply contains the given data.
 119  *
 120  */
 121 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 122
 123 /**
 124  * Moves the mouse pointer into the middle of rect.
 125  *
 126  */
 127 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
 128
 129 /**
 130  * Set the cursor of the root window to the given cursor id.
 131  * This function should only be used if xcursor_supported == false.
 132  * Otherwise, use xcursor_set_root_cursor().
 133  *
 134  */
 135 void xcb_set_root_cursor(int cursor);
 136
 137 /**
 138  * Get depth of visual specified by visualid
 139  *
 140  */
 141 uint16_t get_visual_depth(xcb_visualid_t visual_id);
 142
 143 /**
 144  * Get visualid with specified depth
 145  *
 146  */
 147 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
 148
 149 /**
 150  * Add an atom to a list of atoms the given property defines.
 151  * This is useful, for example, for manipulating _NET_WM_STATE.
 152  *
 153  */
 154 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
 155
 156 /**
 157  * Remove an atom from a list of atoms the given property defines without
 158  * removing any other potentially set atoms.  This is useful, for example, for
 159  * manipulating _NET_WM_STATE.
 160  *
 161  */
 162 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
 163
 164 /**
 165  * Grab the specified buttons on a window when managing it.
 166  *
 167  */
 168 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, bool bind_scrollwheel);