2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * con.c: Functions which deal with containers directly (creating containers,
8 * searching containers, getting specific properties from containers,
15 * Create a new container (and attach it to the given parent, if not NULL).
16 * This function only initializes the data structures.
19 Con *con_new_skeleton(Con *parent, i3Window *window);
21 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
24 Con *con_new(Con *parent, i3Window *window);
27 * Sets input focus to the given container. Will be updated in X11 in the next
28 * run of x_push_changes().
31 void con_focus(Con *con);
34 * Returns true when this node is a leaf node (has no children)
37 bool con_is_leaf(Con *con);
40 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
41 * excluding dock containers)
43 bool con_has_managed_window(Con *con);
46 * Returns true if a container should be considered split.
49 bool con_is_split(Con *con);
52 * Returns true if this node has regular or floating children.
55 bool con_has_children(Con *con);
58 * Returns true if this node accepts a window (if the node swallows windows,
59 * it might already have swallowed enough and cannot hold any more).
62 bool con_accepts_window(Con *con);
65 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
69 Con *con_get_output(Con *con);
72 * Gets the workspace container this node is on.
75 Con *con_get_workspace(Con *con);
78 * Searches parenst of the given 'con' until it reaches one with the specified
79 * 'orientation'. Aborts when it comes across a floating_con.
82 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
85 * Returns the first fullscreen node below this node.
88 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
91 * Returns true if the container is internal, such as __i3_scratch
94 bool con_is_internal(Con *con);
97 * Returns true if the node is floating.
100 bool con_is_floating(Con *con);
103 * Checks if the given container is either floating or inside some floating
104 * container. It returns the FLOATING_CON container.
107 Con *con_inside_floating(Con *con);
110 * Checks if the given container is inside a focused container.
113 bool con_inside_focused(Con *con);
116 * Returns the container with the given client window ID or NULL if no such
120 Con *con_by_window_id(xcb_window_t window);
123 * Returns the container with the given frame ID or NULL if no such container
127 Con *con_by_frame_id(xcb_window_t frame);
130 * Returns the container with the given mark or NULL if no such container
134 Con *con_by_mark(const char *mark);
137 * Returns the first container below 'con' which wants to swallow this window
141 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
144 * Returns the number of children of this container.
147 int con_num_children(Con *con);
150 * Attaches the given container to the given parent. This happens when moving
151 * a container or when inserting a new container at a specific place in the
154 * ignore_focus is to just insert the Con at the end (useful when creating a
155 * new split container *around* some containers, that is, detaching and
156 * attaching them in order without wanting to mess with the focus in between).
159 void con_attach(Con *con, Con *parent, bool ignore_focus);
162 * Detaches the given container from its current parent
165 void con_detach(Con *con);
168 * Updates the percent attribute of the children of the given container. This
169 * function needs to be called when a window is added or removed from a
173 void con_fix_percent(Con *con);
176 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
177 * entered when there already is a fullscreen container on this workspace.
180 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
183 * Enables fullscreen mode for the given container, if necessary.
186 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
189 * Disables fullscreen mode for the given container, if necessary.
192 void con_disable_fullscreen(Con *con);
195 * Moves the given container to the currently focused container on the given
198 * The fix_coordinates flag will translate the current coordinates (offset from
199 * the monitor position basically) to appropriate coordinates on the
200 * destination workspace.
201 * Not enabling this behaviour comes in handy when this function gets called by
202 * floating_maybe_reassign_ws, which will only "move" a floating window when it
203 * *already* changed its coordinates to a different output.
205 * The dont_warp flag disables pointer warping and will be set when this
206 * function is called while dragging a floating window.
208 * TODO: is there a better place for this function?
211 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
214 * Moves the given container to the given mark.
217 bool con_move_to_mark(Con *con, const char *mark);
220 * Returns the orientation of the given container (for stacked containers,
221 * vertical orientation is used regardless of the actual orientation of the
225 orientation_t con_orientation(Con *con);
228 * Returns the container which will be focused next when the given container
229 * is not available anymore. Called in tree_close and con_move_to_workspace
230 * to properly restore focus.
233 Con *con_next_focused(Con *con);
236 * Get the next/previous container in the specified orientation. This may
237 * travel up until it finds a container with suitable orientation.
240 Con *con_get_next(Con *con, char way, orientation_t orientation);
243 * Returns the focused con inside this client, descending the tree as far as
244 * possible. This comes in handy when attaching a con to a workspace at the
245 * currently focused position, for example.
248 Con *con_descend_focused(Con *con);
251 * Returns the focused con inside this client, descending the tree as far as
252 * possible. This comes in handy when attaching a con to a workspace at the
253 * currently focused position, for example.
255 * Works like con_descend_focused but considers only tiling cons.
258 Con *con_descend_tiling_focused(Con *con);
261 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
262 * direction is D_LEFT, then we return the rightmost container and if direction
263 * is D_RIGHT, we return the leftmost container. This is because if we are
264 * moving D_LEFT, and thus want the rightmost container.
266 Con *con_descend_direction(Con *con, direction_t direction);
269 * Returns a "relative" Rect which contains the amount of pixels that need to
270 * be added to the original Rect to get the final position (obviously the
271 * amount of pixels for normal, 1pixel and borderless are different).
274 Rect con_border_style_rect(Con *con);
277 * Returns adjacent borders of the window. We need this if hide_edge_borders is
280 adjacent_t con_adjacent_borders(Con *con);
283 * Use this function to get a container’s border style. This is important
284 * because when inside a stack, the border style is always BS_NORMAL.
285 * For tabbed mode, the same applies, with one exception: when the container is
286 * borderless and the only element in the tabbed container, the border is not
289 * For children of a CT_DOCKAREA, the border style is always none.
292 int con_border_style(Con *con);
295 * Sets the given border style on con, correctly keeping the position/size of a
299 void con_set_border_style(Con *con, int border_style, int border_width);
302 * This function changes the layout of a given container. Use it to handle
303 * special cases like changing a whole workspace to stacked/tabbed (creates a
304 * new split container before).
307 void con_set_layout(Con *con, layout_t layout);
310 * This function toggles the layout of a given container. toggle_mode can be
311 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
312 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
316 void con_toggle_layout(Con *con, const char *toggle_mode);
319 * Determines the minimum size of the given con by looking at its children (for
320 * split/stacked/tabbed cons). Will be called when resizing floating cons
323 Rect con_minimum_size(Con *con);
326 * Returns true if changing the focus to con would be allowed considering
327 * the fullscreen focus constraints. Specifically, if a fullscreen container or
328 * any of its descendants is focused, this function returns true if and only if
329 * focusing con would mean that focus would still be visible on screen, i.e.,
330 * the newly focused container would not be obscured by a fullscreen container.
332 * In the simplest case, if a fullscreen container or any of its descendants is
333 * fullscreen, this functions returns true if con is the fullscreen container
334 * itself or any of its descendants, as this means focus wouldn't escape the
335 * boundaries of the fullscreen container.
337 * In case the fullscreen container is of type CF_OUTPUT, this function returns
338 * true if con is on a different workspace, as focus wouldn't be obscured by
339 * the fullscreen container that is constrained to a different workspace.
341 * Note that this same logic can be applied to moving containers. If a
342 * container can be focused under the fullscreen focus constraints, it can also
343 * become a parent or sibling to the currently focused container.
346 bool con_fullscreen_permits_focusing(Con *con);
349 * Checks if the given container has an urgent child.
352 bool con_has_urgent_child(Con *con);
355 * Make all parent containers urgent if con is urgent or clear the urgent flag
356 * of all parent containers if there are no more urgent children left.
359 void con_update_parents_urgency(Con *con);
362 * Set urgency flag to the container, all the parent containers and the workspace.
365 void con_set_urgency(Con *con, bool urgent);
368 * Create a string representing the subtree under con.
371 char *con_get_tree_representation(Con *con);
374 * force parent split containers to be redrawn
377 void con_force_split_parents_redraw(Con *con);