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