4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
21 * Returns a pointer to the workspace with the given number (starting at 0),
22 * creating the workspace if necessary (by allocating the necessary amount of
23 * memory and initializing the data structures correctly).
25 * If created is not NULL, *created will be set to whether or not the
26 * workspace has just been created.
29 Con *workspace_get(const char *num, bool *created);
33 * Sets the name (or just its number) for the given workspace. This has to
34 * be called for every workspace as the rendering function
35 * (render_internal_bar) relies on workspace->name and workspace->name_len
39 void workspace_set_name(Workspace *ws, const char *name);
43 * Returns true if the workspace is currently visible. Especially important for
44 * multi-monitor environments, as they can have multiple currenlty active
48 bool workspace_is_visible(Con *ws);
50 /** Switches to the given workspace */
51 void workspace_show(const char *num);
55 * Assigns the given workspace to the given screen by correctly updating its
56 * state and reconfiguring all the clients on this workspace.
58 * This is called when initializing a screen and when re-assigning it to a
59 * different screen which just got available (if you configured it to be on
60 * screen 1 and you just plugged in screen 1).
63 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
66 * Initializes the given workspace if it is not already initialized. The given
67 * screen is to be understood as a fallback, if the workspace itself either
68 * was not assigned to a particular screen or cannot be placed there because
69 * the screen is not attached at the moment.
72 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
75 * Gets the first unused workspace for the given screen, taking into account
76 * the preferred_screen setting of every workspace (workspace assignments).
79 Workspace *get_first_workspace_for_output(Output *screen);
82 * Unmaps all clients (and stack windows) of the given workspace.
84 * This needs to be called separately when temporarily rendering a workspace
85 * which is not the active workspace to force reconfiguration of all clients,
86 * like in src/xinerama.c when re-assigning a workspace to another screen.
89 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
92 * Maps all clients (and stack windows) of the given workspace.
95 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
99 * Goes through all clients on the given workspace and updates the workspace’s
100 * urgent flag accordingly.
103 void workspace_update_urgent_flag(Con *ws);
106 * 'Forces' workspace orientation by moving all cons into a new split-con with
107 * the same orientation as the workspace and then changing the workspace
111 void ws_force_orientation(Con *ws, orientation_t orientation);