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);
  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);
  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  * Returns the container with the given client window ID or NULL if no such
  73  * container exists.
  74  *
  75  */
  76 Con *con_by_window_id(xcb_window_t window);
  77
  78 /**
  79  * Returns the container with the given frame ID or NULL if no such container
  80  * exists.
  81  *
  82  */
  83 Con *con_by_frame_id(xcb_window_t frame);
  84
  85 /**
  86  * Returns the first container which wants to swallow this window
  87  * TODO: priority
  88  *
  89  */
  90 Con *con_for_window(i3Window *window, Match **store_match);
  91
  92 /**
  93  * Returns the number of children of this container.
  94  *
  95  */
  96 int con_num_children(Con *con);
  97
  98 /**
  99  * Attaches the given container to the given parent. This happens when moving
 100  * a container or when inserting a new container at a specific place in the
 101  * tree.
 102  *
 103  * ignore_focus is to just insert the Con at the end (useful when creating a
 104  * new split container *around* some containers, that is, detaching and
 105  * attaching them in order without wanting to mess with the focus in between).
 106  *
 107  */
 108 void con_attach(Con *con, Con *parent, bool ignore_focus);
 109
 110 /**
 111  * Detaches the given container from its current parent
 112  *
 113  */
 114 void con_detach(Con *con);
 115
 116 /**
 117  * Updates the percent attribute of the children of the given container. This
 118  * function needs to be called when a window is added or removed from a
 119  * container.
 120  *
 121  */
 122 void con_fix_percent(Con *con);
 123
 124 /**
 125  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
 126  * entered when there already is a fullscreen container on this workspace.
 127  *
 128  */
 129 void con_toggle_fullscreen(Con *con);
 130
 131 /**
 132  * Moves the given container to the currently focused container on the given
 133  * workspace.
 134  * TODO: is there a better place for this function?
 135  *
 136  */
 137 void con_move_to_workspace(Con *con, Con *workspace);
 138
 139 /**
 140  * Returns the orientation of the given container (for stacked containers,
 141  * vertical orientation is used regardless of the actual orientation of the
 142  * container).
 143  *
 144  */
 145 int con_orientation(Con *con);
 146
 147 /**
 148  * Returns the container which will be focused next when the given container
 149  * is not available anymore. Called in tree_close and con_move_to_workspace
 150  * to properly restore focus.
 151  *
 152  */
 153 Con *con_next_focused(Con *con);
 154
 155 /**
 156  * Get the next/previous container in the specified orientation. This may
 157  * travel up until it finds a container with suitable orientation.
 158  *
 159  */
 160 Con *con_get_next(Con *con, char way, orientation_t orientation);
 161
 162 /**
 163  * Returns the focused con inside this client, descending the tree as far as
 164  * possible. This comes in handy when attaching a con to a workspace at the
 165  * currently focused position, for example.
 166  *
 167  */
 168 Con *con_descend_focused(Con *con);
 169
 170 /**
 171  * Returns a "relative" Rect which contains the amount of pixels that need to
 172  * be added to the original Rect to get the final position (obviously the
 173  * amount of pixels for normal, 1pixel and borderless are different).
 174  *
 175  */
 176 Rect con_border_style_rect(Con *con);
 177
 178 /**
 179  * Use this function to get a container’s border style. This is important
 180  * because when inside a stack, the border style is always BS_NORMAL.
 181  * For tabbed mode, the same applies, with one exception: when the container is
 182  * borderless and the only element in the tabbed container, the border is not
 183  * rendered.
 184  *
 185  * For children of a CT_DOCKAREA, the border style is always none.
 186  *
 187  */
 188 int con_border_style(Con *con);
 189
 190 /**
 191  * This function changes the layout of a given container. Use it to handle
 192  * special cases like changing a whole workspace to stacked/tabbed (creates a
 193  * new split container before).
 194  *
 195  */
 196 void con_set_layout(Con *con, int layout);
 197
 198 #endif