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
  22 /* A wrapper for con_new_skeleton, to retain the old con_new behaviour
  23  *
  24  */
  25 Con *con_new(Con *parent, i3Window *window);
  26
  27 /**
  28  * Sets input focus to the given container. Will be updated in X11 in the next
  29  * run of x_push_changes().
  30  *
  31  */
  32 void con_focus(Con *con);
  33
  34 /**
  35  * Returns true when this node is a leaf node (has no children)
  36  *
  37  */
  38 bool con_is_leaf(Con *con);
  39
  40 /**
  41  * Returns true when this con is a leaf node with a managed X11 window (e.g.,
  42  * excluding dock containers)
  43  */
  44 bool con_has_managed_window(Con *con);
  45
  46 /*
  47  * Returns true if a container should be considered split.
  48  *
  49  */
  50 bool con_is_split(Con *con);
  51
  52 /**
  53  * Returns true if this node has regular or floating children.
  54  *
  55  */
  56 bool con_has_children(Con *con);
  57
  58 /**
  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).
  61  *
  62  */
  63 bool con_accepts_window(Con *con);
  64
  65 /**
  66  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
  67  * node is on.
  68  *
  69  */
  70 Con *con_get_output(Con *con);
  71
  72 /**
  73  * Gets the workspace container this node is on.
  74  *
  75  */
  76 Con *con_get_workspace(Con *con);
  77
  78 /**
  79  * Searches parenst of the given 'con' until it reaches one with the specified
  80  * 'orientation'. Aborts when it comes across a floating_con.
  81  *
  82  */
  83 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
  84
  85 /**
  86  * Returns the first fullscreen node below this node.
  87  *
  88  */
  89 Con *con_get_fullscreen_con(Con *con, fullscreen_mode_t fullscreen_mode);
  90
  91 /**
  92  * Returns true if the container is internal, such as __i3_scratch
  93  *
  94  */
  95 bool con_is_internal(Con *con);
  96
  97 /**
  98  * Returns true if the node is floating.
  99  *
 100  */
 101 bool con_is_floating(Con *con);
 102
 103 /**
 104  * Checks if the given container is either floating or inside some floating
 105  * container. It returns the FLOATING_CON container.
 106  *
 107  */
 108 Con *con_inside_floating(Con *con);
 109
 110 /**
 111  * Checks if the given container is inside a focused container.
 112  *
 113  */
 114 bool con_inside_focused(Con *con);
 115
 116 /**
 117  * Returns the container with the given client window ID or NULL if no such
 118  * container exists.
 119  *
 120  */
 121 Con *con_by_window_id(xcb_window_t window);
 122
 123 /**
 124  * Returns the container with the given frame ID or NULL if no such container
 125  * exists.
 126  *
 127  */
 128 Con *con_by_frame_id(xcb_window_t frame);
 129
 130 /**
 131  * Returns the first container below 'con' which wants to swallow this window
 132  * TODO: priority
 133  *
 134  */
 135 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
 136
 137 /**
 138  * Returns the number of children of this container.
 139  *
 140  */
 141 int con_num_children(Con *con);
 142
 143 /**
 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
 146  * tree.
 147  *
 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).
 151  *
 152  */
 153 void con_attach(Con *con, Con *parent, bool ignore_focus);
 154
 155 /**
 156  * Detaches the given container from its current parent
 157  *
 158  */
 159 void con_detach(Con *con);
 160
 161 /**
 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
 164  * container.
 165  *
 166  */
 167 void con_fix_percent(Con *con);
 168
 169 /**
 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.
 172  *
 173  */
 174 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
 175
 176 /**
 177  * Moves the given container to the currently focused container on the given
 178  * workspace.
 179  *
 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.
 186  *
 187  * The dont_warp flag disables pointer warping and will be set when this
 188  * function is called while dragging a floating window.
 189  *
 190  * TODO: is there a better place for this function?
 191  *
 192  */
 193 void con_move_to_workspace(Con *con, Con *workspace, bool fix_coordinates, bool dont_warp);
 194
 195 /**
 196  * Returns the orientation of the given container (for stacked containers,
 197  * vertical orientation is used regardless of the actual orientation of the
 198  * container).
 199  *
 200  */
 201 orientation_t con_orientation(Con *con);
 202
 203 /**
 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.
 207  *
 208  */
 209 Con *con_next_focused(Con *con);
 210
 211 /**
 212  * Get the next/previous container in the specified orientation. This may
 213  * travel up until it finds a container with suitable orientation.
 214  *
 215  */
 216 Con *con_get_next(Con *con, char way, orientation_t orientation);
 217
 218 /**
 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.
 222  *
 223  */
 224 Con *con_descend_focused(Con *con);
 225
 226 /**
 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.
 230  *
 231  * Works like con_descend_focused but considers only tiling cons.
 232  *
 233  */
 234 Con *con_descend_tiling_focused(Con *con);
 235
 236 /*
 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.
 241  */
 242 Con *con_descend_direction(Con *con, direction_t direction);
 243
 244 /**
 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).
 248  *
 249  */
 250 Rect con_border_style_rect(Con *con);
 251
 252 /**
 253  * Returns adjacent borders of the window. We need this if hide_edge_borders is
 254  * enabled.
 255  */
 256 adjacent_t con_adjacent_borders(Con *con);
 257
 258 /**
 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
 263  * rendered.
 264  *
 265  * For children of a CT_DOCKAREA, the border style is always none.
 266  *
 267  */
 268 int con_border_style(Con *con);
 269
 270 /**
 271  * Sets the given border style on con, correctly keeping the position/size of a
 272  * floating window.
 273  *
 274  */
 275 void con_set_border_style(Con *con, int border_style, int border_width);
 276
 277 /**
 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).
 281  *
 282  */
 283 void con_set_layout(Con *con, layout_t layout);
 284
 285 /**
 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
 289  * layouts).
 290  *
 291  */
 292 void con_toggle_layout(Con *con, const char *toggle_mode);
 293
 294 /**
 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
 297  *
 298  */
 299 Rect con_minimum_size(Con *con);
 300
 301 /**
 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.
 307  *
 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.
 312  *
 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.
 316  *
 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.
 320  *
 321  */
 322 bool con_fullscreen_permits_focusing(Con *con);
 323
 324 /**
 325  * Checks if the given container has an urgent child.
 326  *
 327  */
 328 bool con_has_urgent_child(Con *con);
 329
 330 /**
 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.
 333  *
 334  */
 335 void con_update_parents_urgency(Con *con);
 336
 337 /**
 338  * Set urgency flag to the container, all the parent containers and the workspace.
 339  *
 340  */
 341 void con_set_urgency(Con *con, bool urgent);
 342
 343 /**
 344  * Create a string representing the subtree under con.
 345  *
 346  */
 347 char *con_get_tree_representation(Con *con);