2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 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,
16 * Create a new container (and attach it to the given parent, if not NULL).
17 * This function initializes the data structures and creates the appropriate
18 * X11 IDs using x_con_init().
21 Con *con_new(Con *parent, i3Window *window);
24 * Sets input focus to the given container. Will be updated in X11 in the next
25 * run of x_push_changes().
28 void con_focus(Con *con);
31 * Returns true when this node is a leaf node (has no children)
34 bool con_is_leaf(Con *con);
37 * Returns true if this node accepts a window (if the node swallows windows,
38 * it might already have swallowed enough and cannot hold any more).
41 bool con_accepts_window(Con *con);
44 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
48 Con *con_get_output(Con *con);
51 * Gets the workspace container this node is on.
54 Con *con_get_workspace(Con *con);
57 * Searches parenst of the given 'con' until it reaches one with the specified
58 * 'orientation'. Aborts when it comes across a floating_con.
61 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
64 * Returns the first fullscreen node below this node.
67 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode);
70 * Returns true if the container is internal, such as __i3_scratch
73 bool con_is_internal(Con *con);
76 * Returns true if the node is floating.
79 bool con_is_floating(Con *con);
82 * Checks if the given container is either floating or inside some floating
83 * container. It returns the FLOATING_CON container.
86 Con *con_inside_floating(Con *con);
89 * Checks if the given container is inside a focused container.
92 bool con_inside_focused(Con *con);
95 * Returns the container with the given client window ID or NULL if no such
99 Con *con_by_window_id(xcb_window_t window);
102 * Returns the container with the given frame ID or NULL if no such container
106 Con *con_by_frame_id(xcb_window_t frame);
109 * Returns the first container below 'con' which wants to swallow this window
113 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
116 * Returns the number of children of this container.
119 int con_num_children(Con *con);
122 * Attaches the given container to the given parent. This happens when moving
123 * a container or when inserting a new container at a specific place in the
126 * ignore_focus is to just insert the Con at the end (useful when creating a
127 * new split container *around* some containers, that is, detaching and
128 * attaching them in order without wanting to mess with the focus in between).
131 void con_attach(Con *con, Con *parent, bool ignore_focus);
134 * Detaches the given container from its current parent
137 void con_detach(Con *con);
140 * Updates the percent attribute of the children of the given container. This
141 * function needs to be called when a window is added or removed from a
145 void con_fix_percent(Con *con);
148 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
149 * entered when there already is a fullscreen container on this workspace.
152 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
155 * Moves the given container to the currently focused container on the given
158 * The fix_coordinates flag will translate the current coordinates (offset from
159 * the monitor position basically) to appropriate coordinates on the
160 * destination workspace.
161 * Not enabling this behaviour comes in handy when this function gets called by
162 * floating_maybe_reassign_ws, which will only "move" a floating window when it
163 * *already* changed its coordinates to a different output.
165 * The dont_warp flag disables pointer warping and will be set when this
166 * function is called while dragging a floating window.
168 * TODO: is there a better place for this function?
171 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
174 * Returns the orientation of the given container (for stacked containers,
175 * vertical orientation is used regardless of the actual orientation of the
179 int con_orientation(Con *con);
182 * Returns the container which will be focused next when the given container
183 * is not available anymore. Called in tree_close and con_move_to_workspace
184 * to properly restore focus.
187 Con *con_next_focused(Con *con);
190 * Get the next/previous container in the specified orientation. This may
191 * travel up until it finds a container with suitable orientation.
194 Con *con_get_next(Con *con, char way, orientation_t orientation);
197 * Returns the focused con inside this client, descending the tree as far as
198 * possible. This comes in handy when attaching a con to a workspace at the
199 * currently focused position, for example.
202 Con *con_descend_focused(Con *con);
205 * Returns the focused con inside this client, descending the tree as far as
206 * possible. This comes in handy when attaching a con to a workspace at the
207 * currently focused position, for example.
209 * Works like con_descend_focused but considers only tiling cons.
212 Con *con_descend_tiling_focused(Con *con);
215 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
216 * direction is D_LEFT, then we return the rightmost container and if direction
217 * is D_RIGHT, we return the leftmost container. This is because if we are
218 * moving D_LEFT, and thus want the rightmost container.
220 Con *con_descend_direction(Con *con, direction_t direction);
223 * Returns a "relative" Rect which contains the amount of pixels that need to
224 * be added to the original Rect to get the final position (obviously the
225 * amount of pixels for normal, 1pixel and borderless are different).
228 Rect con_border_style_rect(Con *con);
231 * Returns adjacent borders of the window. We need this if hide_edge_borders is
234 adjacent_t con_adjacent_borders(Con *con);
237 * Use this function to get a container’s border style. This is important
238 * because when inside a stack, the border style is always BS_NORMAL.
239 * For tabbed mode, the same applies, with one exception: when the container is
240 * borderless and the only element in the tabbed container, the border is not
243 * For children of a CT_DOCKAREA, the border style is always none.
246 int con_border_style(Con *con);
249 * Sets the given border style on con, correctly keeping the position/size of a
253 void con_set_border_style(Con *con, int border_style, int border_width);
256 * This function changes the layout of a given container. Use it to handle
257 * special cases like changing a whole workspace to stacked/tabbed (creates a
258 * new split container before).
261 void con_set_layout(Con *con, int layout);
264 * This function toggles the layout of a given container. toggle_mode can be
265 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
266 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
270 void con_toggle_layout(Con *con, const char *toggle_mode);
273 * Determines the minimum size of the given con by looking at its children (for
274 * split/stacked/tabbed cons). Will be called when resizing floating cons
277 Rect con_minimum_size(Con *con);
280 * Returns true if changing the focus to con would be allowed considering
281 * the fullscreen focus constraints. Specifically, if a fullscreen container or
282 * any of its descendants is focused, this function returns true if and only if
283 * focusing con would mean that focus would still be visible on screen, i.e.,
284 * the newly focused container would not be obscured by a fullscreen container.
286 * In the simplest case, if a fullscreen container or any of its descendants is
287 * fullscreen, this functions returns true if con is the fullscreen container
288 * itself or any of its descendants, as this means focus wouldn't escape the
289 * boundaries of the fullscreen container.
291 * In case the fullscreen container is of type CF_OUTPUT, this function returns
292 * true if con is on a different workspace, as focus wouldn't be obscured by
293 * the fullscreen container that is constrained to a different workspace.
295 * Note that this same logic can be applied to moving containers. If a
296 * container can be focused under the fullscreen focus constraints, it can also
297 * become a parent or sibling to the currently focused container.
300 bool con_fullscreen_permits_focusing(Con *con);
303 * Checks if the given container has an urgent child.
306 bool con_has_urgent_child(Con *con);
309 * Make all parent containers urgent if con is urgent or clear the urgent flag
310 * of all parent containers if there are no more urgent children left.
313 void con_update_parents_urgency(Con *con);
316 * Create a string representing the subtree under con.
319 char *con_get_tree_representation(Con *con);