]> git.sur5r.net Git - i3/i3/blob - include/commands.h
Merge pull request #1706 from Airblader/feature-docs-5
[i3/i3] / include / commands.h
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  * commands.c: all command functions (see commands_parser.c)
8  *
9  */
10 #pragma once
11
12 #include "commands_parser.h"
13
14 /** The beginning of the prototype for every cmd_ function. */
15 #define I3_CMD Match *current_match, struct CommandResultIR *cmd_output
16
17 /**
18  * Initializes the specified 'Match' data structure and the initial state of
19  * commands.c for matching target windows of a command.
20  *
21  */
22 void cmd_criteria_init(I3_CMD);
23
24 /**
25  * A match specification just finished (the closing square bracket was found),
26  * so we filter the list of owindows.
27  *
28  */
29 void cmd_criteria_match_windows(I3_CMD);
30
31 /**
32  * Interprets a ctype=cvalue pair and adds it to the current match
33  * specification.
34  *
35  */
36 void cmd_criteria_add(I3_CMD, char *ctype, char *cvalue);
37
38 /**
39  * Implementation of 'move [window|container] [to] workspace
40  * next|prev|next_on_output|prev_on_output'.
41  *
42  */
43 void cmd_move_con_to_workspace(I3_CMD, char *which);
44
45 /**
46  * Implementation of 'move [window|container] [to] workspace back_and_forth'.
47  *
48  */
49 void cmd_move_con_to_workspace_back_and_forth(I3_CMD);
50
51 /**
52  * Implementation of 'move [window|container] [to] workspace <name>'.
53  *
54  */
55 void cmd_move_con_to_workspace_name(I3_CMD, char *name);
56
57 /**
58  * Implementation of 'move [window|container] [to] workspace number <number>'.
59  *
60  */
61 void cmd_move_con_to_workspace_number(I3_CMD, char *which);
62
63 /**
64  * Implementation of 'resize grow|shrink <direction> [<px> px] [or <ppt> ppt]'.
65  *
66  */
67 void cmd_resize(I3_CMD, char *way, char *direction, char *resize_px, char *resize_ppt);
68
69 /**
70  * Implementation of 'border normal|none|1pixel|toggle'.
71  *
72  */
73 void cmd_border(I3_CMD, char *border_style_str, char *border_width);
74
75 /**
76  * Implementation of 'nop <comment>'.
77  *
78  */
79 void cmd_nop(I3_CMD, char *comment);
80
81 /**
82  * Implementation of 'append_layout <path>'.
83  *
84  */
85 void cmd_append_layout(I3_CMD, char *path);
86
87 /**
88  * Implementation of 'workspace next|prev|next_on_output|prev_on_output'.
89  *
90  */
91 void cmd_workspace(I3_CMD, char *which);
92
93 /**
94  * Implementation of 'workspace number <number>'
95  *
96  */
97 void cmd_workspace_number(I3_CMD, char *which);
98
99 /**
100  * Implementation of 'workspace back_and_forth'.
101  *
102  */
103 void cmd_workspace_back_and_forth(I3_CMD);
104
105 /**
106  * Implementation of 'workspace <name>'
107  *
108  */
109 void cmd_workspace_name(I3_CMD, char *name);
110
111 /**
112  * Implementation of 'mark [--toggle] <mark>'
113  *
114  */
115 void cmd_mark(I3_CMD, char *mark, char *toggle);
116
117 /**
118  * Implementation of 'unmark [mark]'
119  *
120  */
121 void cmd_unmark(I3_CMD, char *mark);
122
123 /**
124  * Implementation of 'mode <string>'.
125  *
126  */
127 void cmd_mode(I3_CMD, char *mode);
128
129 /**
130  * Implementation of 'move [window|container] [to] output <str>'.
131  *
132  */
133 void cmd_move_con_to_output(I3_CMD, char *name);
134
135 /**
136  * Implementation of 'move [window|container] [to] mark <str>'.
137  *
138  */
139 void cmd_move_con_to_mark(I3_CMD, char *mark);
140
141 /**
142  * Implementation of 'floating enable|disable|toggle'
143  *
144  */
145 void cmd_floating(I3_CMD, char *floating_mode);
146
147 /**
148  * Implementation of 'move workspace to [output] <str>'.
149  *
150  */
151 void cmd_move_workspace_to_output(I3_CMD, char *name);
152
153 /**
154  * Implementation of 'split v|h|vertical|horizontal'.
155  *
156  */
157 void cmd_split(I3_CMD, char *direction);
158
159 /**
160  * Implementation of 'kill [window|client]'.
161  *
162  */
163 void cmd_kill(I3_CMD, char *kill_mode_str);
164
165 /**
166  * Implementation of 'exec [--no-startup-id] <command>'.
167  *
168  */
169 void cmd_exec(I3_CMD, char *nosn, char *command);
170
171 /**
172  * Implementation of 'focus left|right|up|down'.
173  *
174  */
175 void cmd_focus_direction(I3_CMD, char *direction);
176
177 /**
178  * Implementation of 'focus tiling|floating|mode_toggle'.
179  *
180  */
181 void cmd_focus_window_mode(I3_CMD, char *window_mode);
182
183 /**
184  * Implementation of 'focus parent|child'.
185  *
186  */
187 void cmd_focus_level(I3_CMD, char *level);
188
189 /**
190  * Implementation of 'focus'.
191  *
192  */
193 void cmd_focus(I3_CMD);
194
195 /**
196  * Implementation of 'fullscreen [enable|disable|toggle] [global]'.
197  *
198  */
199 void cmd_fullscreen(I3_CMD, char *action, char *fullscreen_mode);
200
201 /**
202  * Implementation of 'move <direction> [<pixels> [px]]'.
203  *
204  */
205 void cmd_move_direction(I3_CMD, char *direction, char *move_px);
206
207 /**
208  * Implementation of 'layout default|stacked|stacking|tabbed|splitv|splith'.
209  *
210  */
211 void cmd_layout(I3_CMD, char *layout_str);
212
213 /**
214  * Implementation of 'layout toggle [all|split]'.
215  *
216  */
217 void cmd_layout_toggle(I3_CMD, char *toggle_mode);
218
219 /**
220  * Implementation of 'exit'.
221  *
222  */
223 void cmd_exit(I3_CMD);
224
225 /**
226  * Implementation of 'reload'.
227  *
228  */
229 void cmd_reload(I3_CMD);
230
231 /**
232  * Implementation of 'restart'.
233  *
234  */
235 void cmd_restart(I3_CMD);
236
237 /**
238  * Implementation of 'open'.
239  *
240  */
241 void cmd_open(I3_CMD);
242
243 /**
244  * Implementation of 'focus output <output>'.
245  *
246  */
247 void cmd_focus_output(I3_CMD, char *name);
248
249 /**
250  * Implementation of 'move [window|container] [to] [absolute] position <px> [px] <px> [px]
251  *
252  */
253 void cmd_move_window_to_position(I3_CMD, char *method, char *x, char *y);
254
255 /**
256  * Implementation of 'move [window|container] [to] [absolute] position center
257  *
258  */
259 void cmd_move_window_to_center(I3_CMD, char *method);
260
261 /**
262  * Implementation of 'move [window|container] [to] position mouse'
263  *
264  */
265 void cmd_move_window_to_mouse(I3_CMD);
266
267 /**
268  * Implementation of 'move scratchpad'.
269  *
270  */
271 void cmd_move_scratchpad(I3_CMD);
272
273 /**
274  * Implementation of 'scratchpad show'.
275  *
276  */
277 void cmd_scratchpad_show(I3_CMD);
278
279 /**
280  * Implementation of 'rename workspace <name> to <name>'
281  *
282  */
283 void cmd_rename_workspace(I3_CMD, char *old_name, char *new_name);
284
285 /**
286  * Implementation of 'bar (hidden_state hide|show|toggle)|(mode dock|hide|invisible|toggle) [<bar_id>]'
287  *
288  */
289 void cmd_bar(I3_CMD, char *bar_type, char *bar_value, char *bar_id);
290
291 /*
292  * Implementation of 'shmlog <size>|toggle|on|off'
293  *
294  */
295 void cmd_shmlog(I3_CMD, char *argument);
296
297 /*
298  * Implementation of 'debuglog toggle|on|off'
299  *
300  */
301 void cmd_debuglog(I3_CMD, char *argument);