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