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