i3
con.h
Go to the documentation of this file.
1/*
2 * vim:ts=4:sw=4:expandtab
3 *
4 * i3 - an improved tiling window manager
5 * © 2009 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#pragma once
13
14#include <config.h>
15
21Con *con_new_skeleton(Con *parent, i3Window *window);
22
27Con *con_new(Con *parent, i3Window *window);
28
33void con_free(Con *con);
34
40void con_focus(Con *con);
41
46void con_activate(Con *con);
47
53void con_activate_unblock(Con *con);
54
59void con_close(Con *con, kill_window_t kill_window);
60
65bool con_is_leaf(Con *con);
66
72
77bool con_is_split(Con *con);
78
84bool con_is_hidden(Con *con);
85
100bool con_is_maximized(Con *con, orientation_t orientation);
101
106bool con_is_sticky(Con *con);
107
112bool con_has_children(Con *con);
113
119bool con_accepts_window(Con *con);
120
126Con *con_get_output(Con *con);
127
133
140
145Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
146
154
159bool con_is_internal(Con *con);
160
165bool con_is_floating(Con *con);
166
171bool con_is_docked(Con *con);
172
179
184bool con_inside_focused(Con *con);
185
190bool con_has_parent(Con *con, Con *parent);
191
197Con *con_by_window_id(xcb_window_t window);
198
204Con *con_by_con_id(long target);
205
211bool con_exists(Con *con);
212
218Con *con_by_frame_id(xcb_window_t frame);
219
225Con *con_by_mark(const char *mark);
226
233bool con_find_transient_for_window(Con *start, xcb_window_t target);
234
239bool con_has_mark(Con *con, const char *mark);
240
247void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);
248
253void con_mark(Con *con, const char *mark, mark_mode_t mode);
254
262void con_unmark(Con *con, const char *name);
263
269Con *con_for_window(Con *con, i3Window *window, Match **store_match);
270
276Con **get_focus_order(Con *con);
277
285void set_focus_order(Con *con, Con **focus_order);
286
291int con_num_children(Con *con);
292
299
304int con_num_windows(Con *con);
305
316void con_attach(Con *con, Con *parent, bool ignore_focus);
317
322void con_detach(Con *con);
323
330void con_fix_percent(Con *con);
331
337void con_toggle_fullscreen(Con *con, int fullscreen_mode);
338
343void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
344
349void con_disable_fullscreen(Con *con);
350
371void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates,
372 bool dont_warp, bool ignore_focus);
373
379void con_move_to_output(Con *con, Output *output, bool fix_coordinates);
380
388bool con_move_to_output_name(Con *con, const char *name, bool fix_coordinates);
389
390bool con_move_to_target(Con *con, Con *target);
395bool con_move_to_mark(Con *con, const char *mark);
396
404
412
420
430
437Con *con_descend_direction(Con *con, direction_t direction);
438
446
454
460
471int con_border_style(Con *con);
472
478void con_set_border_style(Con *con, border_style_t border_style, int border_width);
479
486void con_set_layout(Con *con, layout_t layout);
487
495void con_toggle_layout(Con *con, const char *toggle_mode);
496
503
526
531bool con_has_urgent_child(Con *con);
532
539
544void con_set_urgency(Con *con, bool urgent);
545
551
557
563
568bool con_swap(Con *first, Con *second);
569
575uint32_t con_rect_size_in_orientation(Con *con);
576
583void con_merge_into(Con *old, Con *new);
584
char * con_get_tree_representation(Con *con)
Create a string representing the subtree under con.
Definition con.c:2473
void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp, bool ignore_focus)
Moves the given container to the currently focused container on the given workspace.
Definition con.c:1574
bool con_move_to_target(Con *con, Con *target)
Definition con.c:1503
bool con_move_to_mark(Con *con, const char *mark)
Moves the given container to the given mark.
Definition con.c:1544
bool con_move_to_output_name(Con *con, const char *name, bool fix_coordinates)
Moves the given container to the currently focused container on the visible workspace on the output s...
Definition con.c:1607
Con * con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode)
Returns the first fullscreen node below this node.
Definition con.c:599
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition con.c:2431
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition con.c:670
bool con_inside_stacked_or_tabbed(Con *con)
Returns true if the container is within any stacked/tabbed split container.
Definition con.c:2752
Con * con_for_window(Con *con, i3Window *window, Match **store_match)
Returns the first container below 'con' which wants to swallow this window TODO: priority.
Definition con.c:976
void con_close(Con *con, kill_window_t kill_window)
Closes the given container.
Definition con.c:336
orientation_t con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition con.c:1625
void con_force_split_parents_redraw(Con *con)
force parent split containers to be redrawn
Definition con.c:21
void con_unmark(Con *con, const char *name)
Removes marks from containers.
Definition con.c:919
bool con_has_managed_window(Con *con)
Returns true when this con is a leaf node with a managed X11 window (e.g., excluding dock containers)
Definition con.c:374
Con * con_descend_direction(Con *con, direction_t direction)
Returns the leftmost, rightmost, etc.
Definition con.c:1742
void con_update_parents_urgency(Con *con)
Make all parent containers urgent if con is urgent or clear the urgent flag of all parent containers ...
Definition con.c:2401
Con * con_new(Con *parent, i3Window *window)
A wrapper for con_new_skeleton, to retain the old con_new behaviour.
Definition con.c:70
bool con_is_hidden(Con *con)
This will only return true for containers which have some parent with a tabbed / stacked parent of wh...
Definition con.c:410
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition con.c:547
bool con_find_transient_for_window(Con *start, xcb_window_t target)
Start from a container and traverse the transient_for linked list.
Definition con.c:824
bool con_is_split(Con *con)
Returns true if a container should be considered split.
Definition con.c:390
bool con_has_children(Con *con)
Returns true if this node has regular or floating children.
Definition con.c:382
bool con_is_maximized(Con *con, orientation_t orientation)
Returns true if the container is maximized in the given orientation.
Definition con.c:442
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition con.c:1714
void con_disable_fullscreen(Con *con)
Disables fullscreen mode for the given container, if necessary.
Definition con.c:1299
bool con_is_docked(Con *con)
Returns true if the container is a docked container.
Definition con.c:679
void con_set_border_style(Con *con, border_style_t border_style, int border_width)
Sets the given border style on con, correctly keeping the position/size of a floating window.
Definition con.c:1964
int con_num_visible_children(Con *con)
Returns the number of visible non-floating children of this container.
Definition con.c:1091
Con * con_by_con_id(long target)
Returns the container with the given container ID or NULL if no such container exists.
Definition con.c:767
Con * con_new_skeleton(Con *parent, i3Window *window)
Create a new container (and attach it to the given parent, if not NULL).
Definition con.c:38
void con_mark(Con *con, const char *mark, mark_mode_t mode)
Assigns a mark to the container.
Definition con.c:889
Con * con_by_window_id(xcb_window_t window)
Returns the container with the given client window ID or NULL if no such container exists.
Definition con.c:752
void con_activate_unblock(Con *con)
Activates the container like in con_activate but removes fullscreen restrictions and properly warps t...
Definition con.c:302
Con * con_by_mark(const char *mark)
Returns the container with the given mark or NULL if no such container exists.
Definition con.c:807
Rect con_border_style_rect(Con *con)
Returns a "relative" Rect which contains the amount of pixels that need to be added to the original R...
Definition con.c:1887
Con * con_get_fullscreen_covering_ws(Con *ws)
Returns the fullscreen node that covers the given workspace if it exists.
Definition con.c:647
void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode)
Toggles the mark on a container.
Definition con.c:874
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition con.c:696
bool con_fullscreen_permits_focusing(Con *con)
Returns true if changing the focus to con would be allowed considering the fullscreen focus constrain...
Definition con.c:2334
bool con_swap(Con *first, Con *second)
Swaps the two containers.
Definition con.c:2587
bool con_accepts_window(Con *con)
Returns true if this node accepts a window (if the node swallows windows, it might already have swall...
Definition con.c:512
uint32_t con_rect_size_in_orientation(Con *con)
Returns given container's rect size depending on its orientation.
Definition con.c:2707
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition con.c:662
bool con_exists(Con *con)
Returns true if the given container (still) exists.
Definition con.c:783
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition con.c:234
void con_move_to_output(Con *con, Output *output, bool fix_coordinates)
Moves the given container to the currently focused container on the visible workspace on the given ou...
Definition con.c:1592
void set_focus_order(Con *con, Con **focus_order)
Clear the container's focus stack and re-add it using the provided container array.
Definition con.c:1051
int con_border_style(Con *con)
Use this function to get a container’s border style.
Definition con.c:1936
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition con.c:1192
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition con.c:1144
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition con.c:226
Rect con_minimum_size(Con *con)
Determines the minimum size of the given con by looking at its children (for split/stacked/tabbed con...
Definition con.c:2260
i3String * con_parse_title_format(Con *con)
Returns the window title considering the current title format.
Definition con.c:2538
bool con_inside_focused(Con *con)
Checks if the given container is inside a focused container.
Definition con.c:720
void con_free(Con *con)
Frees the specified container.
Definition con.c:80
void con_merge_into(Con *old, Con *new)
Merges container specific data that should move with the window (e.g.
Definition con.c:2717
Con * con_by_frame_id(xcb_window_t frame)
Returns the container with the given frame ID or NULL if no such container exists.
Definition con.c:792
bool con_is_leaf(Con *con)
Returns true when this node is a leaf node (has no children)
Definition con.c:366
int con_num_children(Con *con)
Returns the number of children of this container.
Definition con.c:1075
adjacent_t con_adjacent_borders(Con *con)
Returns adjacent borders of the window.
Definition con.c:1902
void con_set_layout(Con *con, layout_t layout)
This function changes the layout of a given container.
Definition con.c:2002
void con_activate(Con *con)
Sets input focus to the given container and raises it to the top.
Definition con.c:292
Con * con_parent_with_orientation(Con *con, orientation_t orientation)
Searches parents of the given 'con' until it reaches one with the specified 'orientation'.
Definition con.c:560
bool con_draw_decoration_into_frame(Con *con)
Returns whether the window decoration (title bar) should be drawn into the X11 frame window of this c...
Definition con.c:1818
void con_toggle_layout(Con *con, const char *toggle_mode)
This function toggles the layout of a given container.
Definition con.c:2115
bool con_has_mark(Con *con, const char *mark)
Returns true if and only if the given containers holds the mark.
Definition con.c:857
Con * con_next_focused(Con *con)
Returns the container which will be focused next when the given container is not available anymore.
Definition con.c:1656
bool con_has_urgent_child(Con *con)
Checks if the given container has an urgent child.
Definition con.c:2378
void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode)
Enables fullscreen mode for the given container, if necessary.
Definition con.c:1248
bool con_has_parent(Con *con, Con *parent)
Checks if the container has the given parent as an actual parent.
Definition con.c:734
int con_num_windows(Con *con)
Count the number of windows (i.e., leaf containers).
Definition con.c:1116
void con_focus(Con *con)
Sets input focus to the given container.
Definition con.c:250
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on.
Definition con.c:532
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition con.c:1698
bool con_is_sticky(Con *con)
Returns whether the container or any of its children is sticky.
Definition con.c:492
Con ** get_focus_order(Con *con)
Iterate over the container's focus stack and return an array with the containers inside it,...
Definition con.c:1031
layout_t
Container layouts.
Definition data.h:101
mark_mode_t
Definition data.h:95
orientation_t
Definition data.h:60
adjacent_t
describes if the window is adjacent to the output (physical screen) edges.
Definition data.h:78
fullscreen_mode_t
Fullscreen modes.
Definition data.h:629
border_style_t
Definition data.h:65
kill_window_t
parameter to specify whether tree_close_internal() and x_window_kill() should kill only this specific...
Definition data.h:73
direction_t
Definition data.h:56
struct _i3String i3String
Opaque data structure for storing strings.
Definition libi3.h:49
Stores a rectangle, for example the size of a window, the child window etc.
Definition data.h:185
An Output is a physical output on your graphics driver.
Definition data.h:391
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition data.h:424
A "match" is a data structure which acts like a mask or expression to match certain windows or not.
Definition data.h:529
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition data.h:643