git.sur5r.net Git - i3/i3/blob - include/workspace.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * workspace.c: Modifying workspaces, accessing them, moving containers to
   8  *              workspaces.
   9  *
  10  */
  11 #ifndef I3_WORKSPACE_H
  12 #define I3_WORKSPACE_H
  13
  14 #include "data.h"
  15 #include "tree.h"
  16 #include "randr.h"
  17
  18 /**
  19  * Returns a pointer to the workspace with the given number (starting at 0),
  20  * creating the workspace if necessary (by allocating the necessary amount of
  21  * memory and initializing the data structures correctly).
  22  *
  23  * If created is not NULL, *created will be set to whether or not the
  24  * workspace has just been created.
  25  *
  26  */
  27 Con *workspace_get(const char *num, bool *created);
  28
  29 /*
  30  * Returns a pointer to a new workspace in the given output. The workspace
  31  * is created attached to the tree hierarchy through the given content
  32  * container.
  33  *
  34  */
  35 Con *create_workspace_on_output(Output *output, Con *content);
  36
  37 #if 0
  38 /**
  39  * Sets the name (or just its number) for the given workspace. This has to
  40  * be called for every workspace as the rendering function
  41  * (render_internal_bar) relies on workspace->name and workspace->name_len
  42  * being ready-to-use.
  43  *
  44  */
  45 void workspace_set_name(Workspace *ws, const char *name);
  46 #endif
  47
  48 /**
  49  * Returns true if the workspace is currently visible. Especially important for
  50  * multi-monitor environments, as they can have multiple currenlty active
  51  * workspaces.
  52  *
  53  */
  54 bool workspace_is_visible(Con *ws);
  55
  56 /**
  57  * Switches to the given workspace
  58  *
  59  */
  60 void workspace_show(Con *ws);
  61
  62 /**
  63  * Looks up the workspace by name and switches to it.
  64  *
  65  */
  66 void workspace_show_by_name(const char *num);
  67
  68 /**
  69  * Returns the next workspace.
  70  *
  71  */
  72 Con* workspace_next(void);
  73
  74 /**
  75  * Returns the previous workspace.
  76  *
  77  */
  78 Con* workspace_prev(void);
  79
  80 /**
  81  * Returns the next workspace on the same output
  82  *
  83  */
  84 Con* workspace_next_on_output(void);
  85
  86 /**
  87  * Returns the previous workspace on the same output
  88  *
  89  */
  90 Con* workspace_prev_on_output(void);
  91
  92 /**
  93  * Focuses the previously focused workspace.
  94  *
  95  */
  96 void workspace_back_and_forth(void);
  97
  98 /**
  99  * Returns the previously focused workspace con, or NULL if unavailable.
 100  *
 101  */
 102 Con *workspace_back_and_forth_get(void);
 103
 104
 105 #if 0
 106 /**
 107  * Assigns the given workspace to the given screen by correctly updating its
 108  * state and reconfiguring all the clients on this workspace.
 109  *
 110  * This is called when initializing a screen and when re-assigning it to a
 111  * different screen which just got available (if you configured it to be on
 112  * screen 1 and you just plugged in screen 1).
 113  *
 114  */
 115 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
 116
 117 /**
 118  * Initializes the given workspace if it is not already initialized. The given
 119  * screen is to be understood as a fallback, if the workspace itself either
 120  * was not assigned to a particular screen or cannot be placed there because
 121  * the screen is not attached at the moment.
 122  *
 123  */
 124 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
 125
 126 /**
 127  * Gets the first unused workspace for the given screen, taking into account
 128  * the preferred_screen setting of every workspace (workspace assignments).
 129  *
 130  */
 131 Workspace *get_first_workspace_for_output(Output *screen);
 132
 133 /**
 134  * Unmaps all clients (and stack windows) of the given workspace.
 135  *
 136  * This needs to be called separately when temporarily rendering a workspace
 137  * which is not the active workspace to force reconfiguration of all clients,
 138  * like in src/xinerama.c when re-assigning a workspace to another screen.
 139  *
 140  */
 141 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
 142
 143 /**
 144  * Maps all clients (and stack windows) of the given workspace.
 145  *
 146  */
 147 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
 148 #endif
 149
 150 /**
 151  * Goes through all clients on the given workspace and updates the workspace’s
 152  * urgent flag accordingly.
 153  *
 154  */
 155 void workspace_update_urgent_flag(Con *ws);
 156
 157 /**
 158  * 'Forces' workspace orientation by moving all cons into a new split-con with
 159  * the same orientation as the workspace and then changing the workspace
 160  * orientation.
 161  *
 162  */
 163 void ws_force_orientation(Con *ws, orientation_t orientation);
 164
 165 /**
 166  * Called when a new con (with a window, not an empty or split con) should be
 167  * attached to the workspace (for example when managing a new window or when
 168  * moving an existing window to the workspace level).
 169  *
 170  * Depending on the workspace_layout setting, this function either returns the
 171  * workspace itself (default layout) or creates a new stacked/tabbed con and
 172  * returns that.
 173  *
 174  */
 175 Con *workspace_attach_to(Con *ws);
 176
 177 #endif