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,
17 * Create a new container (and attach it to the given parent, if not NULL).
18 * This function only initializes the data structures.
21 Con *con_new_skeleton(Con *parent, i3Window *window);
23 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
26 Con *con_new(Con *parent, i3Window *window);
29 * Sets input focus to the given container. Will be updated in X11 in the next
30 * run of x_push_changes().
33 void con_focus(Con *con);
36 * Closes the given container.
39 void con_close(Con *con, kill_window_t kill_window);
42 * Returns true when this node is a leaf node (has no children)
45 bool con_is_leaf(Con *con);
48 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
49 * excluding dock containers)
51 bool con_has_managed_window(Con *con);
54 * Returns true if a container should be considered split.
57 bool con_is_split(Con *con);
60 * This will only return true for containers which have some parent with
61 * a tabbed / stacked parent of which they are not the currently focused child.
64 bool con_is_hidden(Con *con);
67 * Returns whether the container or any of its children is sticky.
70 bool con_is_sticky(Con *con);
73 * Returns true if this node has regular or floating children.
76 bool con_has_children(Con *con);
79 * Returns true if this node accepts a window (if the node swallows windows,
80 * it might already have swallowed enough and cannot hold any more).
83 bool con_accepts_window(Con *con);
86 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
90 Con *con_get_output(Con *con);
93 * Gets the workspace container this node is on.
96 Con *con_get_workspace(Con *con);
99 * Searches parenst of the given 'con' until it reaches one with the specified
100 * 'orientation'. Aborts when it comes across a floating_con.
103 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
106 * Returns the first fullscreen node below this node.
109 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
112 * Returns true if the container is internal, such as __i3_scratch
115 bool con_is_internal(Con *con);
118 * Returns true if the node is floating.
121 bool con_is_floating(Con *con);
124 * Returns true if the container is a docked container.
127 bool con_is_docked(Con *con);
130 * Checks if the given container is either floating or inside some floating
131 * container. It returns the FLOATING_CON container.
134 Con *con_inside_floating(Con *con);
137 * Checks if the given container is inside a focused container.
140 bool con_inside_focused(Con *con);
143 * Checks if the container has the given parent as an actual parent.
146 bool con_has_parent(Con *con, Con *parent);
149 * Returns the container with the given client window ID or NULL if no such
153 Con *con_by_window_id(xcb_window_t window);
156 * Returns the container with the given container ID or NULL if no such
160 Con *con_by_con_id(long target);
163 * Returns the container with the given frame ID or NULL if no such container
167 Con *con_by_frame_id(xcb_window_t frame);
170 * Returns the container with the given mark or NULL if no such container
174 Con *con_by_mark(const char *mark);
177 * Returns true if and only if the given containers holds the mark.
180 bool con_has_mark(Con *con, const char *mark);
183 * Toggles the mark on a container.
184 * If the container already has this mark, the mark is removed.
185 * Otherwise, the mark is assigned to the container.
188 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);
191 * Assigns a mark to the container.
194 void con_mark(Con *con, const char *mark, mark_mode_t mode);
197 * Removes marks from containers.
198 * If con is NULL, all containers are considered.
199 * If name is NULL, this removes all existing marks.
200 * Otherwise, it will only remove the given mark (if it is present).
203 void con_unmark(Con *con, const char *name);
206 * Returns the first container below 'con' which wants to swallow this window
210 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
213 * Returns the number of children of this container.
216 int con_num_children(Con *con);
219 * Returns the number of visible non-floating children of this container.
220 * For example, if the container contains a hsplit which has two children,
221 * this will return 2 instead of 1.
223 int con_num_visible_children(Con *con);
226 * Count the number of windows (i.e., leaf containers).
229 int con_num_windows(Con *con);
232 * Attaches the given container to the given parent. This happens when moving
233 * a container or when inserting a new container at a specific place in the
236 * ignore_focus is to just insert the Con at the end (useful when creating a
237 * new split container *around* some containers, that is, detaching and
238 * attaching them in order without wanting to mess with the focus in between).
241 void con_attach(Con *con, Con *parent, bool ignore_focus);
244 * Detaches the given container from its current parent
247 void con_detach(Con *con);
250 * Updates the percent attribute of the children of the given container. This
251 * function needs to be called when a window is added or removed from a
255 void con_fix_percent(Con *con);
258 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
259 * entered when there already is a fullscreen container on this workspace.
262 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
265 * Enables fullscreen mode for the given container, if necessary.
268 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
271 * Disables fullscreen mode for the given container, if necessary.
274 void con_disable_fullscreen(Con *con);
277 * Moves the given container to the currently focused container on the given
280 * The fix_coordinates flag will translate the current coordinates (offset from
281 * the monitor position basically) to appropriate coordinates on the
282 * destination workspace.
283 * Not enabling this behaviour comes in handy when this function gets called by
284 * floating_maybe_reassign_ws, which will only "move" a floating window when it
285 * *already* changed its coordinates to a different output.
287 * The dont_warp flag disables pointer warping and will be set when this
288 * function is called while dragging a floating window.
290 * If ignore_focus is set, the container will be moved without modifying focus
293 * TODO: is there a better place for this function?
296 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates,
297 bool dont_warp, bool ignore_focus);
300 * Moves the given container to the currently focused container on the
301 * visible workspace on the given output.
304 void con_move_to_output(Con *con, Output *output);
307 * Moves the given container to the given mark.
310 bool con_move_to_mark(Con *con, const char *mark);
313 * Returns the orientation of the given container (for stacked containers,
314 * vertical orientation is used regardless of the actual orientation of the
318 orientation_t con_orientation(Con *con);
321 * Returns the container which will be focused next when the given container
322 * is not available anymore. Called in tree_close_internal and con_move_to_workspace
323 * to properly restore focus.
326 Con *con_next_focused(Con *con);
329 * Get the next/previous container in the specified orientation. This may
330 * travel up until it finds a container with suitable orientation.
333 Con *con_get_next(Con *con, char way, orientation_t orientation);
336 * Returns the focused con inside this client, descending the tree as far as
337 * possible. This comes in handy when attaching a con to a workspace at the
338 * currently focused position, for example.
341 Con *con_descend_focused(Con *con);
344 * Returns the focused con inside this client, descending the tree as far as
345 * possible. This comes in handy when attaching a con to a workspace at the
346 * currently focused position, for example.
348 * Works like con_descend_focused but considers only tiling cons.
351 Con *con_descend_tiling_focused(Con *con);
354 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
355 * direction is D_LEFT, then we return the rightmost container and if direction
356 * is D_RIGHT, we return the leftmost container. This is because if we are
357 * moving D_LEFT, and thus want the rightmost container.
359 Con *con_descend_direction(Con *con, direction_t direction);
362 * Returns a "relative" Rect which contains the amount of pixels that need to
363 * be added to the original Rect to get the final position (obviously the
364 * amount of pixels for normal, 1pixel and borderless are different).
367 Rect con_border_style_rect(Con *con);
370 * Returns adjacent borders of the window. We need this if hide_edge_borders is
373 adjacent_t con_adjacent_borders(Con *con);
376 * Use this function to get a container’s border style. This is important
377 * because when inside a stack, the border style is always BS_NORMAL.
378 * For tabbed mode, the same applies, with one exception: when the container is
379 * borderless and the only element in the tabbed container, the border is not
382 * For children of a CT_DOCKAREA, the border style is always none.
385 int con_border_style(Con *con);
388 * Sets the given border style on con, correctly keeping the position/size of a
392 void con_set_border_style(Con *con, int border_style, int border_width);
395 * This function changes the layout of a given container. Use it to handle
396 * special cases like changing a whole workspace to stacked/tabbed (creates a
397 * new split container before).
400 void con_set_layout(Con *con, layout_t layout);
403 * This function toggles the layout of a given container. toggle_mode can be
404 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
405 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
409 void con_toggle_layout(Con *con, const char *toggle_mode);
412 * Determines the minimum size of the given con by looking at its children (for
413 * split/stacked/tabbed cons). Will be called when resizing floating cons
416 Rect con_minimum_size(Con *con);
419 * Returns true if changing the focus to con would be allowed considering
420 * the fullscreen focus constraints. Specifically, if a fullscreen container or
421 * any of its descendants is focused, this function returns true if and only if
422 * focusing con would mean that focus would still be visible on screen, i.e.,
423 * the newly focused container would not be obscured by a fullscreen container.
425 * In the simplest case, if a fullscreen container or any of its descendants is
426 * fullscreen, this functions returns true if con is the fullscreen container
427 * itself or any of its descendants, as this means focus wouldn't escape the
428 * boundaries of the fullscreen container.
430 * In case the fullscreen container is of type CF_OUTPUT, this function returns
431 * true if con is on a different workspace, as focus wouldn't be obscured by
432 * the fullscreen container that is constrained to a different workspace.
434 * Note that this same logic can be applied to moving containers. If a
435 * container can be focused under the fullscreen focus constraints, it can also
436 * become a parent or sibling to the currently focused container.
439 bool con_fullscreen_permits_focusing(Con *con);
442 * Checks if the given container has an urgent child.
445 bool con_has_urgent_child(Con *con);
448 * Make all parent containers urgent if con is urgent or clear the urgent flag
449 * of all parent containers if there are no more urgent children left.
452 void con_update_parents_urgency(Con *con);
455 * Set urgency flag to the container, all the parent containers and the workspace.
458 void con_set_urgency(Con *con, bool urgent);
461 * Create a string representing the subtree under con.
464 char *con_get_tree_representation(Con *con);
467 * force parent split containers to be redrawn
470 void con_force_split_parents_redraw(Con *con);
473 * Returns the window title considering the current title format.
476 i3String *con_parse_title_format(Con *con);
479 * Swaps the two containers.
482 bool con_swap(Con *first, Con *second);