i3
con.h
Go to the documentation of this file.
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 #pragma once
13 
19 Con *con_new_skeleton(Con *parent, i3Window *window);
20 
21 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
22  *
23  */
24 Con *con_new(Con *parent, i3Window *window);
25 
31 void con_focus(Con *con);
32 
37 bool con_is_leaf(Con *con);
38 
43 bool con_has_managed_window(Con *con);
44 
45 /*
46  * Returns true if a container should be considered split.
47  *
48  */
49 bool con_is_split(Con *con);
50 
55 bool con_has_children(Con *con);
56 
62 bool con_accepts_window(Con *con);
63 
69 Con *con_get_output(Con *con);
70 
76 
83 
88 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
89 
94 bool con_is_internal(Con *con);
95 
100 bool con_is_floating(Con *con);
101 
108 
113 bool con_inside_focused(Con *con);
114 
120 Con *con_by_window_id(xcb_window_t window);
121 
127 Con *con_by_frame_id(xcb_window_t frame);
128 
134 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
135 
140 int con_num_children(Con *con);
141 
152 void con_attach(Con *con, Con *parent, bool ignore_focus);
153 
158 void con_detach(Con *con);
159 
166 void con_fix_percent(Con *con);
167 
173 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
174 
179 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
180 
185 void con_disable_fullscreen(Con *con);
186 
204 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
205 
213 
220 Con *con_next_focused(Con *con);
221 
227 Con *con_get_next(Con *con, char way, orientation_t orientation);
228 
236 
246 
247 /*
248  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
249  * direction is D_LEFT, then we return the rightmost container and if direction
250  * is D_RIGHT, we return the leftmost container. This is because if we are
251  * moving D_LEFT, and thus want the rightmost container.
252  */
253 Con *con_descend_direction(Con *con, direction_t direction);
254 
262 
268 
279 int con_border_style(Con *con);
280 
286 void con_set_border_style(Con *con, int border_style, int border_width);
287 
294 void con_set_layout(Con *con, layout_t layout);
295 
303 void con_toggle_layout(Con *con, const char *toggle_mode);
304 
311 
334 
339 bool con_has_urgent_child(Con *con);
340 
347 
352 void con_set_urgency(Con *con, bool urgent);
353 
358 char *con_get_tree_representation(Con *con);
359 
bool con_has_children(Con *con)
Returns true if this node has regular or floating children.
Definition: con.c:238
char * con_get_tree_representation(Con *con)
Create a string representing the subtree under con.
Definition: con.c:1675
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition: con.c:1634
Con * con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode)
Returns the first fullscreen node below this node.
Definition: con.c:346
void con_toggle_layout(Con *con, const char *toggle_mode)
This function toggles the layout of a given container.
Definition: con.c:1371
direction_t
Definition: data.h:53
fullscreen_mode_t
Fullscreen modes.
Definition: data.h:488
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition: con.c:392
void con_set_border_style(Con *con, int border_style, int border_width)
Sets the given border style on con, correctly keeping the position/size of a floating window...
Definition: con.c:1234
void con_focus(Con *con)
Sets input focus to the given container.
Definition: con.c:193
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:130
void con_set_layout(Con *con, layout_t layout)
This function changes the layout of a given container.
Definition: con.c:1276
int con_border_style(Con *con)
Use this function to get a container’s border style.
Definition: con.c:1210
bool con_inside_focused(Con *con)
Checks if the given container is inside a focused container.
Definition: con.c:429
bool con_is_split(Con *con)
Definition: con.c:246
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition: con.c:177
bool con_is_leaf(Con *con)
Returns true when this node is a leaf node (has no children)
Definition: con.c:222
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition: con.c:523
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:468
layout_t
Container layouts.
Definition: data.h:92
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:344
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:1471
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1029
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:230
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:265
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition: con.c:400
Con * con_descend_direction(Con *con, direction_t direction)
Definition: con.c:1070
void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode)
Enables fullscreen mode for the given container, if necessary.
Definition: con.c:623
Con * con_parent_with_orientation(Con *con, orientation_t orientation)
Searches parenst of the given 'con' until it reaches one with the specified 'orientation'.
Definition: con.c:310
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition: con.c:568
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:1136
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:455
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:298
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on...
Definition: con.c:284
Con * con_new(Con *parent, i3Window *window)
Definition: con.c:67
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:442
void con_disable_fullscreen(Con *con)
Disables fullscreen mode for the given container, if necessary.
Definition: con.c:669
A "match" is a data structure which acts like a mask or expression to match certain windows or not...
Definition: data.h:404
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:1613
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:496
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:1545
void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp)
Moves the given container to the currently focused container on the given workspace.
Definition: con.c:702
int con_num_children(Con *con)
Returns the number of children of this container.
Definition: con.c:507
orientation_t
Definition: data.h:57
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:924
orientation_t con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition: con.c:889
adjacent_t
describes if the window is adjacent to the output (physical screen) edges.
Definition: data.h:71
adjacent_t con_adjacent_borders(Con *con)
Returns adjacent borders of the window.
Definition: con.c:1186
void con_force_split_parents_redraw(Con *con)
force parent split containers to be redrawn
Definition: con.c:23
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition: con.c:411
Con * con_get_next(Con *con, char way, orientation_t orientation)
Get the next/previous container in the specified orientation.
Definition: con.c:992
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition: con.c:83
bool con_has_urgent_child(Con *con)
Checks if the given container has an urgent child.
Definition: con.c:1592
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
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1044