4 * i3 - an improved dynamic tiling window manager
6 * © 2009-2010 Michael Stapelberg and contributors
8 * See file LICENSE for license information.
20 * Returns a pointer to the workspace with the given number (starting at 0),
21 * creating the workspace if necessary (by allocating the necessary amount of
22 * memory and initializing the data structures correctly).
24 * If created is not NULL, *created will be set to whether or not the
25 * workspace has just been created.
28 Con *workspace_get(const char *num, bool *created);
32 * Sets the name (or just its number) for the given workspace. This has to
33 * be called for every workspace as the rendering function
34 * (render_internal_bar) relies on workspace->name and workspace->name_len
38 void workspace_set_name(Workspace *ws, const char *name);
42 * Returns true if the workspace is currently visible. Especially important for
43 * multi-monitor environments, as they can have multiple currenlty active
47 bool workspace_is_visible(Con *ws);
50 * Switches to the given workspace
53 void workspace_show(Con *ws);
56 * Looks up the workspace by name and switches to it.
59 void workspace_show_by_name(const char *num);
62 * Returns the next workspace.
65 Con* workspace_next();
68 * Returns the previous workspace.
71 Con* workspace_prev();
74 * Focuses the previously focused workspace.
77 void workspace_back_and_forth();
82 * Assigns the given workspace to the given screen by correctly updating its
83 * state and reconfiguring all the clients on this workspace.
85 * This is called when initializing a screen and when re-assigning it to a
86 * different screen which just got available (if you configured it to be on
87 * screen 1 and you just plugged in screen 1).
90 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
93 * Initializes the given workspace if it is not already initialized. The given
94 * screen is to be understood as a fallback, if the workspace itself either
95 * was not assigned to a particular screen or cannot be placed there because
96 * the screen is not attached at the moment.
99 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
102 * Gets the first unused workspace for the given screen, taking into account
103 * the preferred_screen setting of every workspace (workspace assignments).
106 Workspace *get_first_workspace_for_output(Output *screen);
109 * Unmaps all clients (and stack windows) of the given workspace.
111 * This needs to be called separately when temporarily rendering a workspace
112 * which is not the active workspace to force reconfiguration of all clients,
113 * like in src/xinerama.c when re-assigning a workspace to another screen.
116 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
119 * Maps all clients (and stack windows) of the given workspace.
122 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
126 * Goes through all clients on the given workspace and updates the workspace’s
127 * urgent flag accordingly.
130 void workspace_update_urgent_flag(Con *ws);
133 * 'Forces' workspace orientation by moving all cons into a new split-con with
134 * the same orientation as the workspace and then changing the workspace
138 void ws_force_orientation(Con *ws, orientation_t orientation);
141 * Called when a new con (with a window, not an empty or split con) should be
142 * attached to the workspace (for example when managing a new window or when
143 * moving an existing window to the workspace level).
145 * Depending on the workspace_layout setting, this function either returns the
146 * workspace itself (default layout) or creates a new stacked/tabbed con and
150 Con *workspace_attach_to(Con *ws);