2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * workspace.c: Modifying workspaces, accessing them, moving containers to
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
28 * Stores a copy of the name of the last used workspace for the workspace
29 * back-and-forth switching.
32 extern char *previous_workspace_name;
35 * Returns the workspace with the given name or NULL if such a workspace does
39 Con *get_existing_workspace_by_name(const char *name);
42 * Returns the workspace with the given number or NULL if such a workspace does
46 Con *get_existing_workspace_by_num(int num);
49 * Returns true if the first output assigned to a workspace with the given
50 * workspace assignment is the same as the given output.
53 bool output_triggers_assignment(Output *output, struct Workspace_Assignment *assignment);
56 * Returns a pointer to the workspace with the given number (starting at 0),
57 * creating the workspace if necessary (by allocating the necessary amount of
58 * memory and initializing the data structures correctly).
60 * If created is not NULL, *created will be set to whether or not the
61 * workspace has just been created.
64 Con *workspace_get(const char *num, bool *created);
67 * Extracts workspace names from keybindings (e.g. “web” from “bindsym $mod+1
68 * workspace web”), so that when an output needs a workspace, i3 can start with
69 * the first configured one. Needs to be called before reorder_bindings() so
70 * that the config-file order is used, not the i3-internal order.
73 void extract_workspace_names_from_bindings(void);
76 * Returns a pointer to a new workspace in the given output. The workspace
77 * is created attached to the tree hierarchy through the given content
81 Con *create_workspace_on_output(Output *output, Con *content);
84 * Returns true if the workspace is currently visible. Especially important for
85 * multi-monitor environments, as they can have multiple currenlty active
89 bool workspace_is_visible(Con *ws);
92 * Switches to the given workspace
95 void workspace_show(Con *ws);
98 * Looks up the workspace by name and switches to it.
101 void workspace_show_by_name(const char *num);
104 * Returns the next workspace.
107 Con *workspace_next(void);
110 * Returns the previous workspace.
113 Con *workspace_prev(void);
116 * Returns the next workspace on the same output
119 Con *workspace_next_on_output(void);
122 * Returns the previous workspace on the same output
125 Con *workspace_prev_on_output(void);
128 * Focuses the previously focused workspace.
131 void workspace_back_and_forth(void);
134 * Returns the previously focused workspace con, or NULL if unavailable.
137 Con *workspace_back_and_forth_get(void);
141 * Assigns the given workspace to the given screen by correctly updating its
142 * state and reconfiguring all the clients on this workspace.
144 * This is called when initializing a screen and when re-assigning it to a
145 * different screen which just got available (if you configured it to be on
146 * screen 1 and you just plugged in screen 1).
149 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
152 * Initializes the given workspace if it is not already initialized. The given
153 * screen is to be understood as a fallback, if the workspace itself either
154 * was not assigned to a particular screen or cannot be placed there because
155 * the screen is not attached at the moment.
158 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
161 * Gets the first unused workspace for the given screen, taking into account
162 * the preferred_screen setting of every workspace (workspace assignments).
165 Workspace *get_first_workspace_for_output(Output *screen);
168 * Unmaps all clients (and stack windows) of the given workspace.
170 * This needs to be called separately when temporarily rendering a workspace
171 * which is not the active workspace to force reconfiguration of all clients,
172 * like in src/xinerama.c when re-assigning a workspace to another screen.
175 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
178 * Maps all clients (and stack windows) of the given workspace.
181 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
185 * Goes through all clients on the given workspace and updates the workspace’s
186 * urgent flag accordingly.
189 void workspace_update_urgent_flag(Con *ws);
192 * 'Forces' workspace orientation by moving all cons into a new split-con with
193 * the same orientation as the workspace and then changing the workspace
197 void ws_force_orientation(Con *ws, orientation_t orientation);
200 * Called when a new con (with a window, not an empty or split con) should be
201 * attached to the workspace (for example when managing a new window or when
202 * moving an existing window to the workspace level).
204 * Depending on the workspace_layout setting, this function either returns the
205 * workspace itself (default layout) or creates a new stacked/tabbed con and
209 Con *workspace_attach_to(Con *ws);
212 * Creates a new container and re-parents all of children from the given
215 * The container inherits the layout from the workspace.
217 Con *workspace_encapsulate(Con *ws);
220 * Move the given workspace to the specified output.
223 void workspace_move_to_output(Con *ws, Output *output);