]> git.sur5r.net Git - i3/i3/blob - include/workspace.h
Merge branch 'master' into next
[i3/i3] / include / workspace.h
1 /*
2  * vim:ts=8:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  *
6  * © 2009-2010 Michael Stapelberg and contributors
7  *
8  * See file LICENSE for license information.
9  *
10  */
11
12 #include "data.h"
13 #include "tree.h"
14 #include "randr.h"
15
16 #ifndef _WORKSPACE_H
17 #define _WORKSPACE_H
18
19 /**
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).
23  *
24  * If created is not NULL, *created will be set to whether or not the
25  * workspace has just been created.
26  *
27  */
28 Con *workspace_get(const char *num, bool *created);
29
30 #if 0
31 /**
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
35  * being ready-to-use.
36  *
37  */
38 void workspace_set_name(Workspace *ws, const char *name);
39 #endif
40
41 /**
42  * Returns true if the workspace is currently visible. Especially important for
43  * multi-monitor environments, as they can have multiple currenlty active
44  * workspaces.
45  *
46  */
47 bool workspace_is_visible(Con *ws);
48
49 /** Switches to the given workspace */
50 void workspace_show(const char *num);
51
52 /**
53  * Focuses the next workspace.
54  *
55  */
56 void workspace_next();
57
58 /**
59  * Focuses the previous workspace.
60  *
61  */
62 void workspace_prev();
63
64 #if 0
65 /**
66  * Assigns the given workspace to the given screen by correctly updating its
67  * state and reconfiguring all the clients on this workspace.
68  *
69  * This is called when initializing a screen and when re-assigning it to a
70  * different screen which just got available (if you configured it to be on
71  * screen 1 and you just plugged in screen 1).
72  *
73  */
74 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
75
76 /**
77  * Initializes the given workspace if it is not already initialized. The given
78  * screen is to be understood as a fallback, if the workspace itself either
79  * was not assigned to a particular screen or cannot be placed there because
80  * the screen is not attached at the moment.
81  *
82  */
83 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
84
85 /**
86  * Gets the first unused workspace for the given screen, taking into account
87  * the preferred_screen setting of every workspace (workspace assignments).
88  *
89  */
90 Workspace *get_first_workspace_for_output(Output *screen);
91
92 /**
93  * Unmaps all clients (and stack windows) of the given workspace.
94  *
95  * This needs to be called separately when temporarily rendering a workspace
96  * which is not the active workspace to force reconfiguration of all clients,
97  * like in src/xinerama.c when re-assigning a workspace to another screen.
98  *
99  */
100 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
101
102 /**
103  * Maps all clients (and stack windows) of the given workspace.
104  *
105  */
106 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
107 #endif
108
109 /**
110  * Goes through all clients on the given workspace and updates the workspace’s
111  * urgent flag accordingly.
112  *
113  */
114 void workspace_update_urgent_flag(Con *ws);
115
116 /**
117  * 'Forces' workspace orientation by moving all cons into a new split-con with
118  * the same orientation as the workspace and then changing the workspace
119  * orientation.
120  *
121  */
122 void ws_force_orientation(Con *ws, orientation_t orientation);
123
124 /**
125  * Called when a new con (with a window, not an empty or split con) should be
126  * attached to the workspace (for example when managing a new window or when
127  * moving an existing window to the workspace level).
128  *
129  * Depending on the workspace_layout setting, this function either returns the
130  * workspace itself (default layout) or creates a new stacked/tabbed con and
131  * returns that.
132  *
133  */
134 Con *workspace_attach_to(Con *ws);
135
136 #endif