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 #ifndef I3_CON_H
13 #define I3_CON_H
14 
20 Con *con_new_skeleton(Con *parent, i3Window *window);
21 
22 
23 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
24  *
25  */
26 Con *con_new(Con *parent, i3Window *window);
27 
33 void con_focus(Con *con);
34 
39 bool con_is_leaf(Con *con);
40 
41 /*
42  * Returns true if a container should be considered split.
43  *
44  */
45 bool con_is_split(Con *con);
46 
51 bool con_has_children(Con *con);
52 
58 bool con_accepts_window(Con *con);
59 
65 Con *con_get_output(Con *con);
66 
72 
79 
84 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode);
85 
90 bool con_is_internal(Con *con);
91 
96 bool con_is_floating(Con *con);
97 
104 
109 bool con_inside_focused(Con *con);
110 
116 Con *con_by_window_id(xcb_window_t window);
117 
123 Con *con_by_frame_id(xcb_window_t frame);
124 
130 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
131 
136 int con_num_children(Con *con);
137 
148 void con_attach(Con *con, Con *parent, bool ignore_focus);
149 
154 void con_detach(Con *con);
155 
162 void con_fix_percent(Con *con);
163 
169 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
170 
188 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
189 
196 int con_orientation(Con *con);
197 
204 Con *con_next_focused(Con *con);
205 
211 Con *con_get_next(Con *con, char way, orientation_t orientation);
212 
220 
230 
231 /*
232  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
233  * direction is D_LEFT, then we return the rightmost container and if direction
234  * is D_RIGHT, we return the leftmost container. This is because if we are
235  * moving D_LEFT, and thus want the rightmost container.
236  */
237 Con *con_descend_direction(Con *con, direction_t direction);
238 
246 
252 
263 int con_border_style(Con *con);
264 
270 void con_set_border_style(Con *con, int border_style, int border_width);
271 
278 void con_set_layout(Con *con, layout_t layout);
279 
287 void con_toggle_layout(Con *con, const char *toggle_mode);
288 
295 
318 
323 bool con_has_urgent_child(Con *con);
324 
331 
336 void con_set_urgency(Con *con, bool urgent);
337 
342 char *con_get_tree_representation(Con *con);
343 
344 #endif
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:478
Con * con_descend_direction(Con *con, direction_t direction)
Definition: con.c:1009
void con_set_layout(Con *con, layout_t layout)
This function changes the layout of a given container.
Definition: con.c:1213
bool con_has_urgent_child(Con *con)
Checks if the given container has an urgent child.
Definition: con.c:1512
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:457
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition: con.c:576
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:1391
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:107
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:465
adjacent_t
describes if the window is adjacent to the output (physical screen) edges.
Definition: data.h:64
char * con_get_tree_representation(Con *con)
Create a string representing the subtree under con.
Definition: con.c:1593
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition: con.c:1554
void con_toggle_layout(Con *con, const char *toggle_mode)
This function toggles the layout of a given container.
Definition: con.c:1302
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition: con.c:104
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:644
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:1073
int con_num_children(Con *con)
Returns the number of children of this container.
Definition: con.c:517
A "match" is a data structure which acts like a mask or expression to match certain windows or not...
Definition: data.h:371
layout_t
Container layouts.
Definition: data.h:85
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition: con.c:402
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:308
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition: con.c:533
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:320
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:983
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:275
A 'Window' is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:313
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:1167
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:50
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:863
adjacent_t con_adjacent_borders(Con *con)
Returns adjacent borders of the window.
Definition: con.c:1119
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:452
Con * con_get_next(Con *con, char way, orientation_t orientation)
Get the next/previous container in the specified orientation.
Definition: con.c:931
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:968
bool con_is_split(Con *con)
Definition: con.c:256
bool con_is_leaf(Con *con)
Returns true when this node is a leaf node (has no children)
Definition: con.c:240
void con_focus(Con *con)
Sets input focus to the given container.
Definition: con.c:212
orientation_t
Definition: data.h:56
bool con_has_children(Con *con)
Returns true if this node has regular or floating children.
Definition: con.c:248
bool con_inside_focused(Con *con)
Checks if the given container is inside a focused container.
Definition: con.c:439
Con * con_new(Con *parent, i3Window *window)
Definition: con.c:88
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition: con.c:196
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on...
Definition: con.c:294
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition: con.c:410
Con * con_get_fullscreen_con(Con *con, int fullscreen_mode)
Returns the first fullscreen node below this node.
Definition: con.c:356
int con_border_style(Con *con)
Use this function to get a container’s border style.
Definition: con.c:1143
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition: con.c:421
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:1465
int con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition: con.c:828
direction_t
Definition: data.h:55
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:1533