i3
xcb.h
Go to the documentation of this file.
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 
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) */
35 #define CHILD_EVENT_MASK (XCB_EVENT_MASK_PROPERTY_CHANGE | \
36  XCB_EVENT_MASK_STRUCTURE_NOTIFY | \
37  XCB_EVENT_MASK_FOCUS_CHANGE)
38 
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_ENTER_WINDOW)
57 
58 #define xmacro(atom) xcb_atom_t A_##atom;
59 #include "atoms.xmacro"
60 #undef xmacro
61 
62 extern unsigned int xcb_numlock_mask;
63 
69 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual,
70  uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
71 
78 
83 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
84 
89 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
90 
95 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
96 
101 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
102 
109 void xcb_set_root_cursor(int cursor);
110 
115 uint16_t get_visual_depth(xcb_visualid_t visual_id);
116 
121 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id);
122 
127 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
128 
134 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
135 
142 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
143 
148 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons);
void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons)
Grab the specified buttons on a window when managing it.
Definition: xcb.c:309
bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom)
Returns true if the given reply contains the given data.
Definition: xcb.c:163
xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t depth, xcb_visualid_t visual, uint16_t window_class, enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values)
Convenience wrapper around xcb_create_window which takes care of depth, generating an ID and checking...
Definition: xcb.c:19
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:591
xcb_connection_t * conn
XCB connection and root screen.
Definition: main.c:46
void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp)
Sends the WM_TAKE_FOCUS ClientMessage to the given window.
Definition: xcb.c:94
void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Remove an atom from a list of atoms the given property defines without removing any other potentially...
Definition: xcb.c:275
xcb_visualid_t visual_id
void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r)
Configures the given window to have the size/position specified by given rect.
Definition: xcb.c:117
xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply)
Returns the first supported _NET_WM_WINDOW_TYPE atom.
Definition: xcb.c:133
uint16_t get_visual_depth(xcb_visualid_t visual_id)
Get depth of visual specified by visualid.
Definition: xcb.c:200
xcb_visualid_t get_visualid_by_depth(uint16_t depth)
Get visualid with specified depth.
Definition: xcb.c:242
unsigned int xcb_numlock_mask
Definition: xcb.c:12
void xcb_set_root_cursor(int cursor)
Set the cursor of the root window to the given cursor id.
Definition: xcb.c:184
xcb_visualtype_t * get_visualtype_by_id(xcb_visualid_t visual_id)
Get visual type specified by visualid.
Definition: xcb.c:221
void fake_absolute_configure_notify(Con *con)
Generates a configure_notify_event with absolute coordinates (relative to the X root window...
Definition: xcb.c:75
xcursor_cursor_t
Definition: xcursor.h:16
void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom)
Add an atom to a list of atoms the given property defines.
Definition: xcb.c:265
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:148