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
11 #ifndef I3_WORKSPACE_H
12 #define I3_WORKSPACE_H
19 * Returns a pointer to the workspace with the given number (starting at 0),
20 * creating the workspace if necessary (by allocating the necessary amount of
21 * memory and initializing the data structures correctly).
23 * If created is not NULL, *created will be set to whether or not the
24 * workspace has just been created.
27 Con *workspace_get(const char *num, bool *created);
30 * Returns a pointer to a new workspace in the given output. The workspace
31 * is created attached to the tree hierarchy through the given content
35 Con *create_workspace_on_output(Output *output, Con *content);
39 * Sets the name (or just its number) for the given workspace. This has to
40 * be called for every workspace as the rendering function
41 * (render_internal_bar) relies on workspace->name and workspace->name_len
45 void workspace_set_name(Workspace *ws, const char *name);
49 * Returns true if the workspace is currently visible. Especially important for
50 * multi-monitor environments, as they can have multiple currenlty active
54 bool workspace_is_visible(Con *ws);
57 * Switches to the given workspace
60 void workspace_show(Con *ws);
63 * Looks up the workspace by name and switches to it.
66 void workspace_show_by_name(const char *num);
69 * Returns the next workspace.
72 Con* workspace_next(void);
75 * Returns the previous workspace.
78 Con* workspace_prev(void);
81 * Returns the next workspace on the same output
84 Con* workspace_next_on_output(void);
87 * Returns the previous workspace on the same output
90 Con* workspace_prev_on_output(void);
93 * Focuses the previously focused workspace.
96 void workspace_back_and_forth(void);
99 * Returns the previously focused workspace con, or NULL if unavailable.
102 Con *workspace_back_and_forth_get(void);
107 * Assigns the given workspace to the given screen by correctly updating its
108 * state and reconfiguring all the clients on this workspace.
110 * This is called when initializing a screen and when re-assigning it to a
111 * different screen which just got available (if you configured it to be on
112 * screen 1 and you just plugged in screen 1).
115 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
118 * Initializes the given workspace if it is not already initialized. The given
119 * screen is to be understood as a fallback, if the workspace itself either
120 * was not assigned to a particular screen or cannot be placed there because
121 * the screen is not attached at the moment.
124 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
127 * Gets the first unused workspace for the given screen, taking into account
128 * the preferred_screen setting of every workspace (workspace assignments).
131 Workspace *get_first_workspace_for_output(Output *screen);
134 * Unmaps all clients (and stack windows) of the given workspace.
136 * This needs to be called separately when temporarily rendering a workspace
137 * which is not the active workspace to force reconfiguration of all clients,
138 * like in src/xinerama.c when re-assigning a workspace to another screen.
141 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
144 * Maps all clients (and stack windows) of the given workspace.
147 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
151 * Goes through all clients on the given workspace and updates the workspace’s
152 * urgent flag accordingly.
155 void workspace_update_urgent_flag(Con *ws);
158 * 'Forces' workspace orientation by moving all cons into a new split-con with
159 * the same orientation as the workspace and then changing the workspace
163 void ws_force_orientation(Con *ws, orientation_t orientation);
166 * Called when a new con (with a window, not an empty or split con) should be
167 * attached to the workspace (for example when managing a new window or when
168 * moving an existing window to the workspace level).
170 * Depending on the workspace_layout setting, this function either returns the
171 * workspace itself (default layout) or creates a new stacked/tabbed con and
175 Con *workspace_attach_to(Con *ws);
178 * Creates a new container and re-parents all of children from the given
181 * The container inherits the layout from the workspace.
183 Con *workspace_encapsulate(Con *ws);