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 if a container should be considered split.
44 bool con_is_split(Con *con);
47 * Returns true if this node has regular or floating children.
50 bool con_has_children(Con *con);
53 * Returns true if this node accepts a window (if the node swallows windows,
54 * it might already have swallowed enough and cannot hold any more).
57 bool con_accepts_window(Con *con);
60 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
64 Con *con_get_output(Con *con);
67 * Gets the workspace container this node is on.
70 Con *con_get_workspace(Con *con);
73 * Searches parenst of the given 'con' until it reaches one with the specified
74 * 'orientation'. Aborts when it comes across a floating_con.
77 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
80 * Returns the first fullscreen node below this node.
83 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
86 * Returns true if the container is internal, such as __i3_scratch
89 bool con_is_internal(Con *con);
92 * Returns true if the node is floating.
95 bool con_is_floating(Con *con);
98 * Checks if the given container is either floating or inside some floating
99 * container. It returns the FLOATING_CON container.
102 Con *con_inside_floating(Con *con);
105 * Checks if the given container is inside a focused container.
108 bool con_inside_focused(Con *con);
111 * Returns the container with the given client window ID or NULL if no such
115 Con *con_by_window_id(xcb_window_t window);
118 * Returns the container with the given frame ID or NULL if no such container
122 Con *con_by_frame_id(xcb_window_t frame);
125 * Returns the first container below 'con' which wants to swallow this window
129 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
132 * Returns the number of children of this container.
135 int con_num_children(Con *con);
138 * Attaches the given container to the given parent. This happens when moving
139 * a container or when inserting a new container at a specific place in the
142 * ignore_focus is to just insert the Con at the end (useful when creating a
143 * new split container *around* some containers, that is, detaching and
144 * attaching them in order without wanting to mess with the focus in between).
147 void con_attach(Con *con, Con *parent, bool ignore_focus);
150 * Detaches the given container from its current parent
153 void con_detach(Con *con);
156 * Updates the percent attribute of the children of the given container. This
157 * function needs to be called when a window is added or removed from a
161 void con_fix_percent(Con *con);
164 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
165 * entered when there already is a fullscreen container on this workspace.
168 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
171 * Moves the given container to the currently focused container on the given
174 * The fix_coordinates flag will translate the current coordinates (offset from
175 * the monitor position basically) to appropriate coordinates on the
176 * destination workspace.
177 * Not enabling this behaviour comes in handy when this function gets called by
178 * floating_maybe_reassign_ws, which will only "move" a floating window when it
179 * *already* changed its coordinates to a different output.
181 * The dont_warp flag disables pointer warping and will be set when this
182 * function is called while dragging a floating window.
184 * TODO: is there a better place for this function?
187 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
190 * Returns the orientation of the given container (for stacked containers,
191 * vertical orientation is used regardless of the actual orientation of the
195 orientation_t con_orientation(Con *con);
198 * Returns the container which will be focused next when the given container
199 * is not available anymore. Called in tree_close and con_move_to_workspace
200 * to properly restore focus.
203 Con *con_next_focused(Con *con);
206 * Get the next/previous container in the specified orientation. This may
207 * travel up until it finds a container with suitable orientation.
210 Con *con_get_next(Con *con, char way, orientation_t orientation);
213 * Returns the focused con inside this client, descending the tree as far as
214 * possible. This comes in handy when attaching a con to a workspace at the
215 * currently focused position, for example.
218 Con *con_descend_focused(Con *con);
221 * Returns the focused con inside this client, descending the tree as far as
222 * possible. This comes in handy when attaching a con to a workspace at the
223 * currently focused position, for example.
225 * Works like con_descend_focused but considers only tiling cons.
228 Con *con_descend_tiling_focused(Con *con);
231 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
232 * direction is D_LEFT, then we return the rightmost container and if direction
233 * is D_RIGHT, we return the leftmost container. This is because if we are
234 * moving D_LEFT, and thus want the rightmost container.
236 Con *con_descend_direction(Con *con, direction_t direction);
239 * Returns a "relative" Rect which contains the amount of pixels that need to
240 * be added to the original Rect to get the final position (obviously the
241 * amount of pixels for normal, 1pixel and borderless are different).
244 Rect con_border_style_rect(Con *con);
247 * Returns adjacent borders of the window. We need this if hide_edge_borders is
250 adjacent_t con_adjacent_borders(Con *con);
253 * Use this function to get a container’s border style. This is important
254 * because when inside a stack, the border style is always BS_NORMAL.
255 * For tabbed mode, the same applies, with one exception: when the container is
256 * borderless and the only element in the tabbed container, the border is not
259 * For children of a CT_DOCKAREA, the border style is always none.
262 int con_border_style(Con *con);
265 * Sets the given border style on con, correctly keeping the position/size of a
269 void con_set_border_style(Con *con, int border_style, int border_width);
272 * This function changes the layout of a given container. Use it to handle
273 * special cases like changing a whole workspace to stacked/tabbed (creates a
274 * new split container before).
277 void con_set_layout(Con *con, layout_t layout);
280 * This function toggles the layout of a given container. toggle_mode can be
281 * either 'default' (toggle only between stacked/tabbed/last_split_layout),
282 * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
286 void con_toggle_layout(Con *con, const char *toggle_mode);
289 * Determines the minimum size of the given con by looking at its children (for
290 * split/stacked/tabbed cons). Will be called when resizing floating cons
293 Rect con_minimum_size(Con *con);
296 * Returns true if changing the focus to con would be allowed considering
297 * the fullscreen focus constraints. Specifically, if a fullscreen container or
298 * any of its descendants is focused, this function returns true if and only if
299 * focusing con would mean that focus would still be visible on screen, i.e.,
300 * the newly focused container would not be obscured by a fullscreen container.
302 * In the simplest case, if a fullscreen container or any of its descendants is
303 * fullscreen, this functions returns true if con is the fullscreen container
304 * itself or any of its descendants, as this means focus wouldn't escape the
305 * boundaries of the fullscreen container.
307 * In case the fullscreen container is of type CF_OUTPUT, this function returns
308 * true if con is on a different workspace, as focus wouldn't be obscured by
309 * the fullscreen container that is constrained to a different workspace.
311 * Note that this same logic can be applied to moving containers. If a
312 * container can be focused under the fullscreen focus constraints, it can also
313 * become a parent or sibling to the currently focused container.
316 bool con_fullscreen_permits_focusing(Con *con);
319 * Checks if the given container has an urgent child.
322 bool con_has_urgent_child(Con *con);
325 * Make all parent containers urgent if con is urgent or clear the urgent flag
326 * of all parent containers if there are no more urgent children left.
329 void con_update_parents_urgency(Con *con);
332 * Set urgency flag to the container, all the parent containers and the workspace.
335 void con_set_urgency(Con *con, bool urgent);
338 * Create a string representing the subtree under con.
341 char *con_get_tree_representation(Con *con);