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
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 * Extracts workspace names from keybindings (e.g. “web” from “bindsym $mod+1
30 * workspace web”), so that when an output needs a workspace, i3 can start with
31 * the first configured one. Needs to be called before reorder_bindings() so
32 * that the config-file order is used, not the i3-internal order.
35 void extract_workspace_names_from_bindings(void);
38 * Returns a pointer to a new workspace in the given output. The workspace
39 * is created attached to the tree hierarchy through the given content
43 Con *create_workspace_on_output(Output *output, Con *content);
47 * Sets the name (or just its number) for the given workspace. This has to
48 * be called for every workspace as the rendering function
49 * (render_internal_bar) relies on workspace->name and workspace->name_len
53 void workspace_set_name(Workspace *ws, const char *name);
57 * Returns true if the workspace is currently visible. Especially important for
58 * multi-monitor environments, as they can have multiple currenlty active
62 bool workspace_is_visible(Con *ws);
65 * Switches to the given workspace
68 void workspace_show(Con *ws);
71 * Looks up the workspace by name and switches to it.
74 void workspace_show_by_name(const char *num);
77 * Returns the next workspace.
80 Con *workspace_next(void);
83 * Returns the previous workspace.
86 Con *workspace_prev(void);
89 * Returns the next workspace on the same output
92 Con *workspace_next_on_output(void);
95 * Returns the previous workspace on the same output
98 Con *workspace_prev_on_output(void);
101 * Focuses the previously focused workspace.
104 void workspace_back_and_forth(void);
107 * Returns the previously focused workspace con, or NULL if unavailable.
110 Con *workspace_back_and_forth_get(void);
114 * Assigns the given workspace to the given screen by correctly updating its
115 * state and reconfiguring all the clients on this workspace.
117 * This is called when initializing a screen and when re-assigning it to a
118 * different screen which just got available (if you configured it to be on
119 * screen 1 and you just plugged in screen 1).
122 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
125 * Initializes the given workspace if it is not already initialized. The given
126 * screen is to be understood as a fallback, if the workspace itself either
127 * was not assigned to a particular screen or cannot be placed there because
128 * the screen is not attached at the moment.
131 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
134 * Gets the first unused workspace for the given screen, taking into account
135 * the preferred_screen setting of every workspace (workspace assignments).
138 Workspace *get_first_workspace_for_output(Output *screen);
141 * Unmaps all clients (and stack windows) of the given workspace.
143 * This needs to be called separately when temporarily rendering a workspace
144 * which is not the active workspace to force reconfiguration of all clients,
145 * like in src/xinerama.c when re-assigning a workspace to another screen.
148 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
151 * Maps all clients (and stack windows) of the given workspace.
154 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
158 * Goes through all clients on the given workspace and updates the workspace’s
159 * urgent flag accordingly.
162 void workspace_update_urgent_flag(Con *ws);
165 * 'Forces' workspace orientation by moving all cons into a new split-con with
166 * the same orientation as the workspace and then changing the workspace
170 void ws_force_orientation(Con *ws, orientation_t orientation);
173 * Called when a new con (with a window, not an empty or split con) should be
174 * attached to the workspace (for example when managing a new window or when
175 * moving an existing window to the workspace level).
177 * Depending on the workspace_layout setting, this function either returns the
178 * workspace itself (default layout) or creates a new stacked/tabbed con and
182 Con *workspace_attach_to(Con *ws);
185 * Creates a new container and re-parents all of children from the given
188 * The container inherits the layout from the workspace.
190 Con *workspace_encapsulate(Con *ws);
193 * Move the given workspace to the specified output.
194 * This returns true if and only if moving the workspace was successful.
197 bool workspace_move_to_output(Con *ws, const char *output);