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