5 * Create a new container (and attach it to the given parent, if not NULL).
6 * This function initializes the data structures and creates the appropriate
7 * X11 IDs using x_con_init().
10 Con *con_new(Con *parent, i3Window *window);
13 * Sets input focus to the given container. Will be updated in X11 in the next
14 * run of x_push_changes().
17 void con_focus(Con *con);
20 * Returns true when this node is a leaf node (has no children)
23 bool con_is_leaf(Con *con);
26 * Returns true if this node accepts a window (if the node swallows windows,
27 * it might already have swallowed enough and cannot hold any more).
30 bool con_accepts_window(Con *con);
33 * Gets the output container (first container with CT_OUTPUT in hierarchy) this
37 Con *con_get_output(Con *con);
40 * Gets the workspace container this node is on.
43 Con *con_get_workspace(Con *con);
46 * Searches parenst of the given 'con' until it reaches one with the specified
47 * 'orientation'. Aborts when it comes across a floating_con.
50 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
53 * Returns the first fullscreen node below this node.
56 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode);
59 * Returns true if the node is floating.
62 bool con_is_floating(Con *con);
65 * Checks if the given container is either floating or inside some floating
66 * container. It returns the FLOATING_CON container.
69 Con *con_inside_floating(Con *con);
72 * Checks if the given container is inside a focused container.
75 bool con_inside_focused(Con *con);
78 * Returns the container with the given client window ID or NULL if no such
82 Con *con_by_window_id(xcb_window_t window);
85 * Returns the container with the given frame ID or NULL if no such container
89 Con *con_by_frame_id(xcb_window_t frame);
92 * Returns the first container below 'con' which wants to swallow this window
96 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
99 * Returns the number of children of this container.
102 int con_num_children(Con *con);
105 * Attaches the given container to the given parent. This happens when moving
106 * a container or when inserting a new container at a specific place in the
109 * ignore_focus is to just insert the Con at the end (useful when creating a
110 * new split container *around* some containers, that is, detaching and
111 * attaching them in order without wanting to mess with the focus in between).
114 void con_attach(Con *con, Con *parent, bool ignore_focus);
117 * Detaches the given container from its current parent
120 void con_detach(Con *con);
123 * Updates the percent attribute of the children of the given container. This
124 * function needs to be called when a window is added or removed from a
128 void con_fix_percent(Con *con);
131 * Toggles fullscreen mode for the given container. Fullscreen mode will not be
132 * entered when there already is a fullscreen container on this workspace.
135 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
138 * Moves the given container to the currently focused container on the given
141 * The dont_warp flag disables pointer warping and will be set when this
142 * function is called while dragging a floating window.
144 * TODO: is there a better place for this function?
147 void con_move_to_workspace(Con *con, Con *workspace, bool dont_warp);
150 * Returns the orientation of the given container (for stacked containers,
151 * vertical orientation is used regardless of the actual orientation of the
155 int con_orientation(Con *con);
158 * Returns the container which will be focused next when the given container
159 * is not available anymore. Called in tree_close and con_move_to_workspace
160 * to properly restore focus.
163 Con *con_next_focused(Con *con);
166 * Get the next/previous container in the specified orientation. This may
167 * travel up until it finds a container with suitable orientation.
170 Con *con_get_next(Con *con, char way, orientation_t orientation);
173 * Returns the focused con inside this client, descending the tree as far as
174 * possible. This comes in handy when attaching a con to a workspace at the
175 * currently focused position, for example.
178 Con *con_descend_focused(Con *con);
181 * Returns the focused con inside this client, descending the tree as far as
182 * possible. This comes in handy when attaching a con to a workspace at the
183 * currently focused position, for example.
185 * Works like con_descend_focused but considers only tiling cons.
188 Con *con_descend_tiling_focused(Con *con);
191 * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
192 * direction is D_LEFT, then we return the rightmost container and if direction
193 * is D_RIGHT, we return the leftmost container. This is because if we are
194 * moving D_LEFT, and thus want the rightmost container.
196 Con *con_descend_direction(Con *con, direction_t direction);
199 * Returns a "relative" Rect which contains the amount of pixels that need to
200 * be added to the original Rect to get the final position (obviously the
201 * amount of pixels for normal, 1pixel and borderless are different).
204 Rect con_border_style_rect(Con *con);
207 * Use this function to get a container’s border style. This is important
208 * because when inside a stack, the border style is always BS_NORMAL.
209 * For tabbed mode, the same applies, with one exception: when the container is
210 * borderless and the only element in the tabbed container, the border is not
213 * For children of a CT_DOCKAREA, the border style is always none.
216 int con_border_style(Con *con);
219 * This function changes the layout of a given container. Use it to handle
220 * special cases like changing a whole workspace to stacked/tabbed (creates a
221 * new split container before).
224 void con_set_layout(Con *con, int layout);
227 * Determines the minimum size of the given con by looking at its children (for
228 * split/stacked/tabbed cons). Will be called when resizing floating cons
231 Rect con_minimum_size(Con *con);