]> git.sur5r.net Git - i3/i3/blob - include/xcb.h
9660939dfb48bd9bffd7e58f8aaf7f906fa861a1
[i3/i3] / 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 #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 xmacro(atom) xcb_atom_t A_ ## atom;
50 #include "atoms.xmacro"
51 #undef xmacro
52
53 extern unsigned int xcb_numlock_mask;
54
55 /**
56  * Loads a font for usage, also getting its height. If fallback is true,
57  * i3 loads 'fixed' or '-misc-*' if the font cannot be found instead of
58  * exiting.
59  *
60  */
61 i3Font load_font(const char *pattern, bool fallback);
62
63 /**
64  * Convenience wrapper around xcb_create_window which takes care of depth,
65  * generating an ID and checking for errors.
66  *
67  */
68 xcb_window_t create_window(xcb_connection_t *conn, Rect r, uint16_t window_class,
69         enum xcursor_cursor_t cursor, bool map, uint32_t mask, uint32_t *values);
70
71 /**
72  * Draws a line from x,y to to_x,to_y using the given color
73  *
74  */
75 void xcb_draw_line(xcb_connection_t *conn, xcb_drawable_t drawable,
76                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
77                    uint32_t y, uint32_t to_x, uint32_t to_y);
78
79 /**
80  * Draws a rectangle from x,y with width,height using the given color
81  *
82  */
83 void xcb_draw_rect(xcb_connection_t *conn, xcb_drawable_t drawable,
84                    xcb_gcontext_t gc, uint32_t colorpixel, uint32_t x,
85                    uint32_t y, uint32_t width, uint32_t height);
86
87 /**
88  * Generates a configure_notify_event with absolute coordinates (relative to
89  * the X root window, not to the client’s frame) for the given client.
90  *
91  */
92 void fake_absolute_configure_notify(Con *con);
93
94 /**
95  * Sends the WM_TAKE_FOCUS ClientMessage to the given window
96  *
97  */
98 void send_take_focus(xcb_window_t window);
99
100 /**
101  * Finds out which modifier mask is the one for numlock, as the user may
102  * change this.
103  *
104  */
105 void xcb_get_numlock_mask(xcb_connection_t *conn);
106
107 /**
108  * Raises the given window (typically client->frame) above all other windows
109  *
110  */
111 void xcb_raise_window(xcb_connection_t *conn, xcb_window_t window);
112
113 /**
114  * Calculate the width of the given text (16-bit characters, UCS) with given
115  * real length (amount of glyphs) using the given font.
116  *
117  */
118 int predict_text_width(char *text, int length);
119
120 /**
121  * Configures the given window to have the size/position specified by given rect
122  *
123  */
124 void xcb_set_window_rect(xcb_connection_t *conn, xcb_window_t window, Rect r);
125
126
127 bool xcb_reply_contains_atom(xcb_get_property_reply_t *prop, xcb_atom_t atom);
128
129 /**
130  * Moves the mouse pointer into the middle of rect.
131  *
132  */
133 void xcb_warp_pointer_rect(xcb_connection_t *conn, Rect *rect);
134
135 /**
136  * Set the cursor of the root window to the given cursor id.
137  * This function should only be used if xcursor_supported == false.
138  * Otherwise, use xcursor_set_root_cursor().
139  *
140  */
141 void xcb_set_root_cursor(int cursor);
142
143 #endif