]> git.sur5r.net Git - i3/i3/blob - include/con.h
Implement resizing (still buggy)
[i3/i3] / include / con.h
1 #ifndef _CON_H
2 #define _CON_H
3
4 /**
5  * Create a new container (and attach it to the given parent, if not NULL).
6  * This function initializes the data structures and creates the appropriate
7  * X11 IDs using x_con_init().
8  *
9  */
10 Con *con_new(Con *parent);
11
12 /**
13  * Sets input focus to the given container. Will be updated in X11 in the next
14  * run of x_push_changes().
15  *
16  */
17 void con_focus(Con *con);
18
19 /**
20  * Returns true when this node is a leaf node (has no children)
21  *
22  */
23 bool con_is_leaf(Con *con);
24
25 /**
26  * Returns true if this node accepts a window (if the node swallows windows,
27  * it might already have swallowed enough and cannot hold any more).
28  *
29  */
30 bool con_accepts_window(Con *con);
31
32 /**
33  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
34  * node is on.
35  *
36  */
37 Con *con_get_output(Con *con);
38
39 /**
40  * Gets the workspace container this node is on.
41  *
42  */
43 Con *con_get_workspace(Con *con);
44
45 /**
46  * Returns the first fullscreen node below this node.
47  *
48  */
49 Con *con_get_fullscreen_con(Con *con);
50
51 /**
52  * Returns true if the node is floating.
53  *
54  */
55 bool con_is_floating(Con *con);
56
57 /**
58  * Returns the container with the given client window ID or NULL if no such
59  * container exists.
60  *
61  */
62 Con *con_by_window_id(xcb_window_t window);
63
64 /**
65  * Returns the container with the given frame ID or NULL if no such container
66  * exists.
67  *
68  */
69 Con *con_by_frame_id(xcb_window_t frame);
70
71 /**
72  * Returns the first container which wants to swallow this window
73  * TODO: priority
74  *
75  */
76 Con *con_for_window(i3Window *window, Match **store_match);
77
78 /**
79  * Returns the number of children of this container.
80  *
81  */
82 int con_num_children(Con *con);
83
84 /**
85  * Attaches the given container to the given parent. This happens when moving
86  * a container or when inserting a new container at a specific place in the
87  * tree.
88  *
89  * ignore_focus is to just insert the Con at the end (useful when creating a
90  * new split container *around* some containers, that is, detaching and
91  * attaching them in order without wanting to mess with the focus in between).
92  *
93  */
94 void con_attach(Con *con, Con *parent, bool ignore_focus);
95
96 /**
97  * Detaches the given container from its current parent
98  *
99  */
100 void con_detach(Con *con);
101
102 /**
103  * Updates the percent attribute of the children of the given container. This
104  * function needs to be called when a window is added or removed from a
105  * container.
106  *
107  */
108 void con_fix_percent(Con *con, int action);
109 enum { WINDOW_ADD = 0, WINDOW_REMOVE = 1 };
110
111 /**
112  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
113  * entered when there already is a fullscreen container on this workspace.
114  *
115  */
116 void con_toggle_fullscreen(Con *con);
117
118 /**
119  * Moves the given container to the currently focused container on the given
120  * workspace.
121  * TODO: is there a better place for this function?
122  *
123  */
124 void con_move_to_workspace(Con *con, Con *workspace);
125
126 /**
127  * Returns the orientation of the given container (for stacked containers,
128  * vertical orientation is used regardless of the actual orientation of the
129  * container).
130  *
131  */
132 int con_orientation(Con *con);
133
134 /**
135  * Returns the container which will be focused next when the given container
136  * is not available anymore. Called in tree_close and con_move_to_workspace
137  * to properly restore focus.
138  *
139  */
140 Con *con_next_focused(Con *con);
141
142 /**
143  * Returns a "relative" Rect which contains the amount of pixels that need to
144  * be added to the original Rect to get the final position (obviously the
145  * amount of pixels for normal, 1pixel and borderless are different).
146  *
147  */
148 Rect con_border_style_rect(Con *con);
149
150 /**
151  * Use this function to get a container’s border style. This is important
152  * because when inside a stack, the border style is always BS_NORMAL.
153  * For tabbed mode, the same applies, with one exception: when the container is
154  * borderless and the only element in the tabbed container, the border is not
155  * rendered.
156  *
157  */
158 int con_border_style(Con *con);
159
160 /**
161  * This function changes the layout of a given container. Use it to handle
162  * special cases like changing a whole workspace to stacked/tabbed (creates a
163  * new split container before).
164  *
165  */
166 void con_set_layout(Con *con, int layout);
167
168 #endif