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
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);
31 * Sets the name (or just its number) for the given workspace. This has to
32 * be called for every workspace as the rendering function
33 * (render_internal_bar) relies on workspace->name and workspace->name_len
37 void workspace_set_name(Workspace *ws, const char *name);
41 * Returns true if the workspace is currently visible. Especially important for
42 * multi-monitor environments, as they can have multiple currenlty active
46 bool workspace_is_visible(Con *ws);
49 * Switches to the given workspace
52 void workspace_show(Con *ws);
55 * Looks up the workspace by name and switches to it.
58 void workspace_show_by_name(const char *num);
61 * Returns the next workspace.
64 Con* workspace_next();
67 * Returns the previous workspace.
70 Con* workspace_prev();
73 * Returns the next workspace on the same output
76 Con* workspace_next_on_output();
79 * Returns the previous workspace on the same output
82 Con* workspace_prev_on_output();
85 * Focuses the previously focused workspace.
88 void workspace_back_and_forth();
93 * Assigns the given workspace to the given screen by correctly updating its
94 * state and reconfiguring all the clients on this workspace.
96 * This is called when initializing a screen and when re-assigning it to a
97 * different screen which just got available (if you configured it to be on
98 * screen 1 and you just plugged in screen 1).
101 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
104 * Initializes the given workspace if it is not already initialized. The given
105 * screen is to be understood as a fallback, if the workspace itself either
106 * was not assigned to a particular screen or cannot be placed there because
107 * the screen is not attached at the moment.
110 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
113 * Gets the first unused workspace for the given screen, taking into account
114 * the preferred_screen setting of every workspace (workspace assignments).
117 Workspace *get_first_workspace_for_output(Output *screen);
120 * Unmaps all clients (and stack windows) of the given workspace.
122 * This needs to be called separately when temporarily rendering a workspace
123 * which is not the active workspace to force reconfiguration of all clients,
124 * like in src/xinerama.c when re-assigning a workspace to another screen.
127 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
130 * Maps all clients (and stack windows) of the given workspace.
133 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
137 * Goes through all clients on the given workspace and updates the workspace’s
138 * urgent flag accordingly.
141 void workspace_update_urgent_flag(Con *ws);
144 * 'Forces' workspace orientation by moving all cons into a new split-con with
145 * the same orientation as the workspace and then changing the workspace
149 void ws_force_orientation(Con *ws, orientation_t orientation);
152 * Called when a new con (with a window, not an empty or split con) should be
153 * attached to the workspace (for example when managing a new window or when
154 * moving an existing window to the workspace level).
156 * Depending on the workspace_layout setting, this function either returns the
157 * workspace itself (default layout) or creates a new stacked/tabbed con and
161 Con *workspace_attach_to(Con *ws);