]> git.sur5r.net Git - i3/i3/blob - include/layout.h
Put documentation for each function in the header files, doxygen-compatible
[i3/i3] / include / layout.h
1 /*
2  * vim:ts=8:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  *
6  * (c) 2009 Michael Stapelberg and contributors
7  *
8  * See file LICENSE for license information.
9  *
10  */
11 #include <xcb/xcb.h>
12
13 #ifndef _LAYOUT_H
14 #define _LAYOUT_H
15
16 /**
17  * (Re-)draws window decorations for a given Client onto the given drawable/graphic context.
18  * When in stacking mode, the window decorations are drawn onto an own window.
19  *
20  */
21 void decorate_window(xcb_connection_t *conn, Client *client, xcb_drawable_t drawable, xcb_gcontext_t gc, int offset);
22
23 /**
24  * Redecorates the given client correctly by checking if it’s in a stacking container and
25  * re-rendering the stack window or just calling decorate_window if it’s not in a stacking
26  * container.
27  *
28  */
29 void redecorate_window(xcb_connection_t *conn, Client *client);
30
31 /**
32  * Renders the given container. Is called by render_layout() or individually (for example
33  * when focus changes in a stacking container)
34  *
35  */
36 void render_container(xcb_connection_t *conn, Container *container);
37
38 /**
39  * Modifies the event mask of all clients on the given workspace to either ignore or to handle
40  * enter notifies. It is handy to ignore notifies because they will be sent when a window is mapped
41  * under the cursor, thus when the user didn’t enter the window actively at all.
42  *
43  */
44 void ignore_enter_notify_forall(xcb_connection_t *conn, Workspace *workspace, bool ignore_enter_notify);
45
46 /**
47  * Renders the whole layout, that is: Go through each screen, each workspace, each container
48  * and render each client. This also renders the bars.
49  *
50  * If you don’t need to render *everything*, you should call render_container on the container
51  * you want to refresh.
52  *
53  */
54 void render_layout(xcb_connection_t *conn);
55
56 #endif