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 <config.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 #define XCB_CURSOR_WATCH 150
  27
  28 /* from X11/keysymdef.h */
  29 #define XCB_NUM_LOCK 0xff7f
  30
  31 /* The event masks are defined here because we don’t only set them once but we
  32    need to set slight variations of them (without XCB_EVENT_MASK_ENTER_WINDOW
  33    while rendering the layout) */
  34 /** The XCB_CW_EVENT_MASK for the child (= real window) */
  35 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE |  \
  36                           XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
  37                           XCB_EVENT_MASK_FOCUS_CHANGE)
  38
  39 /** The XCB_CW_EVENT_MASK for its frame */
  40 #define FRAME_EVENT_MASK (XCB_EVENT_MASK_BUTTON_PRESS | /* …mouse is pressed/released */                       \
  41                           XCB_EVENT_MASK_BUTTON_RELEASE |                                                        \
  42                           XCB_EVENT_MASK_POINTER_MOTION |        /* …mouse is moved */                         \
  43                           XCB_EVENT_MASK_EXPOSURE |              /* …our window needs to be redrawn */         \
  44                           XCB_EVENT_MASK_STRUCTURE_NOTIFY |      /* …the frame gets destroyed */               \
  45                           XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT | /* …the application tries to resize itself */ \
  46                           XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |   /* …subwindows get notifies */                \
  47                           XCB_EVENT_MASK_ENTER_WINDOW)           /* …user moves cursor inside our window */
  48
  49 #define ROOT_EVENT_MASK (XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |                                       \
  50                          XCB_EVENT_MASK_BUTTON_PRESS |                                                \
  51                          XCB_EVENT_MASK_STRUCTURE_NOTIFY | /* when the user adds a screen (e.g. video \
  52                                                                   projector), the root window gets a  \
  53                                                                   ConfigureNotify */                  \
  54                          XCB_EVENT_MASK_POINTER_MOTION |                                              \
  55                          XCB_EVENT_MASK_PROPERTY_CHANGE |                                             \
  56                          XCB_EVENT_MASK_FOCUS_CHANGE |                                                \
  57                          XCB_EVENT_MASK_ENTER_WINDOW)
  58
  59 #define xmacro(atom) xcb_atom_t A_##atom;
  60 #include "atoms.xmacro"
  61 #undef xmacro
  62
  63 extern unsigned int xcb_numlock_mask;
  64
  65 /**
  66  * Convenience wrapper around xcb_create_window which takes care of depth,
  67  * generating an ID and checking for errors.
  68  *
  69  */
  70 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
  71                            uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
  72
  73 /**
  74  * Generates a configure_notify_event with absolute coordinates (relative to
  75  * the X root window, not to the client’s frame) for the given client.
  76  *
  77  */
  78 void fake_absolute_configure_notify(Con *con);
  79
  80 /**
  81  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
  82  *
  83  */
  84 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
  85
  86 /**
  87  * Configures the given window to have the size/position specified by given rect
  88  *
  89  */
  90 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
  91
  92 /**
  93  * Returns the first supported _NET_WM_WINDOW_TYPE atom.
  94  *
  95  */
  96 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
  97
  98 /**
  99  * Returns true if the given reply contains the given data.
 100  *
 101  */
 102 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
 103
 104 /**
 105  * Set the cursor of the root window to the given cursor id.
 106  * This function should only be used if xcursor_supported == false.
 107  * Otherwise, use xcursor_set_root_cursor().
 108  *
 109  */
 110 void xcb_set_root_cursor(int cursor);
 111
 112 /**
 113  * Get depth of visual specified by visualid
 114  *
 115  */
 116 uint16_t get_visual_depth(xcb_visualid_t visual_id);
 117
 118 /**
 119  * Get visual type specified by visualid
 120  *
 121  */
 122 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id);
 123
 124 /**
 125  * Get visualid with specified depth
 126  *
 127  */
 128 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
 129
 130 /**
 131  * Add an atom to a list of atoms the given property defines.
 132  * This is useful, for example, for manipulating _NET_WM_STATE.
 133  *
 134  */
 135 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
 136
 137 /**
 138  * Remove an atom from a list of atoms the given property defines without
 139  * removing any other potentially set atoms.  This is useful, for example, for
 140  * manipulating _NET_WM_STATE.
 141  *
 142  */
 143 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
 144
 145 /**
 146  * Grab the specified buttons on a window when managing it.
 147  *
 148  */
 149 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons);