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 * Closes the given container.
37 void con_close(Con *con, kill_window_t kill_window);
40 * Returns true when this node is a leaf node (has no children)
43 bool con_is_leaf(Con *con);
46 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
47 * excluding dock containers)
49 bool con_has_managed_window(Con *con);
52 * Returns true if a container should be considered split.
55 bool con_is_split(Con *con);
58 * This will only return true for containers which have some parent with
59 * a tabbed / stacked parent of which they are not the currently focused child.
62 bool con_is_hidden(Con *con);
65 * Returns whether the container or any of its children is sticky.
68 bool con_is_sticky(Con *con);
71 * Returns true if this node has regular or floating children.
74 bool con_has_children(Con *con);
77 * Returns true if this node accepts a window (if the node swallows windows,
78 * it might already have swallowed enough and cannot hold any more).
81 bool con_accepts_window(Con *con);
84 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
88 Con *con_get_output(Con *con);
91 * Gets the workspace container this node is on.
94 Con *con_get_workspace(Con *con);
97 * Searches parenst of the given 'con' until it reaches one with the specified
98 * 'orientation'. Aborts when it comes across a floating_con.
101 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
104 * Returns the first fullscreen node below this node.
107 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
110 * Returns true if the container is internal, such as __i3_scratch
113 bool con_is_internal(Con *con);
116 * Returns true if the node is floating.
119 bool con_is_floating(Con *con);
122 * Returns true if the container is a docked container.
125 bool con_is_docked(Con *con);
128 * Checks if the given container is either floating or inside some floating
129 * container. It returns the FLOATING_CON container.
132 Con *con_inside_floating(Con *con);
135 * Checks if the given container is inside a focused container.
138 bool con_inside_focused(Con *con);
141 * Returns the container with the given client window ID or NULL if no such
145 Con *con_by_window_id(xcb_window_t window);
148 * Returns the container with the given frame ID or NULL if no such container
152 Con *con_by_frame_id(xcb_window_t frame);
155 * Returns the container with the given mark or NULL if no such container
159 Con *con_by_mark(const char *mark);
162 * Returns true if and only if the given containers holds the mark.
165 bool con_has_mark(Con *con, const char *mark);
168 * Toggles the mark on a container.
169 * If the container already has this mark, the mark is removed.
170 * Otherwise, the mark is assigned to the container.
173 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);
176 * Assigns a mark to the container.
179 void con_mark(Con *con, const char *mark, mark_mode_t mode);
182 * Removes marks from containers.
183 * If con is NULL, all containers are considered.
184 * If name is NULL, this removes all existing marks.
185 * Otherwise, it will only remove the given mark (if it is present).
188 void con_unmark(Con *con, const char *name);
191 * Returns the first container below 'con' which wants to swallow this window
195 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
198 * Returns the number of children of this container.
201 int con_num_children(Con *con);
204 * Count the number of windows (i.e., leaf containers).
207 int con_num_windows(Con *con);
210 * Attaches the given container to the given parent. This happens when moving
211 * a container or when inserting a new container at a specific place in the
214 * ignore_focus is to just insert the Con at the end (useful when creating a
215 * new split container *around* some containers, that is, detaching and
216 * attaching them in order without wanting to mess with the focus in between).
219 void con_attach(Con *con, Con *parent, bool ignore_focus);
222 * Detaches the given container from its current parent
225 void con_detach(Con *con);
228 * Updates the percent attribute of the children of the given container. This
229 * function needs to be called when a window is added or removed from a
233 void con_fix_percent(Con *con);
236 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
237 * entered when there already is a fullscreen container on this workspace.
240 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
243 * Enables fullscreen mode for the given container, if necessary.
246 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
249 * Disables fullscreen mode for the given container, if necessary.
252 void con_disable_fullscreen(Con *con);
255 * Moves the given container to the currently focused container on the given
258 * The fix_coordinates flag will translate the current coordinates (offset from
259 * the monitor position basically) to appropriate coordinates on the
260 * destination workspace.
261 * Not enabling this behaviour comes in handy when this function gets called by
262 * floating_maybe_reassign_ws, which will only "move" a floating window when it
263 * *already* changed its coordinates to a different output.
265 * The dont_warp flag disables pointer warping and will be set when this
266 * function is called while dragging a floating window.
268 * If ignore_focus is set, the container will be moved without modifying focus
271 * TODO: is there a better place for this function?
274 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates,
275 bool dont_warp, bool ignore_focus);
278 * Moves the given container to the currently focused container on the
279 * visible workspace on the given output.
282 void con_move_to_output(Con *con, Output *output);
285 * Moves the given container to the given mark.
288 bool con_move_to_mark(Con *con, const char *mark);
291 * Returns the orientation of the given container (for stacked containers,
292 * vertical orientation is used regardless of the actual orientation of the
296 orientation_t con_orientation(Con *con);
299 * Returns the container which will be focused next when the given container
300 * is not available anymore. Called in tree_close_internal and con_move_to_workspace
301 * to properly restore focus.
304 Con *con_next_focused(Con *con);
307 * Get the next/previous container in the specified orientation. This may
308 * travel up until it finds a container with suitable orientation.
311 Con *con_get_next(Con *con, char way, orientation_t orientation);
314 * Returns the focused con inside this client, descending the tree as far as
315 * possible. This comes in handy when attaching a con to a workspace at the
316 * currently focused position, for example.
319 Con *con_descend_focused(Con *con);
322 * Returns the focused con inside this client, descending the tree as far as
323 * possible. This comes in handy when attaching a con to a workspace at the
324 * currently focused position, for example.
326 * Works like con_descend_focused but considers only tiling cons.
329 Con *con_descend_tiling_focused(Con *con);
332 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
333 * direction is D_LEFT, then we return the rightmost container and if direction
334 * is D_RIGHT, we return the leftmost container. This is because if we are
335 * moving D_LEFT, and thus want the rightmost container.
337 Con *con_descend_direction(Con *con, direction_t direction);
340 * Returns a "relative" Rect which contains the amount of pixels that need to
341 * be added to the original Rect to get the final position (obviously the
342 * amount of pixels for normal, 1pixel and borderless are different).
345 Rect con_border_style_rect(Con *con);
348 * Returns adjacent borders of the window. We need this if hide_edge_borders is
351 adjacent_t con_adjacent_borders(Con *con);
354 * Use this function to get a container’s border style. This is important
355 * because when inside a stack, the border style is always BS_NORMAL.
356 * For tabbed mode, the same applies, with one exception: when the container is
357 * borderless and the only element in the tabbed container, the border is not
360 * For children of a CT_DOCKAREA, the border style is always none.
363 int con_border_style(Con *con);
366 * Sets the given border style on con, correctly keeping the position/size of a
370 void con_set_border_style(Con *con, int border_style, int border_width);
373 * This function changes the layout of a given container. Use it to handle
374 * special cases like changing a whole workspace to stacked/tabbed (creates a
375 * new split container before).
378 void con_set_layout(Con *con, layout_t layout);
381 * This function toggles the layout of a given container. toggle_mode can be
382 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
383 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
387 void con_toggle_layout(Con *con, const char *toggle_mode);
390 * Determines the minimum size of the given con by looking at its children (for
391 * split/stacked/tabbed cons). Will be called when resizing floating cons
394 Rect con_minimum_size(Con *con);
397 * Returns true if changing the focus to con would be allowed considering
398 * the fullscreen focus constraints. Specifically, if a fullscreen container or
399 * any of its descendants is focused, this function returns true if and only if
400 * focusing con would mean that focus would still be visible on screen, i.e.,
401 * the newly focused container would not be obscured by a fullscreen container.
403 * In the simplest case, if a fullscreen container or any of its descendants is
404 * fullscreen, this functions returns true if con is the fullscreen container
405 * itself or any of its descendants, as this means focus wouldn't escape the
406 * boundaries of the fullscreen container.
408 * In case the fullscreen container is of type CF_OUTPUT, this function returns
409 * true if con is on a different workspace, as focus wouldn't be obscured by
410 * the fullscreen container that is constrained to a different workspace.
412 * Note that this same logic can be applied to moving containers. If a
413 * container can be focused under the fullscreen focus constraints, it can also
414 * become a parent or sibling to the currently focused container.
417 bool con_fullscreen_permits_focusing(Con *con);
420 * Checks if the given container has an urgent child.
423 bool con_has_urgent_child(Con *con);
426 * Make all parent containers urgent if con is urgent or clear the urgent flag
427 * of all parent containers if there are no more urgent children left.
430 void con_update_parents_urgency(Con *con);
433 * Set urgency flag to the container, all the parent containers and the workspace.
436 void con_set_urgency(Con *con, bool urgent);
439 * Create a string representing the subtree under con.
442 char *con_get_tree_representation(Con *con);
445 * force parent split containers to be redrawn
448 void con_force_split_parents_redraw(Con *con);
451 * Returns the window title considering the current title format.
454 i3String *con_parse_title_format(Con *con);