]> git.sur5r.net Git - i3/i3/blob - include/xcb.h
Ensure all *.[ch] files include config.h
[i3/i3] / 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_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
64 /**
65  * Convenience wrapper around xcb_create_window which takes care of depth,
66  * generating an ID and checking for errors.
67  *
68  */
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
72 /**
73  * Draws a line from x,y to to_x,to_y using the given color
74  *
75  */
76 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
77                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
78                    uint32_t y, uint32_t to_x, uint32_t to_y);
79
80 /**
81  * Draws a rectangle from x,y with width,height using the given color
82  *
83  */
84 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
85                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
86                    uint32_t y, uint32_t width, uint32_t height);
87
88 /**
89  * Generates a configure_notify_event with absolute coordinates (relative to
90  * the X root window, not to the client’s frame) for the given client.
91  *
92  */
93 void fake_absolute_configure_notify(Con *con);
94
95 /**
96  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
97  *
98  */
99 void send_take_focus(xcb_window_t window, xcb_timestamp_t timestamp);
100
101 /**
102  * Raises the given window (typically client->frame) above all other windows
103  *
104  */
105 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
106
107 /**
108  * Configures the given window to have the size/position specified by given rect
109  *
110  */
111 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
112
113 /**
114  * Returns the first supported _NET_WM_WINDOW_TYPE atom.
115  *
116  */
117 xcb_atom_t xcb_get_preferred_window_type(xcb_get_property_reply_t *reply);
118
119 /**
120  * Returns true if the given reply contains the given data.
121  *
122  */
123 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
124
125 /**
126  * Moves the mouse pointer into the middle of rect.
127  *
128  */
129 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
130
131 /**
132  * Set the cursor of the root window to the given cursor id.
133  * This function should only be used if xcursor_supported == false.
134  * Otherwise, use xcursor_set_root_cursor().
135  *
136  */
137 void xcb_set_root_cursor(int cursor);
138
139 /**
140  * Get depth of visual specified by visualid
141  *
142  */
143 uint16_t get_visual_depth(xcb_visualid_t visual_id);
144
145 /**
146  * Get visual type specified by visualid
147  *
148  */
149 xcb_visualtype_t *get_visualtype_by_id(xcb_visualid_t visual_id);
150
151 /**
152  * Get visualid with specified depth
153  *
154  */
155 xcb_visualid_t get_visualid_by_depth(uint16_t depth);
156
157 /**
158  * Add an atom to a list of atoms the given property defines.
159  * This is useful, for example, for manipulating _NET_WM_STATE.
160  *
161  */
162 void xcb_add_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
163
164 /**
165  * Remove an atom from a list of atoms the given property defines without
166  * removing any other potentially set atoms.  This is useful, for example, for
167  * manipulating _NET_WM_STATE.
168  *
169  */
170 void xcb_remove_property_atom(xcb_connection_t *conn, xcb_window_t window, xcb_atom_t property, xcb_atom_t atom);
171
172 /**
173  * Grab the specified buttons on a window when managing it.
174  *
175  */
176 void xcb_grab_buttons(xcb_connection_t *conn, xcb_window_t window, int *buttons);