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