i3
workspace.h
Go to the documentation of this file.
1 /*
2  * vim:ts=4:sw=4:expandtab
3  *
4  * i3 - an improved dynamic tiling window manager
5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
6  *
7  * workspace.c: Modifying workspaces, accessing them, moving containers to
8  * workspaces.
9  *
10  */
11 #pragma once
12 
13 #include <config.h>
14 
15 #include "data.h"
16 #include "tree.h"
17 #include "randr.h"
18 
19 /* We use NET_WM_DESKTOP_NONE for cases where we cannot determine the EWMH
20  * desktop index for a window. We cannot use a negative value like -1 since we
21  * need to use uint32_t as we actually need the full range of it. This is
22  * technically dangerous, but it's safe to assume that we will never have more
23  * than 4294967279 workspaces open at a time. */
24 #define NET_WM_DESKTOP_NONE 0xFFFFFFF0
25 #define NET_WM_DESKTOP_ALL 0xFFFFFFFF
26 
32 extern char *previous_workspace_name;
33 
39 Con *get_existing_workspace_by_name(const char *name);
40 
47 
59 Con *get_assigned_output(const char *name, long parsed_num);
60 
66 bool output_triggers_assignment(Output *output, struct Workspace_Assignment *assignment);
67 
74 Con *workspace_get(const char *num);
75 
84 
91 Con *create_workspace_on_output(Output *output, Con *content);
92 
99 bool workspace_is_visible(Con *ws);
100 
105 void workspace_show(Con *ws);
106 
111 void workspace_show_by_name(const char *num);
112 
117 Con *workspace_next(void);
118 
123 Con *workspace_prev(void);
124 
130 
136 
141 void workspace_back_and_forth(void);
142 
148 
155 
162 void ws_force_orientation(Con *ws, orientation_t orientation);
163 
175 
183 
188 void workspace_move_to_output(Con *ws, Output *output);
orientation_t
Definition: data.h:57
Con * workspace_encapsulate(Con *ws)
Creates a new container and re-parents all of children from the given workspace into it.
Definition: workspace.c:934
void workspace_show(Con *ws)
Switches to the given workspace.
Definition: workspace.c:420
bool output_triggers_assignment(Output *output, struct Workspace_Assignment *assignment)
Returns true if the first output assigned to a workspace with the given workspace assignment is the s...
Definition: workspace.c:116
Con * get_existing_workspace_by_num(int num)
Returns the workspace with the given number or NULL if such a workspace does not exist.
Definition: workspace.c:44
Con * create_workspace_on_output(Output *output, Con *content)
Returns a pointer to a new workspace in the given output.
Definition: workspace.c:239
Con * workspace_get(const char *num)
Returns a pointer to the workspace with the given number (starting at 0), creating the workspace if n...
Definition: workspace.c:127
Con * workspace_next_on_output(void)
Returns the next workspace on the same output.
Definition: workspace.c:689
void workspace_update_urgent_flag(Con *ws)
Goes through all clients on the given workspace and updates the workspace’s urgent flag accordingly.
Definition: workspace.c:845
Con * workspace_back_and_forth_get(void)
Returns the previously focused workspace con, or NULL if unavailable.
Definition: workspace.c:814
Con * get_existing_workspace_by_name(const char *name)
Returns the workspace with the given name or NULL if such a workspace does not exist.
Definition: workspace.c:30
bool workspace_is_visible(Con *ws)
Returns true if the workspace is currently visible.
Definition: workspace.c:306
Con * workspace_attach_to(Con *ws)
Called when a new con (with a window, not an empty or split con) should be attached to the workspace ...
Definition: workspace.c:902
Con * workspace_prev(void)
Returns the previous workspace.
Definition: workspace.c:623
void workspace_back_and_forth(void)
Focuses the previously focused workspace.
Definition: workspace.c:801
void workspace_move_to_output(Con *ws, Output *output)
Move the given workspace to the specified output.
Definition: workspace.c:966
Con * workspace_prev_on_output(void)
Returns the previous workspace on the same output.
Definition: workspace.c:744
void extract_workspace_names_from_bindings(void)
Extracts workspace names from keybindings (e.g.
Definition: workspace.c:176
void ws_force_orientation(Con *ws, orientation_t orientation)
'Forces' workspace orientation by moving all cons into a new split-con with the same orientation as t...
Definition: workspace.c:859
Con * workspace_next(void)
Returns the next workspace.
Definition: workspace.c:560
void workspace_show_by_name(const char *num)
Looks up the workspace by name and switches to it.
Definition: workspace.c:552
char * previous_workspace_name
Stores a copy of the name of the last used workspace for the workspace back-and-forth switching.
Definition: workspace.c:19
Con * get_assigned_output(const char *name, long parsed_num)
Returns the first output that is assigned to a workspace specified by the given name or number.
Definition: workspace.c:84
Stores which workspace (by name or number) goes to which output.
Definition: data.h:206
An Output is a physical output on your graphics driver.
Definition: data.h:361
A 'Con' represents everything from the X11 root window down to a single X11 window.
Definition: data.h:613