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 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 
21 Con *con_new_skeleton(Con *parent, i3Window *window);
22 
27 Con *con_new(Con *parent, i3Window *window);
28 
33 void con_free(Con *con);
34 
40 void con_focus(Con *con);
41 
46 void con_activate(Con *con);
47 
52 void con_close(Con *con, kill_window_t kill_window);
53 
58 bool con_is_leaf(Con *con);
59 
64 bool con_has_managed_window(Con *con);
65 
70 bool con_is_split(Con *con);
71 
77 bool con_is_hidden(Con *con);
78 
83 bool con_is_sticky(Con *con);
84 
89 bool con_has_children(Con *con);
90 
96 bool con_accepts_window(Con *con);
97 
103 Con *con_get_output(Con *con);
104 
109 Con *con_get_workspace(Con *con);
110 
117 
122 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
123 
131 
136 bool con_is_internal(Con *con);
137 
142 bool con_is_floating(Con *con);
143 
148 bool con_is_docked(Con *con);
149 
156 
161 bool con_inside_focused(Con *con);
162 
167 bool con_has_parent(Con *con, Con *parent);
168 
174 Con *con_by_window_id(xcb_window_t window);
175 
181 Con *con_by_con_id(long target);
182 
188 bool con_exists(Con *con);
189 
195 Con *con_by_frame_id(xcb_window_t frame);
196 
202 Con *con_by_mark(const char *mark);
203 
208 bool con_has_mark(Con *con, const char *mark);
209 
216 void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode);
217 
222 void con_mark(Con *con, const char *mark, mark_mode_t mode);
223 
231 void con_unmark(Con *con, const char *name);
232 
238 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
239 
245 Con **get_focus_order(Con *con);
246 
254 void set_focus_order(Con *con, Con **focus_order);
255 
260 int con_num_children(Con *con);
261 
267 int con_num_visible_children(Con *con);
268 
273 int con_num_windows(Con *con);
274 
285 void con_attach(Con *con, Con *parent, bool ignore_focus);
286 
291 void con_detach(Con *con);
292 
299 void con_fix_percent(Con *con);
300 
306 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
307 
312 void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode);
313 
318 void con_disable_fullscreen(Con *con);
319 
340 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates,
341  bool dont_warp, bool ignore_focus);
342 
348 void con_move_to_output(Con *con, Output *output, bool fix_coordinates);
349 
357 bool con_move_to_output_name(Con *con, const char *name, bool fix_coordinates);
358 
363 bool con_move_to_mark(Con *con, const char *mark);
364 
372 
379 Con *con_next_focused(Con *con);
380 
388 
398 
405 Con *con_descend_direction(Con *con, direction_t direction);
406 
414 
420 
431 int con_border_style(Con *con);
432 
438 void con_set_border_style(Con *con, int border_style, int border_width);
439 
446 void con_set_layout(Con *con, layout_t layout);
447 
455 void con_toggle_layout(Con *con, const char *toggle_mode);
456 
463 
486 
491 bool con_has_urgent_child(Con *con);
492 
499 
504 void con_set_urgency(Con *con, bool urgent);
505 
510 char *con_get_tree_representation(Con *con);
511 
517 
523 
528 bool con_swap(Con *first, Con *second);
529 
535 uint32_t con_rect_size_in_orientation(Con *con);
Con * con_inside_floating(Con *con)
Checks if the given container is either floating or inside some floating container.
Definition: con.c:564
void con_disable_fullscreen(Con *con)
Disables fullscreen mode for the given container, if necessary.
Definition: con.c:1098
int con_num_windows(Con *con)
Count the number of windows (i.e., leaf containers).
Definition: con.c:924
Con * con_by_mark(const char *mark)
Returns the container with the given mark or NULL if no such container exists.
Definition: con.c:663
void con_focus(Con *con)
Sets input focus to the given container.
Definition: con.c:222
int con_num_children(Con *con)
Returns the number of children of this container.
Definition: con.c:887
Con * con_parent_with_orientation(Con *con, orientation_t orientation)
Searches parents of the given &#39;con&#39; until it reaches one with the specified &#39;orientation&#39;.
Definition: con.c:430
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:1400
Con * con_descend_tiling_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1506
void con_set_urgency(Con *con, bool urgent)
Set urgency flag to the container, all the parent containers and the workspace.
Definition: con.c:2133
void con_toggle_fullscreen(Con *con, int fullscreen_mode)
Toggles fullscreen mode for the given container.
Definition: con.c:998
adjacent_t con_adjacent_borders(Con *con)
Returns adjacent borders of the window.
Definition: con.c:1649
void con_activate(Con *con)
Sets input focus to the given container and raises it to the top.
Definition: con.c:263
bool con_inside_focused(Con *con)
Checks if the given container is inside a focused container.
Definition: con.c:582
void con_close(Con *con, kill_window_t kill_window)
Closes the given container.
Definition: con.c:272
bool con_swap(Con *first, Con *second)
Swaps the two containers.
Definition: con.c:2281
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:612
fullscreen_mode_t
Fullscreen modes.
Definition: data.h:598
void set_focus_order(Con *con, Con **focus_order)
Clear the container&#39;s focus stack and re-add it using the provided container array.
Definition: con.c:863
orientation_t con_orientation(Con *con)
Returns the orientation of the given container (for stacked containers, vertical orientation is used ...
Definition: con.c:1418
layout_t
Container layouts.
Definition: data.h:91
bool con_has_mark(Con *con, const char *mark)
Returns true if and only if the given containers holds the mark.
Definition: con.c:677
void con_mark_toggle(Con *con, const char *mark, mark_mode_t mode)
Toggles the mark on a container.
Definition: con.c:693
void con_free(Con *con)
Frees the specified container.
Definition: con.c:79
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:1598
Stores a rectangle, for example the size of a window, the child window etc.
Definition: data.h:157
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:310
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:625
A &#39;Window&#39; is a type which contains an xcb_window_t and all the related information (hints like _NET_...
Definition: data.h:410
Con * con_for_window(Con *con, i3Window *window, Match **store_match)
Returns the first container below &#39;con&#39; which wants to swallow this window TODO: priority.
Definition: con.c:792
int con_num_visible_children(Con *con)
Returns the number of visible non-floating children of this container.
Definition: con.c:902
Con * con_descend_focused(Con *con)
Returns the focused con inside this client, descending the tree as far as possible.
Definition: con.c:1491
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:2044
bool con_is_sticky(Con *con)
Returns whether the container or any of its children is sticky.
Definition: con.c:367
A &#39;Con&#39; represents everything from the X11 root window down to a single X11 window.
Definition: data.h:613
void con_fix_percent(Con *con)
Updates the percent attribute of the children of the given container.
Definition: con.c:950
void con_unmark(Con *con, const char *name)
Removes marks from containers.
Definition: con.c:738
kill_window_t
parameter to specify whether tree_close_internal() and x_window_kill() should kill only this specific...
Definition: data.h:68
orientation_t
Definition: data.h:59
Con * con_descend_direction(Con *con, direction_t direction)
Returns the leftmost, rightmost, etc.
Definition: con.c:1532
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:39
void con_enable_fullscreen(Con *con, fullscreen_mode_t fullscreen_mode)
Enables fullscreen mode for the given container, if necessary.
Definition: con.c:1052
void con_attach(Con *con, Con *parent, bool ignore_focus)
Attaches the given container to the given parent.
Definition: con.c:198
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:1701
char * con_get_tree_representation(Con *con)
Create a string representing the subtree under con.
Definition: con.c:2174
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:2105
uint32_t con_rect_size_in_orientation(Con *con)
Returns given container&#39;s rect size depending on its orientation.
Definition: con.c:2401
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:1385
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:1449
void con_detach(Con *con)
Detaches the given container from its current parent.
Definition: con.c:206
int con_border_style(Con *con)
Use this function to get a container’s border style.
Definition: con.c:1678
struct _i3String i3String
Opaque data structure for storing strings.
Definition: libi3.h:48
An Output is a physical output on your graphics driver.
Definition: data.h:375
bool con_has_urgent_child(Con *con)
Checks if the given container has an urgent child.
Definition: con.c:2084
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:1367
Con * con_get_workspace(Con *con)
Gets the workspace container this node is on.
Definition: con.c:418
Con * con_get_output(Con *con)
Gets the output container (first container with CT_OUTPUT in hierarchy) this node is on...
Definition: con.c:404
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:345
void con_force_split_parents_redraw(Con *con)
force parent split containers to be redrawn
Definition: con.c:22
bool con_is_docked(Con *con)
Returns true if the container is a docked container.
Definition: con.c:549
bool con_has_parent(Con *con, Con *parent)
Checks if the container has the given parent as an actual parent.
Definition: con.c:594
i3String * con_parse_title_format(Con *con)
Returns the window title considering the current title format.
Definition: con.c:2237
A "match" is a data structure which acts like a mask or expression to match certain windows or not...
Definition: data.h:502
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:650
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:385
void con_mark(Con *con, const char *mark, mark_mode_t mode)
Assigns a mark to the container.
Definition: con.c:708
Con * con_get_fullscreen_covering_ws(Con *ws)
Returns the fullscreen node that covers the given workspace if it exists.
Definition: con.c:517
bool con_is_split(Con *con)
Returns true if a container should be considered split.
Definition: con.c:326
bool con_move_to_mark(Con *con, const char *mark)
Moves the given container to the given mark.
Definition: con.c:1311
direction_t
Definition: data.h:55
bool con_has_children(Con *con)
Returns true if this node has regular or floating children.
Definition: con.c:318
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:1970
bool con_exists(Con *con)
Returns true if the given container (still) exists.
Definition: con.c:641
void con_set_layout(Con *con, layout_t layout)
This function changes the layout of a given container.
Definition: con.c:1743
Con * con_new(Con *parent, i3Window *window)
A wrapper for con_new_skeleton, to retain the old con_new behaviour.
Definition: con.c:69
bool con_is_floating(Con *con)
Returns true if the node is floating.
Definition: con.c:540
bool con_is_internal(Con *con)
Returns true if the container is internal, such as __i3_scratch.
Definition: con.c:532
Con * con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode)
Returns the first fullscreen node below this node.
Definition: con.c:467
void con_toggle_layout(Con *con, const char *toggle_mode)
This function toggles the layout of a given container.
Definition: con.c:1828
bool con_is_leaf(Con *con)
Returns true when this node is a leaf node (has no children)
Definition: con.c:302
mark_mode_t
Definition: data.h:85
Con ** get_focus_order(Con *con)
Iterate over the container&#39;s focus stack and return an array with the containers inside it...
Definition: con.c:843
adjacent_t
describes if the window is adjacent to the output (physical screen) edges.
Definition: data.h:73