1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 action.h for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 See the COPYING file for a copy of the GNU General Public License.
25 #include "parser/parse.h"
29 typedef struct _ObAction ObAction;
31 /* These have to all have a Client* at the top even if they don't use it, so
32 that I can set it blindly later on. So every function will have a Client*
33 available (possibly NULL though) if it wants it.
39 OB_CLIENT_ACTION_OPTIONAL,
40 OB_CLIENT_ACTION_ALWAYS
44 ObClientActionReq client_action;
46 ObFrameContext context;
54 struct InteractiveAction {
60 struct InterDirectionalAction{
61 struct InteractiveAction inter;
62 ObDirection direction;
64 gboolean dock_windows;
65 gboolean desktop_windows;
68 struct DirectionalAction{
70 ObDirection direction;
81 gboolean startupnotify;
92 gboolean here; /* bring it to the current desktop */
95 struct MoveResizeRelative {
103 struct SendToDesktop {
104 struct AnyAction any;
109 struct SendToDesktopDirection {
110 struct InteractiveAction inter;
118 struct AnyAction inter;
123 struct AnyAction any;
124 gint layer; /* < 0 = below, 0 = normal, > 0 = above */
127 struct DesktopDirection {
128 struct InteractiveAction inter;
135 struct AnyAction any;
141 struct AnyAction any;
145 struct CycleWindows {
146 struct InteractiveAction inter;
150 gboolean dock_windows;
151 gboolean desktop_windows;
152 gboolean all_desktops;
156 struct AnyAction any;
160 struct AnyAction any;
161 struct InteractiveAction inter;
162 struct InterDirectionalAction interdiraction;
163 struct DirectionalAction diraction;
165 struct Execute execute;
166 struct ClientAction client;
167 struct Activate activate;
168 struct MoveResizeRelative relative;
169 struct SendToDesktop sendto;
170 struct SendToDesktopDirection sendtodir;
171 struct Desktop desktop;
172 struct DesktopDirection desktopdir;
173 struct MoveResize moveresize;
174 struct ShowMenu showmenu;
175 struct CycleWindows cycle;
177 struct Stacking stacking;
183 /* The func member acts like an enum to tell which one of the structs in
184 the data union are valid.
186 void (*func)(union ActionData *data);
187 union ActionData data;
190 /* Creates a new Action from the name of the action
191 A few action types need data set after making this call still. Check if
192 the returned action's "func" is one of these.
193 action_debug - the string to print should be set
194 action_execute - the path needs to be set
195 action_restart - the path can optionally be set
196 action_desktop - the destination desktop needs to be set
197 action_send_to_desktop - the destination desktop needs to be set
198 action_move_relative_horz - the delta
199 action_move_relative_vert - the delta
200 action_resize_relative_horz - the delta
201 action_resize_relative_vert - the delta
202 action_move_relative - the deltas
203 action_resize_relative - the deltas
206 ObAction* action_from_string(const gchar *name, ObUserAction uact);
207 ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
209 void action_ref(ObAction *a);
210 void action_unref(ObAction *a);
212 ObAction* action_copy(const ObAction *a);
214 /*! Executes a list of actions.
215 @param c The client associated with the action. Can be NULL.
216 @param state The keyboard modifiers state at the time the user action occured
217 @param button The mouse button used to execute the action.
218 @param x The x coord at which the user action occured.
219 @param y The y coord at which the user action occured.
220 @param cancel If the action is cancelling an interactive action. This only
221 affects interactive actions, but should generally always be FALSE.
222 @param done If the action is completing an interactive action. This only
223 affects interactive actions, but should generally always be FALSE.
225 void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
226 guint state, guint button, gint x, gint y, Time time,
227 gboolean cancel, gboolean done);
229 #define action_run_mouse(a, c, n, s, b, x, y, t) \
230 action_run_list(a, c, n, s, b, x, y, t, FALSE, FALSE)
232 #define action_run_interactive(a, c, s, t, n, d) \
233 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, n, d)
235 #define action_run_key(a, c, s, x, y, t) \
236 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, t, FALSE, FALSE)
238 #define action_run(a, c, s, t) \
239 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, FALSE, FALSE)
241 void action_run_string(const gchar *name, struct _ObClient *c, Time time);
244 void action_debug(union ActionData *data);
246 void action_execute(union ActionData *data);
248 void action_activate(union ActionData *data);
250 void action_focus(union ActionData *data);
252 void action_unfocus(union ActionData *data);
254 void action_iconify(union ActionData *data);
256 void action_focus_order_to_bottom(union ActionData *data);
258 void action_raiselower(union ActionData *data);
260 void action_raise(union ActionData *data);
262 void action_lower(union ActionData *data);
264 void action_close(union ActionData *data);
266 void action_kill(union ActionData *data);
268 void action_shade(union ActionData *data);
270 void action_shadelower(union ActionData *data);
272 void action_unshaderaise(union ActionData *data);
274 void action_unshade(union ActionData *data);
276 void action_toggle_shade(union ActionData *data);
278 void action_toggle_omnipresent(union ActionData *data);
279 /* MoveResizeRelative */
280 void action_move_relative_horz(union ActionData *data);
281 /* MoveResizeRelative */
282 void action_move_relative_vert(union ActionData *data);
283 /* MoveResizeRelative */
284 void action_move_relative(union ActionData *data);
285 /* MoveResizeRelative */
286 void action_resize_relative(union ActionData *data);
288 void action_move_to_center(union ActionData *data);
289 /* MoveResizeRelative */
290 void action_resize_relative_horz(union ActionData *data);
291 /* MoveResizeRelative */
292 void action_resize_relative_vert(union ActionData *data);
294 void action_maximize_full(union ActionData *data);
296 void action_unmaximize_full(union ActionData *data);
298 void action_toggle_maximize_full(union ActionData *data);
300 void action_maximize_horz(union ActionData *data);
302 void action_unmaximize_horz(union ActionData *data);
304 void action_toggle_maximize_horz(union ActionData *data);
306 void action_maximize_vert(union ActionData *data);
308 void action_unmaximize_vert(union ActionData *data);
310 void action_toggle_maximize_vert(union ActionData *data);
312 void action_toggle_fullscreen(union ActionData *data);
314 void action_send_to_desktop(union ActionData *data);
315 /* SendToDesktopDirection */
316 void action_send_to_desktop_dir(union ActionData *data);
318 void action_desktop(union ActionData *data);
319 /* DesktopDirection */
320 void action_desktop_dir(union ActionData *data);
322 void action_desktop_last(union ActionData *data);
324 void action_toggle_decorations(union ActionData *data);
326 void action_move(union ActionData *data);
328 void action_resize(union ActionData *data);
330 void action_reconfigure(union ActionData *data);
332 void action_restart(union ActionData *data);
334 void action_exit(union ActionData *data);
336 void action_showmenu(union ActionData *data);
338 void action_cycle_windows(union ActionData *data);
339 /* InterDirectionalAction */
340 void action_directional_focus(union ActionData *data);
341 /* DirectionalAction */
342 void action_movetoedge(union ActionData *data);
343 /* DirectionalAction */
344 void action_growtoedge(union ActionData *data);
346 void action_send_to_layer(union ActionData *data);
348 void action_toggle_layer(union ActionData *data);
350 void action_toggle_dockautohide(union ActionData *data);
352 void action_toggle_show_desktop(union ActionData *data);
354 void action_show_desktop(union ActionData *data);
356 void action_unshow_desktop(union ActionData *data);
358 void action_break_chroot(union ActionData *data);