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