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  * Returns the number of children of this container.
  80  *
  81  */
  82 int con_num_children(Con *con);
  83
  84 /**
  85  * Attaches the given container to the given parent. This happens when moving
  86  * a container or when inserting a new container at a specific place in the
  87  * tree.
  88  *
  89  */
  90 void con_attach(Con *con, Con *parent);
  91
  92 /**
  93  * Detaches the given container from its current parent
  94  *
  95  */
  96 void con_detach(Con *con);
  97
  98 /**
  99  * Updates the percent attribute of the children of the given container. This
 100  * function needs to be called when a window is added or removed from a
 101  * container.
 102  *
 103  */
 104 void con_fix_percent(Con *con, int action);
 105 enum { WINDOW_ADD = 0, WINDOW_REMOVE = 1 };
 106
 107 /**
 108  * Toggles fullscreen mode for the given container. Fullscreen mode will not be
 109  * entered when there already is a fullscreen container on this workspace.
 110  *
 111  */
 112 void con_toggle_fullscreen(Con *con);
 113
 114 /**
 115  * Moves the given container to the currently focused container on the given
 116  * workspace.
 117  * TODO: is there a better place for this function?
 118  *
 119  */
 120 void con_move_to_workspace(Con *con, Con *workspace);
 121
 122 /**
 123  * Returns the orientation of the given container (for stacked containers,
 124  * vertical orientation is used regardless of the actual orientation of the
 125  * container).
 126  *
 127  */
 128 int con_orientation(Con *con);
 129
 130 /**
 131  * Returns the container which will be focused next when the given container
 132  * is not available anymore. Called in tree_close and con_move_to_workspace
 133  * to properly restore focus.
 134  *
 135  */
 136 Con *con_next_focused(Con *con);
 137
 138 /*
 139  * Returns a "relative" Rect which contains the amount of pixels that need to
 140  * be added to the original Rect to get the final position (obviously the
 141  * amount of pixels for normal, 1pixel and borderless are different).
 142  *
 143  */
 144 Rect con_border_style_rect(Con *con);
 145
 146 #endif