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 Ben 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;
53 struct InteractiveAction {
59 struct InterDirectionalAction{
60 struct InteractiveAction inter;
61 ObDirection direction;
65 struct DirectionalAction{
67 ObDirection direction;
82 gboolean here; /* bring it to the current desktop */
85 struct MoveResizeRelative {
93 struct SendToDesktop {
99 struct SendToDesktopDirection {
100 struct InteractiveAction inter;
108 struct InteractiveAction inter;
113 struct AnyAction any;
114 gint layer; /* < 0 = below, 0 = normal, > 0 = above */
117 struct DesktopDirection {
118 struct InteractiveAction inter;
125 struct AnyAction any;
131 struct AnyAction any;
135 struct CycleWindows {
136 struct InteractiveAction inter;
143 struct AnyAction any;
148 struct AnyAction any;
149 struct InteractiveAction inter;
150 struct InterDirectionalAction interdiraction;
151 struct DirectionalAction diraction;
152 struct Execute execute;
153 struct ClientAction client;
154 struct Activate activate;
155 struct MoveResizeRelative relative;
156 struct SendToDesktop sendto;
157 struct SendToDesktopDirection sendtodir;
158 struct Desktop desktop;
159 struct DesktopDirection desktopdir;
160 struct MoveResize moveresize;
161 struct ShowMenu showmenu;
162 struct CycleWindows cycle;
164 struct Stacking stacking;
170 /* The func member acts like an enum to tell which one of the structs in
171 the data union are valid.
173 void (*func)(union ActionData *data);
174 union ActionData data;
177 /* Creates a new Action from the name of the action
178 A few action types need data set after making this call still. Check if
179 the returned action's "func" is one of these.
180 action_execute - the path needs to be set
181 action_restart - the path can optionally be set
182 action_desktop - the destination desktop needs to be set
183 action_send_to_desktop - the destination desktop needs to be set
184 action_move_relative_horz - the delta
185 action_move_relative_vert - the delta
186 action_resize_relative_horz - the delta
187 action_resize_relative_vert - the delta
188 action_move_relative - the deltas
189 action_resize_relative - the deltas
192 ObAction* action_from_string(const gchar *name, ObUserAction uact);
193 ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
195 void action_ref(ObAction *a);
196 void action_unref(ObAction *a);
198 ObAction* action_copy(const ObAction *a);
200 /*! Executes a list of actions.
201 @param c The client associated with the action. Can be NULL.
202 @param state The keyboard modifiers state at the time the user action occured
203 @param button The mouse button used to execute the action.
204 @param x The x coord at which the user action occured.
205 @param y The y coord at which the user action occured.
206 @param cancel If the action is cancelling an interactive action. This only
207 affects interactive actions, but should generally always be FALSE.
208 @param done If the action is completing an interactive action. This only
209 affects interactive actions, but should generally always be FALSE.
211 void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
212 guint state, guint button, gint x, gint y,
213 gboolean cancel, gboolean done);
215 #define action_run_mouse(a, c, n, s, b, x, y) \
216 action_run_list(a, c, n, s, b, x, y, FALSE, FALSE)
218 #define action_run_interactive(a, c, s, n, d) \
219 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, n, d)
221 #define action_run_key(a, c, s, x, y) \
222 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, FALSE, FALSE)
224 #define action_run(a, c, s) \
225 action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, FALSE, FALSE)
227 void action_run_string(const gchar *name, struct _ObClient *c);
230 void action_execute(union ActionData *data);
232 void action_activate(union ActionData *data);
234 void action_focus(union ActionData *data);
236 void action_unfocus(union ActionData *data);
238 void action_iconify(union ActionData *data);
240 void action_focus_order_to_bottom(union ActionData *data);
242 void action_raiselower(union ActionData *data);
244 void action_raise(union ActionData *data);
246 void action_lower(union ActionData *data);
248 void action_close(union ActionData *data);
250 void action_kill(union ActionData *data);
252 void action_shade(union ActionData *data);
254 void action_shadelower(union ActionData *data);
256 void action_unshaderaise(union ActionData *data);
258 void action_unshade(union ActionData *data);
260 void action_toggle_shade(union ActionData *data);
262 void action_toggle_omnipresent(union ActionData *data);
263 /* MoveResizeRelative */
264 void action_move_relative_horz(union ActionData *data);
265 /* MoveResizeRelative */
266 void action_move_relative_vert(union ActionData *data);
267 /* MoveResizeRelative */
268 void action_move_relative(union ActionData *data);
269 /* MoveResizeRelative */
270 void action_resize_relative(union ActionData *data);
272 void action_move_to_center(union ActionData *data);
273 /* MoveResizeRelative */
274 void action_resize_relative_horz(union ActionData *data);
275 /* MoveResizeRelative */
276 void action_resize_relative_vert(union ActionData *data);
278 void action_maximize_full(union ActionData *data);
280 void action_unmaximize_full(union ActionData *data);
282 void action_toggle_maximize_full(union ActionData *data);
284 void action_maximize_horz(union ActionData *data);
286 void action_unmaximize_horz(union ActionData *data);
288 void action_toggle_maximize_horz(union ActionData *data);
290 void action_maximize_vert(union ActionData *data);
292 void action_unmaximize_vert(union ActionData *data);
294 void action_toggle_maximize_vert(union ActionData *data);
296 void action_toggle_fullscreen(union ActionData *data);
298 void action_send_to_desktop(union ActionData *data);
299 /* SendToDesktopDirection */
300 void action_send_to_desktop_dir(union ActionData *data);
302 void action_desktop(union ActionData *data);
303 /* DesktopDirection */
304 void action_desktop_dir(union ActionData *data);
306 void action_desktop_last(union ActionData *data);
308 void action_toggle_decorations(union ActionData *data);
310 void action_moveresize(union ActionData *data);
312 void action_reconfigure(union ActionData *data);
314 void action_restart(union ActionData *data);
316 void action_exit(union ActionData *data);
318 void action_showmenu(union ActionData *data);
320 void action_cycle_windows(union ActionData *data);
321 /* InterDirectionalAction */
322 void action_directional_focus(union ActionData *data);
323 /* DirectionalAction */
324 void action_movetoedge(union ActionData *data);
325 /* DirectionalAction */
326 void action_growtoedge(union ActionData *data);
328 void action_send_to_layer(union ActionData *data);
330 void action_toggle_layer(union ActionData *data);
332 void action_toggle_dockautohide(union ActionData *data);
334 void action_toggle_show_desktop(union ActionData *data);
336 void action_show_desktop(union ActionData *data);
338 void action_unshow_desktop(union ActionData *data);