]> git.sur5r.net Git - i3/i3/blob - include/con.h
common.mk: Split XCB common flags
[i3/i3] / include / con.h
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * con.c: Functions which deal with containers directly (creating containers,
8  *        searching containers, getting specific properties from containers,
9  *        …).
10  *
11  */
12 #ifndef _CON_H
13 #define _CON_H
14
15 /**
16  * Create a new container (and attach it to the given parent, if not NULL).
17  * This function initializes the data structures and creates the appropriate
18  * X11 IDs using x_con_init().
19  *
20  */
21 Con *con_new(Con *parent, i3Window *window);
22
23 /**
24  * Sets input focus to the given container. Will be updated in X11 in the next
25  * run of x_push_changes().
26  *
27  */
28 void con_focus(Con *con);
29
30 /**
31  * Returns true when this node is a leaf node (has no children)
32  *
33  */
34 bool con_is_leaf(Con *con);
35
36 /**
37  * Returns true if this node accepts a window (if the node swallows windows,
38  * it might already have swallowed enough and cannot hold any more).
39  *
40  */
41 bool con_accepts_window(Con *con);
42
43 /**
44  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
45  * node is on.
46  *
47  */
48 Con *con_get_output(Con *con);
49
50 /**
51  * Gets the workspace container this node is on.
52  *
53  */
54 Con *con_get_workspace(Con *con);
55
56 /**
57  * Searches parenst of the given 'con' until it reaches one with the specified
58  * 'orientation'. Aborts when it comes across a floating_con.
59  *
60  */
61 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
62
63 /**
64  * Returns the first fullscreen node below this node.
65  *
66  */
67 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode);
68
69 /**
70  * Returns true if the node is floating.
71  *
72  */
73 bool con_is_floating(Con *con);
74
75 /**
76  * Checks if the given container is either floating or inside some floating
77  * container. It returns the FLOATING_CON container.
78  *
79  */
80 Con *con_inside_floating(Con *con);
81
82 /**
83  * Checks if the given container is inside a focused container.
84  *
85  */
86 bool con_inside_focused(Con *con);
87
88 /**
89  * Returns the container with the given client window ID or NULL if no such
90  * container exists.
91  *
92  */
93 Con *con_by_window_id(xcb_window_t window);
94
95 /**
96  * Returns the container with the given frame ID or NULL if no such container
97  * exists.
98  *
99  */
100 Con *con_by_frame_id(xcb_window_t frame);
101
102 /**
103  * Returns the first container below 'con' which wants to swallow this window
104  * TODO: priority
105  *
106  */
107 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
108
109 /**
110  * Returns the number of children of this container.
111  *
112  */
113 int con_num_children(Con *con);
114
115 /**
116  * Attaches the given container to the given parent. This happens when moving
117  * a container or when inserting a new container at a specific place in the
118  * tree.
119  *
120  * ignore_focus is to just insert the Con at the end (useful when creating a
121  * new split container *around* some containers, that is, detaching and
122  * attaching them in order without wanting to mess with the focus in between).
123  *
124  */
125 void con_attach(Con *con, Con *parent, bool ignore_focus);
126
127 /**
128  * Detaches the given container from its current parent
129  *
130  */
131 void con_detach(Con *con);
132
133 /**
134  * Updates the percent attribute of the children of the given container. This
135  * function needs to be called when a window is added or removed from a
136  * container.
137  *
138  */
139 void con_fix_percent(Con *con);
140
141 /**
142  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
143  * entered when there already is a fullscreen container on this workspace.
144  *
145  */
146 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
147
148 /**
149  * Moves the given container to the currently focused container on the given
150  * workspace.
151  *
152  * The fix_coordinates flag will translate the current coordinates (offset from
153  * the monitor position basically) to appropriate coordinates on the
154  * destination workspace.
155  * Not enabling this behaviour comes in handy when this function gets called by
156  * floating_maybe_reassign_ws, which will only "move" a floating window when it
157  * *already* changed its coordinates to a different output.
158  *
159  * The dont_warp flag disables pointer warping and will be set when this
160  * function is called while dragging a floating window.
161  *
162  * TODO: is there a better place for this function?
163  *
164  */
165 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
166
167 /**
168  * Returns the orientation of the given container (for stacked containers,
169  * vertical orientation is used regardless of the actual orientation of the
170  * container).
171  *
172  */
173 int con_orientation(Con *con);
174
175 /**
176  * Returns the container which will be focused next when the given container
177  * is not available anymore. Called in tree_close and con_move_to_workspace
178  * to properly restore focus.
179  *
180  */
181 Con *con_next_focused(Con *con);
182
183 /**
184  * Get the next/previous container in the specified orientation. This may
185  * travel up until it finds a container with suitable orientation.
186  *
187  */
188 Con *con_get_next(Con *con, char way, orientation_t orientation);
189
190 /**
191  * Returns the focused con inside this client, descending the tree as far as
192  * possible. This comes in handy when attaching a con to a workspace at the
193  * currently focused position, for example.
194  *
195  */
196 Con *con_descend_focused(Con *con);
197
198 /**
199  * Returns the focused con inside this client, descending the tree as far as
200  * possible. This comes in handy when attaching a con to a workspace at the
201  * currently focused position, for example.
202  *
203  * Works like con_descend_focused but considers only tiling cons.
204  *
205  */
206 Con *con_descend_tiling_focused(Con *con);
207
208 /*
209  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
210  * direction is D_LEFT, then we return the rightmost container and if direction
211  * is D_RIGHT, we return the leftmost container.  This is because if we are
212  * moving D_LEFT, and thus want the rightmost container.
213  */
214 Con *con_descend_direction(Con *con, direction_t direction);
215
216 /**
217  * Returns a "relative" Rect which contains the amount of pixels that need to
218  * be added to the original Rect to get the final position (obviously the
219  * amount of pixels for normal, 1pixel and borderless are different).
220  *
221  */
222 Rect con_border_style_rect(Con *con);
223
224 /**
225  * Use this function to get a container’s border style. This is important
226  * because when inside a stack, the border style is always BS_NORMAL.
227  * For tabbed mode, the same applies, with one exception: when the container is
228  * borderless and the only element in the tabbed container, the border is not
229  * rendered.
230  *
231  * For children of a CT_DOCKAREA, the border style is always none.
232  *
233  */
234 int con_border_style(Con *con);
235
236 /**
237  * Sets the given border style on con, correctly keeping the position/size of a
238  * floating window.
239  *
240  */
241 void con_set_border_style(Con *con, int border_style);
242
243 /**
244  * This function changes the layout of a given container. Use it to handle
245  * special cases like changing a whole workspace to stacked/tabbed (creates a
246  * new split container before).
247  *
248  */
249 void con_set_layout(Con *con, int layout);
250
251 /**
252  * Determines the minimum size of the given con by looking at its children (for
253  * split/stacked/tabbed cons). Will be called when resizing floating cons
254  *
255  */
256 Rect con_minimum_size(Con *con);
257
258 /**
259  * Returns true if changing the focus to con would be allowed considering
260  * the fullscreen focus constraints. Specifically, if a fullscreen container or
261  * any of its descendants is focused, this function returns true if and only if
262  * focusing con would mean that focus would still be visible on screen, i.e.,
263  * the newly focused container would not be obscured by a fullscreen container.
264  *
265  * In the simplest case, if a fullscreen container or any of its descendants is
266  * fullscreen, this functions returns true if con is the fullscreen container
267  * itself or any of its descendants, as this means focus wouldn't escape the
268  * boundaries of the fullscreen container.
269  *
270  * In case the fullscreen container is of type CF_OUTPUT, this function returns
271  * true if con is on a different workspace, as focus wouldn't be obscured by
272  * the fullscreen container that is constrained to a different workspace.
273  *
274  * Note that this same logic can be applied to moving containers. If a
275  * container can be focused under the fullscreen focus constraints, it can also
276  * become a parent or sibling to the currently focused container.
277  *
278  */
279 bool con_fullscreen_permits_focusing(Con *con);
280
281 #endif