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

   1 #ifndef _CON_H
   2 #define _CON_H
   3
   4 /**
   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().
   8  *
   9  */
  10 Con *con_new(Con *parent, i3Window *window);
  11
  12 /**
  13  * Sets input focus to the given container. Will be updated in X11 in the next
  14  * run of x_push_changes().
  15  *
  16  */
  17 void con_focus(Con *con);
  18
  19 /**
  20  * Returns true when this node is a leaf node (has no children)
  21  *
  22  */
  23 bool con_is_leaf(Con *con);
  24
  25 /**
  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).
  28  *
  29  */
  30 bool con_accepts_window(Con *con);
  31
  32 /**
  33  * Gets the output container (first container with CT_OUTPUT in hierarchy) this
  34  * node is on.
  35  *
  36  */
  37 Con *con_get_output(Con *con);
  38
  39 /**
  40  * Gets the workspace container this node is on.
  41  *
  42  */
  43 Con *con_get_workspace(Con *con);
  44
  45 /**
  46  * Searches parenst of the given 'con' until it reaches one with the specified
  47  * 'orientation'. Aborts when it comes across a floating_con.
  48  *
  49  */
  50 Con *con_parent_with_orientation(Con *con, orientation_t orientation);
  51
  52 /**
  53  * Returns the first fullscreen node below this node.
  54  *
  55  */
  56 Con *con_get_fullscreen_con(Con *con, int fullscreen_mode);
  57
  58 /**
  59  * Returns true if the node is floating.
  60  *
  61  */
  62 bool con_is_floating(Con *con);
  63
  64 /**
  65  * Checks if the given container is either floating or inside some floating
  66  * container. It returns the FLOATING_CON container.
  67  *
  68  */
  69 Con *con_inside_floating(Con *con);
  70
  71 /**
  72  * Checks if the given container is inside a focused container.
  73  *
  74  */
  75 bool con_inside_focused(Con *con);
  76
  77 /**
  78  * Returns the container with the given client window ID or NULL if no such
  79  * container exists.
  80  *
  81  */
  82 Con *con_by_window_id(xcb_window_t window);
  83
  84 /**
  85  * Returns the container with the given frame ID or NULL if no such container
  86  * exists.
  87  *
  88  */
  89 Con *con_by_frame_id(xcb_window_t frame);
  90
  91 /**
  92  * Returns the first container below 'con' which wants to swallow this window
  93  * TODO: priority
  94  *
  95  */
  96 Con *con_for_window(Con *con, i3Window *window, Match **store_match);
  97
  98 /**
  99  * Returns the number of children of this container.
 100  *
 101  */
 102 int con_num_children(Con *con);
 103
 104 /**
 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
 107  * tree.
 108  *
 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).
 112  *
 113  */
 114 void con_attach(Con *con, Con *parent, bool ignore_focus);
 115
 116 /**
 117  * Detaches the given container from its current parent
 118  *
 119  */
 120 void con_detach(Con *con);
 121
 122 /**
 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
 125  * container.
 126  *
 127  */
 128 void con_fix_percent(Con *con);
 129
 130 /**
 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.
 133  *
 134  */
 135 void con_toggle_fullscreen(Con *con, int fullscreen_mode);
 136
 137 /**
 138  * Moves the given container to the currently focused container on the given
 139  * workspace.
 140  *
 141  * The dont_warp flag disables pointer warping and will be set when this
 142  * function is called while dragging a floating window.
 143  *
 144  * TODO: is there a better place for this function?
 145  *
 146  */
 147 void con_move_to_workspace(Con *con, Con *workspace, bool dont_warp);
 148
 149 /**
 150  * Returns the orientation of the given container (for stacked containers,
 151  * vertical orientation is used regardless of the actual orientation of the
 152  * container).
 153  *
 154  */
 155 int con_orientation(Con *con);
 156
 157 /**
 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.
 161  *
 162  */
 163 Con *con_next_focused(Con *con);
 164
 165 /**
 166  * Get the next/previous container in the specified orientation. This may
 167  * travel up until it finds a container with suitable orientation.
 168  *
 169  */
 170 Con *con_get_next(Con *con, char way, orientation_t orientation);
 171
 172 /**
 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.
 176  *
 177  */
 178 Con *con_descend_focused(Con *con);
 179
 180 /**
 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.
 184  *
 185  * Works like con_descend_focused but considers only tiling cons.
 186  *
 187  */
 188 Con *con_descend_tiling_focused(Con *con);
 189
 190 /*
 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.
 195  */
 196 Con *con_descend_direction(Con *con, direction_t direction);
 197
 198 /**
 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).
 202  *
 203  */
 204 Rect con_border_style_rect(Con *con);
 205
 206 /**
 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
 211  * rendered.
 212  *
 213  * For children of a CT_DOCKAREA, the border style is always none.
 214  *
 215  */
 216 int con_border_style(Con *con);
 217
 218 /**
 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).
 222  *
 223  */
 224 void con_set_layout(Con *con, int layout);
 225
 226 /**
 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
 229  *
 230  */
 231 Rect con_minimum_size(Con *con);
 232
 233 #endif