2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
7 * workspace.c: Modifying workspaces, accessing them, moving containers to
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).
22 * If created is not NULL, *created will be set to whether or not the
23 * workspace has just been created.
26 Con *workspace_get(const char *num, bool *created);
29 * Returns a pointer to a new workspace in the given output. The workspace
30 * is created attached to the tree hierarchy through the given content
34 Con *create_workspace_on_output(Output *output, Con *content);
38 * Sets the name (or just its number) for the given workspace. This has to
39 * be called for every workspace as the rendering function
40 * (render_internal_bar) relies on workspace->name and workspace->name_len
44 void workspace_set_name(Workspace *ws, const char *name);
48 * Returns true if the workspace is currently visible. Especially important for
49 * multi-monitor environments, as they can have multiple currenlty active
53 bool workspace_is_visible(Con *ws);
56 * Switches to the given workspace
59 void workspace_show(Con *ws);
62 * Looks up the workspace by name and switches to it.
65 void workspace_show_by_name(const char *num);
68 * Returns the next workspace.
71 Con *workspace_next(void);
74 * Returns the previous workspace.
77 Con *workspace_prev(void);
80 * Returns the next workspace on the same output
83 Con *workspace_next_on_output(void);
86 * Returns the previous workspace on the same output
89 Con *workspace_prev_on_output(void);
92 * Focuses the previously focused workspace.
95 void workspace_back_and_forth(void);
98 * Returns the previously focused workspace con, or NULL if unavailable.
101 Con *workspace_back_and_forth_get(void);
105 * Assigns the given workspace to the given screen by correctly updating its
106 * state and reconfiguring all the clients on this workspace.
108 * This is called when initializing a screen and when re-assigning it to a
109 * different screen which just got available (if you configured it to be on
110 * screen 1 and you just plugged in screen 1).
113 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
116 * Initializes the given workspace if it is not already initialized. The given
117 * screen is to be understood as a fallback, if the workspace itself either
118 * was not assigned to a particular screen or cannot be placed there because
119 * the screen is not attached at the moment.
122 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
125 * Gets the first unused workspace for the given screen, taking into account
126 * the preferred_screen setting of every workspace (workspace assignments).
129 Workspace *get_first_workspace_for_output(Output *screen);
132 * Unmaps all clients (and stack windows) of the given workspace.
134 * This needs to be called separately when temporarily rendering a workspace
135 * which is not the active workspace to force reconfiguration of all clients,
136 * like in src/xinerama.c when re-assigning a workspace to another screen.
139 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
142 * Maps all clients (and stack windows) of the given workspace.
145 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
149 * Goes through all clients on the given workspace and updates the workspace’s
150 * urgent flag accordingly.
153 void workspace_update_urgent_flag(Con *ws);
156 * 'Forces' workspace orientation by moving all cons into a new split-con with
157 * the same orientation as the workspace and then changing the workspace
161 void ws_force_orientation(Con *ws, orientation_t orientation);
164 * Called when a new con (with a window, not an empty or split con) should be
165 * attached to the workspace (for example when managing a new window or when
166 * moving an existing window to the workspace level).
168 * Depending on the workspace_layout setting, this function either returns the
169 * workspace itself (default layout) or creates a new stacked/tabbed con and
173 Con *workspace_attach_to(Con *ws);
176 * Creates a new container and re-parents all of children from the given
179 * The container inherits the layout from the workspace.
181 Con *workspace_encapsulate(Con *ws);