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  * Returns the container with the given client window ID or NULL if no such
  59  * container exists.
  60  *
  61  */
  62 Con *con_by_window_id(xcb_window_t window);
  63
  64 /**
  65  * Returns the container with the given frame ID or NULL if no such container
  66  * exists.
  67  *
  68  */
  69 Con *con_by_frame_id(xcb_window_t frame);
  70
  71 /**
  72  * Returns the first container which wants to swallow this window
  73  * TODO: priority
  74  *
  75  */
  76 Con *con_for_window(i3Window *window, Match **store_match);
  77
  78 /**
  79  * Attaches the given container to the given parent. This happens when moving
  80  * a container or when inserting a new container at a specific place in the
  81  * tree.
  82  *
  83  */
  84 void con_attach(Con *con, Con *parent);
  85
  86 /**
  87  * Detaches the given container from its current parent
  88  *
  89  */
  90 void con_detach(Con *con);
  91
  92 /**
  93  * Updates the percent attribute of the children of the given container. This
  94  * function needs to be called when a window is added or removed from a
  95  * container.
  96  *
  97  */
  98 void con_fix_percent(Con *con, int action);
  99 enum { WINDOW_ADD = 0, WINDOW_REMOVE = 1 };
 100
 101 /**
 102  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
 103  * entered when there already is a fullscreen container on this workspace.
 104  *
 105  */
 106 void con_toggle_fullscreen(Con *con);
 107
 108 /**
 109  * Moves the given container to the currently focused container on the given
 110  * workspace.
 111  * TODO: is there a better place for this function?
 112  *
 113  */
 114 void con_move_to_workspace(Con *con, Con *workspace);
 115
 116 /**
 117  * Returns the orientation of the given container (for stacked containers,
 118  * vertical orientation is used regardless of the actual orientation of the
 119  * container).
 120  *
 121  */
 122 int con_orientation(Con *con);
 123
 124 /**
 125  * Returns the container which will be focused next when the given container
 126  * is not available anymore. Called in tree_close and con_move_to_workspace
 127  * to properly restore focus.
 128  *
 129  */
 130 Con *con_next_focused(Con *con);
 131
 132 /*
 133  * Returns a "relative" Rect which contains the amount of pixels that need to
 134  * be added to the original Rect to get the final position (obviously the
 135  * amount of pixels for normal, 1pixel and borderless are different).
 136  *
 137  */
 138 Rect con_border_style_rect(Con *con);
 139
 140 #endif