git.sur5r.net Git - i3/i3/blob - include/con.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 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 /**
  15  * Create a new container (and attach it to the given parent, if not NULL).
  16  * This function only initializes the data structures.
  17  *
  18  */
  19 Con *con_new_skeleton(Con *parent, i3Window *window);
  20
  21 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
  22  *
  23  */
  24 Con *con_new(Con *parent, i3Window *window);
  25
  26 /**
  27  * Sets input focus to the given container. Will be updated in X11 in the next
  28  * run of x_push_changes().
  29  *
  30  */
  31 void con_focus(Con *con);
  32
  33 /**
  34  * Returns true when this node is a leaf node (has no children)
  35  *
  36  */
  37 bool con_is_leaf(Con *con);
  38
  39 /**
  40  * Returns true when this con is a leaf node with a managed X11 window (e.g.,
  41  * excluding dock containers)
  42  */
  43 bool con_has_managed_window(Con *con);
  44
  45 /*
  46  * Returns true if a container should be considered split.
  47  *
  48  */
  49 bool con_is_split(Con *con);
  50
  51 /**
  52  * Returns true if this node has regular or floating children.
  53  *
  54  */
  55 bool con_has_children(Con *con);
  56
  57 /**
  58  * Returns true if this node accepts a window (if the node swallows windows,
  59  * it might already have swallowed enough and cannot hold any more).
  60  *
  61  */
  62 bool con_accepts_window(Con *con);
  63
  64 /**
  65  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
  66  * node is on.
  67  *
  68  */
  69 Con *con_get_output(Con *con);
  70
  71 /**
  72  * Gets the workspace container this node is on.
  73  *
  74  */
  75 Con *con_get_workspace(Con *con);
  76
  77 /**
  78  * Searches parenst of the given 'con' until it reaches one with the specified
  79  * 'orientation'. Aborts when it comes across a floating_con.
  80  *
  81  */
  82 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
  83
  84 /**
  85  * Returns the first fullscreen node below this node.
  86  *
  87  */
  88 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
  89
  90 /**
  91  * Returns true if the container is internal, such as __i3_scratch
  92  *
  93  */
  94 bool con_is_internal(Con *con);
  95
  96 /**
  97  * Returns true if the node is floating.
  98  *
  99  */
 100 bool con_is_floating(Con *con);
 101
 102 /**
 103  * Checks if the given container is either floating or inside some floating
 104  * container. It returns the FLOATING_CON container.
 105  *
 106  */
 107 Con *con_inside_floating(Con *con);
 108
 109 /**
 110  * Checks if the given container is inside a focused container.
 111  *
 112  */
 113 bool con_inside_focused(Con *con);
 114
 115 /**
 116  * Returns the container with the given client window ID or NULL if no such
 117  * container exists.
 118  *
 119  */
 120 Con *con_by_window_id(xcb_window_t window);
 121
 122 /**
 123  * Returns the container with the given frame ID or NULL if no such container
 124  * exists.
 125  *
 126  */
 127 Con *con_by_frame_id(xcb_window_t frame);
 128
 129 /**
 130  * Returns the first container below 'con' which wants to swallow this window
 131  * TODO: priority
 132  *
 133  */
 134 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
 135
 136 /**
 137  * Returns the number of children of this container.
 138  *
 139  */
 140 int con_num_children(Con *con);
 141
 142 /**
 143  * Attaches the given container to the given parent. This happens when moving
 144  * a container or when inserting a new container at a specific place in the
 145  * tree.
 146  *
 147  * ignore_focus is to just insert the Con at the end (useful when creating a
 148  * new split container *around* some containers, that is, detaching and
 149  * attaching them in order without wanting to mess with the focus in between).
 150  *
 151  */
 152 void con_attach(Con *con, Con *parent, bool ignore_focus);
 153
 154 /**
 155  * Detaches the given container from its current parent
 156  *
 157  */
 158 void con_detach(Con *con);
 159
 160 /**
 161  * Updates the percent attribute of the children of the given container. This
 162  * function needs to be called when a window is added or removed from a
 163  * container.
 164  *
 165  */
 166 void con_fix_percent(Con *con);
 167
 168 /**
 169  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
 170  * entered when there already is a fullscreen container on this workspace.
 171  *
 172  */
 173 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
 174
 175 /**
 176  * Moves the given container to the currently focused container on the given
 177  * workspace.
 178  *
 179  * The fix_coordinates flag will translate the current coordinates (offset from
 180  * the monitor position basically) to appropriate coordinates on the
 181  * destination workspace.
 182  * Not enabling this behaviour comes in handy when this function gets called by
 183  * floating_maybe_reassign_ws, which will only "move" a floating window when it
 184  * *already* changed its coordinates to a different output.
 185  *
 186  * The dont_warp flag disables pointer warping and will be set when this
 187  * function is called while dragging a floating window.
 188  *
 189  * TODO: is there a better place for this function?
 190  *
 191  */
 192 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
 193
 194 /**
 195  * Returns the orientation of the given container (for stacked containers,
 196  * vertical orientation is used regardless of the actual orientation of the
 197  * container).
 198  *
 199  */
 200 orientation_t con_orientation(Con *con);
 201
 202 /**
 203  * Returns the container which will be focused next when the given container
 204  * is not available anymore. Called in tree_close and con_move_to_workspace
 205  * to properly restore focus.
 206  *
 207  */
 208 Con *con_next_focused(Con *con);
 209
 210 /**
 211  * Get the next/previous container in the specified orientation. This may
 212  * travel up until it finds a container with suitable orientation.
 213  *
 214  */
 215 Con *con_get_next(Con *con, char way, orientation_t orientation);
 216
 217 /**
 218  * Returns the focused con inside this client, descending the tree as far as
 219  * possible. This comes in handy when attaching a con to a workspace at the
 220  * currently focused position, for example.
 221  *
 222  */
 223 Con *con_descend_focused(Con *con);
 224
 225 /**
 226  * Returns the focused con inside this client, descending the tree as far as
 227  * possible. This comes in handy when attaching a con to a workspace at the
 228  * currently focused position, for example.
 229  *
 230  * Works like con_descend_focused but considers only tiling cons.
 231  *
 232  */
 233 Con *con_descend_tiling_focused(Con *con);
 234
 235 /*
 236  * Returns the leftmost, rightmost, etc. container in sub-tree. For example, if
 237  * direction is D_LEFT, then we return the rightmost container and if direction
 238  * is D_RIGHT, we return the leftmost container.  This is because if we are
 239  * moving D_LEFT, and thus want the rightmost container.
 240  */
 241 Con *con_descend_direction(Con *con, direction_t direction);
 242
 243 /**
 244  * Returns a "relative" Rect which contains the amount of pixels that need to
 245  * be added to the original Rect to get the final position (obviously the
 246  * amount of pixels for normal, 1pixel and borderless are different).
 247  *
 248  */
 249 Rect con_border_style_rect(Con *con);
 250
 251 /**
 252  * Returns adjacent borders of the window. We need this if hide_edge_borders is
 253  * enabled.
 254  */
 255 adjacent_t con_adjacent_borders(Con *con);
 256
 257 /**
 258  * Use this function to get a container’s border style. This is important
 259  * because when inside a stack, the border style is always BS_NORMAL.
 260  * For tabbed mode, the same applies, with one exception: when the container is
 261  * borderless and the only element in the tabbed container, the border is not
 262  * rendered.
 263  *
 264  * For children of a CT_DOCKAREA, the border style is always none.
 265  *
 266  */
 267 int con_border_style(Con *con);
 268
 269 /**
 270  * Sets the given border style on con, correctly keeping the position/size of a
 271  * floating window.
 272  *
 273  */
 274 void con_set_border_style(Con *con, int border_style, int border_width);
 275
 276 /**
 277  * This function changes the layout of a given container. Use it to handle
 278  * special cases like changing a whole workspace to stacked/tabbed (creates a
 279  * new split container before).
 280  *
 281  */
 282 void con_set_layout(Con *con, layout_t layout);
 283
 284 /**
 285  * This function toggles the layout of a given container. toggle_mode can be
 286  * either 'default' (toggle only between stacked/tabbed/last_split_layout),
 287  * 'split' (toggle only between splitv/splith) or 'all' (toggle between all
 288  * layouts).
 289  *
 290  */
 291 void con_toggle_layout(Con *con, const char *toggle_mode);
 292
 293 /**
 294  * Determines the minimum size of the given con by looking at its children (for
 295  * split/stacked/tabbed cons). Will be called when resizing floating cons
 296  *
 297  */
 298 Rect con_minimum_size(Con *con);
 299
 300 /**
 301  * Returns true if changing the focus to con would be allowed considering
 302  * the fullscreen focus constraints. Specifically, if a fullscreen container or
 303  * any of its descendants is focused, this function returns true if and only if
 304  * focusing con would mean that focus would still be visible on screen, i.e.,
 305  * the newly focused container would not be obscured by a fullscreen container.
 306  *
 307  * In the simplest case, if a fullscreen container or any of its descendants is
 308  * fullscreen, this functions returns true if con is the fullscreen container
 309  * itself or any of its descendants, as this means focus wouldn't escape the
 310  * boundaries of the fullscreen container.
 311  *
 312  * In case the fullscreen container is of type CF_OUTPUT, this function returns
 313  * true if con is on a different workspace, as focus wouldn't be obscured by
 314  * the fullscreen container that is constrained to a different workspace.
 315  *
 316  * Note that this same logic can be applied to moving containers. If a
 317  * container can be focused under the fullscreen focus constraints, it can also
 318  * become a parent or sibling to the currently focused container.
 319  *
 320  */
 321 bool con_fullscreen_permits_focusing(Con *con);
 322
 323 /**
 324  * Checks if the given container has an urgent child.
 325  *
 326  */
 327 bool con_has_urgent_child(Con *con);
 328
 329 /**
 330  * Make all parent containers urgent if con is urgent or clear the urgent flag
 331  * of all parent containers if there are no more urgent children left.
 332  *
 333  */
 334 void con_update_parents_urgency(Con *con);
 335
 336 /**
 337  * Set urgency flag to the container, all the parent containers and the workspace.
 338  *
 339  */
 340 void con_set_urgency(Con *con, bool urgent);
 341
 342 /**
 343  * Create a string representing the subtree under con.
 344  *
 345  */
 346 char *con_get_tree_representation(Con *con);