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