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,
15 * Create a new container (and attach it to the given parent, if not NULL).
16 * This function only initializes the data structures.
19 Con *con_new_skeleton(Con *parent, i3Window *window);
22 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
25 Con *con_new(Con *parent, i3Window *window);
28 * Sets input focus to the given container. Will be updated in X11 in the next
29 * run of x_push_changes().
32 void con_focus(Con *con);
35 * Returns true when this node is a leaf node (has no children)
38 bool con_is_leaf(Con *con);
41 * Returns true when this con is a leaf node with a managed X11 window (e.g.,
42 * excluding dock containers)
44 bool con_has_managed_window(Con *con);
47 * Returns true if a container should be considered split.
50 bool con_is_split(Con *con);
53 * Returns true if this node has regular or floating children.
56 bool con_has_children(Con *con);
59 * Returns true if this node accepts a window (if the node swallows windows,
60 * it might already have swallowed enough and cannot hold any more).
63 bool con_accepts_window(Con *con);
66 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
70 Con *con_get_output(Con *con);
73 * Gets the workspace container this node is on.
76 Con *con_get_workspace(Con *con);
79 * Searches parenst of the given 'con' until it reaches one with the specified
80 * 'orientation'. Aborts when it comes across a floating_con.
83 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
86 * Returns the first fullscreen node below this node.
89 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
92 * Returns true if the container is internal, such as __i3_scratch
95 bool con_is_internal(Con *con);
98 * Returns true if the node is floating.
101 bool con_is_floating(Con *con);
104 * Checks if the given container is either floating or inside some floating
105 * container. It returns the FLOATING_CON container.
108 Con *con_inside_floating(Con *con);
111 * Checks if the given container is inside a focused container.
114 bool con_inside_focused(Con *con);
117 * Returns the container with the given client window ID or NULL if no such
121 Con *con_by_window_id(xcb_window_t window);
124 * Returns the container with the given frame ID or NULL if no such container
128 Con *con_by_frame_id(xcb_window_t frame);
131 * Returns the first container below 'con' which wants to swallow this window
135 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
138 * Returns the number of children of this container.
141 int con_num_children(Con *con);
144 * Attaches the given container to the given parent. This happens when moving
145 * a container or when inserting a new container at a specific place in the
148 * ignore_focus is to just insert the Con at the end (useful when creating a
149 * new split container *around* some containers, that is, detaching and
150 * attaching them in order without wanting to mess with the focus in between).
153 void con_attach(Con *con, Con *parent, bool ignore_focus);
156 * Detaches the given container from its current parent
159 void con_detach(Con *con);
162 * Updates the percent attribute of the children of the given container. This
163 * function needs to be called when a window is added or removed from a
167 void con_fix_percent(Con *con);
170 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
171 * entered when there already is a fullscreen container on this workspace.
174 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
177 * Moves the given container to the currently focused container on the given
180 * The fix_coordinates flag will translate the current coordinates (offset from
181 * the monitor position basically) to appropriate coordinates on the
182 * destination workspace.
183 * Not enabling this behaviour comes in handy when this function gets called by
184 * floating_maybe_reassign_ws, which will only "move" a floating window when it
185 * *already* changed its coordinates to a different output.
187 * The dont_warp flag disables pointer warping and will be set when this
188 * function is called while dragging a floating window.
190 * TODO: is there a better place for this function?
193 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
196 * Returns the orientation of the given container (for stacked containers,
197 * vertical orientation is used regardless of the actual orientation of the
201 orientation_t con_orientation(Con *con);
204 * Returns the container which will be focused next when the given container
205 * is not available anymore. Called in tree_close and con_move_to_workspace
206 * to properly restore focus.
209 Con *con_next_focused(Con *con);
212 * Get the next/previous container in the specified orientation. This may
213 * travel up until it finds a container with suitable orientation.
216 Con *con_get_next(Con *con, char way, orientation_t orientation);
219 * Returns the focused con inside this client, descending the tree as far as
220 * possible. This comes in handy when attaching a con to a workspace at the
221 * currently focused position, for example.
224 Con *con_descend_focused(Con *con);
227 * Returns the focused con inside this client, descending the tree as far as
228 * possible. This comes in handy when attaching a con to a workspace at the
229 * currently focused position, for example.
231 * Works like con_descend_focused but considers only tiling cons.
234 Con *con_descend_tiling_focused(Con *con);
237 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
238 * direction is D_LEFT, then we return the rightmost container and if direction
239 * is D_RIGHT, we return the leftmost container. This is because if we are
240 * moving D_LEFT, and thus want the rightmost container.
242 Con *con_descend_direction(Con *con, direction_t direction);
245 * Returns a "relative" Rect which contains the amount of pixels that need to
246 * be added to the original Rect to get the final position (obviously the
247 * amount of pixels for normal, 1pixel and borderless are different).
250 Rect con_border_style_rect(Con *con);
253 * Returns adjacent borders of the window. We need this if hide_edge_borders is
256 adjacent_t con_adjacent_borders(Con *con);
259 * Use this function to get a container’s border style. This is important
260 * because when inside a stack, the border style is always BS_NORMAL.
261 * For tabbed mode, the same applies, with one exception: when the container is
262 * borderless and the only element in the tabbed container, the border is not
265 * For children of a CT_DOCKAREA, the border style is always none.
268 int con_border_style(Con *con);
271 * Sets the given border style on con, correctly keeping the position/size of a
275 void con_set_border_style(Con *con, int border_style, int border_width);
278 * This function changes the layout of a given container. Use it to handle
279 * special cases like changing a whole workspace to stacked/tabbed (creates a
280 * new split container before).
283 void con_set_layout(Con *con, layout_t layout);
286 * This function toggles the layout of a given container. toggle_mode can be
287 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
288 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
292 void con_toggle_layout(Con *con, const char *toggle_mode);
295 * Determines the minimum size of the given con by looking at its children (for
296 * split/stacked/tabbed cons). Will be called when resizing floating cons
299 Rect con_minimum_size(Con *con);
302 * Returns true if changing the focus to con would be allowed considering
303 * the fullscreen focus constraints. Specifically, if a fullscreen container or
304 * any of its descendants is focused, this function returns true if and only if
305 * focusing con would mean that focus would still be visible on screen, i.e.,
306 * the newly focused container would not be obscured by a fullscreen container.
308 * In the simplest case, if a fullscreen container or any of its descendants is
309 * fullscreen, this functions returns true if con is the fullscreen container
310 * itself or any of its descendants, as this means focus wouldn't escape the
311 * boundaries of the fullscreen container.
313 * In case the fullscreen container is of type CF_OUTPUT, this function returns
314 * true if con is on a different workspace, as focus wouldn't be obscured by
315 * the fullscreen container that is constrained to a different workspace.
317 * Note that this same logic can be applied to moving containers. If a
318 * container can be focused under the fullscreen focus constraints, it can also
319 * become a parent or sibling to the currently focused container.
322 bool con_fullscreen_permits_focusing(Con *con);
325 * Checks if the given container has an urgent child.
328 bool con_has_urgent_child(Con *con);
331 * Make all parent containers urgent if con is urgent or clear the urgent flag
332 * of all parent containers if there are no more urgent children left.
335 void con_update_parents_urgency(Con *con);
338 * Set urgency flag to the container, all the parent containers and the workspace.
341 void con_set_urgency(Con *con, bool urgent);
344 * Create a string representing the subtree under con.
347 char *con_get_tree_representation(Con *con);