]> git.sur5r.net Git - i3/i3/blob - include/xinerama.h
Put documentation for each function in the header files, doxygen-compatible
[i3/i3] / include / xinerama.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 "data.h"
12
13 #ifndef _XINERAMA_H
14 #define _XINERAMA_H
15
16 TAILQ_HEAD(screens_head, Screen);
17 extern struct screens_head *virtual_screens;
18
19 /**
20  * We have just established a connection to the X server and need the initial Xinerama
21  * information to setup workspaces for each screen.
22  *
23  */
24 void initialize_xinerama(xcb_connection_t *conn);
25
26 /**
27  * This is called when the rootwindow receives a configure_notify event and therefore the
28  * number/position of the Xinerama screens could have changed.
29  *
30  */
31 void xinerama_requery_screens(xcb_connection_t *conn);
32
33 /**
34  * Looks in virtual_screens for the i3Screen whose start coordinates are x, y
35  *
36  */
37 i3Screen *get_screen_at(int x, int y, struct screens_head *screenlist);
38
39 /**
40  * Looks in virtual_screens for the i3Screen which contains coordinates x, y
41  *
42  */
43 i3Screen *get_screen_containing(int x, int y);
44
45 /**
46  * Gets the screen which is the last one in the given direction, for example the screen
47  * on the most bottom when direction == D_DOWN, the screen most right when direction == D_RIGHT
48  * and so on.
49  *
50  * This function always returns a screen.
51  *
52  */
53 i3Screen *get_screen_most(direction_t direction);
54
55 #endif