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