]> icculus.org git repositories - dana/openbox.git/blob - openbox/action.h
wow... this is a big commit...
[dana/openbox.git] / openbox / action.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    action.h for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003        Ben Jansens
6
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.
11
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.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #ifndef __action_h
21 #define __action_h
22
23 #include "misc.h"
24 #include "frame.h"
25 #include "parser/parse.h"
26
27 struct _ObClient;
28
29 typedef struct _ObAction ObAction;
30
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.
34 */
35
36 typedef enum
37 {
38     OB_CLIENT_ACTION_NO,
39     OB_CLIENT_ACTION_OPTIONAL,
40     OB_CLIENT_ACTION_ALWAYS
41 } ObClientActionReq;
42
43 struct AnyAction {
44     ObClientActionReq client_action;
45     struct _ObClient *c;
46     ObFrameContext context;
47     gboolean interactive;
48     gint x;
49     gint y;
50     gint button;
51     Time time;
52 };
53
54 struct InteractiveAction {
55     struct AnyAction any;
56     gboolean final;
57     gboolean cancel;
58 };
59
60 struct InterDirectionalAction{
61     struct InteractiveAction inter;
62     ObDirection direction;
63     gboolean dialog;
64 };
65
66 struct DirectionalAction{
67     struct AnyAction any;
68     ObDirection direction;
69     gboolean hang;
70 };
71
72 struct Execute {
73     struct AnyAction any;
74     gchar *path;
75 };
76
77 struct ClientAction {
78     struct AnyAction any;
79 };
80
81 struct Activate {
82     struct AnyAction any;
83     gboolean here; /* bring it to the current desktop */
84 };
85
86 struct MoveResizeRelative {
87     struct AnyAction any;
88     gint deltax;
89     gint deltay;
90     gint deltaxl;
91     gint deltayu;
92 };
93
94 struct SendToDesktop {
95     struct AnyAction any;
96     guint desk;
97     gboolean follow;
98 };
99
100 struct SendToDesktopDirection {
101     struct InteractiveAction inter;
102     ObDirection dir;
103     gboolean wrap;
104     gboolean linear;
105     gboolean follow;
106 };
107
108 struct Desktop {
109     struct InteractiveAction inter;
110     guint desk;
111 };
112
113 struct Layer {
114     struct AnyAction any;
115     gint layer; /* < 0 = below, 0 = normal, > 0 = above */
116 };
117
118 struct DesktopDirection {
119     struct InteractiveAction inter;
120     ObDirection dir;
121     gboolean wrap;
122     gboolean linear;
123 };
124
125 struct MoveResize {
126     struct AnyAction any;
127     gboolean move;
128     gboolean keyboard;
129 };
130
131 struct ShowMenu {
132     struct AnyAction any;
133     gchar *name;
134 };
135
136 struct CycleWindows {
137     struct InteractiveAction inter;
138     gboolean linear;
139     gboolean forward;
140     gboolean dialog;
141 };
142
143 struct Stacking {
144     struct AnyAction any;
145     gboolean group;
146 };
147
148 union ActionData {
149     struct AnyAction any;
150     struct InteractiveAction inter;
151     struct InterDirectionalAction interdiraction;
152     struct DirectionalAction diraction;
153     struct Execute execute;
154     struct ClientAction client;
155     struct Activate activate;
156     struct MoveResizeRelative relative;
157     struct SendToDesktop sendto;
158     struct SendToDesktopDirection sendtodir;
159     struct Desktop desktop;
160     struct DesktopDirection desktopdir;
161     struct MoveResize moveresize;
162     struct ShowMenu showmenu;
163     struct CycleWindows cycle;
164     struct Layer layer;
165     struct Stacking stacking;
166 };
167
168 struct _ObAction {
169     guint ref;
170
171     /* The func member acts like an enum to tell which one of the structs in
172        the data union are valid.
173     */
174     void (*func)(union ActionData *data);
175     union ActionData data;
176 };
177
178 /* Creates a new Action from the name of the action
179    A few action types need data set after making this call still. Check if
180    the returned action's "func" is one of these.
181    action_execute - the path needs to be set
182    action_restart - the path can optionally be set
183    action_desktop - the destination desktop needs to be set
184    action_send_to_desktop - the destination desktop needs to be set
185    action_move_relative_horz - the delta
186    action_move_relative_vert - the delta
187    action_resize_relative_horz - the delta
188    action_resize_relative_vert - the delta
189    action_move_relative - the deltas
190    action_resize_relative - the deltas
191 */
192
193 ObAction* action_from_string(const gchar *name, ObUserAction uact);
194 ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
195                        ObUserAction uact);
196 void action_ref(ObAction *a);
197 void action_unref(ObAction *a);
198
199 ObAction* action_copy(const ObAction *a);
200
201 /*! Executes a list of actions.
202   @param c The client associated with the action. Can be NULL.
203   @param state The keyboard modifiers state at the time the user action occured
204   @param button The mouse button used to execute the action.
205   @param x The x coord at which the user action occured.
206   @param y The y coord at which the user action occured.
207   @param cancel If the action is cancelling an interactive action. This only
208          affects interactive actions, but should generally always be FALSE.
209   @param done If the action is completing an interactive action. This only
210          affects interactive actions, but should generally always be FALSE.
211 */
212 void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
213                      guint state, guint button, gint x, gint y, Time time,
214                      gboolean cancel, gboolean done);
215
216 #define action_run_mouse(a, c, n, s, b, x, y, t) \
217     action_run_list(a, c, n, s, b, x, y, t, FALSE, FALSE)
218
219 #define action_run_interactive(a, c, s, t, n, d) \
220     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, n, d)
221
222 #define action_run_key(a, c, s, x, y, t) \
223     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, t, FALSE, FALSE)
224
225 #define action_run(a, c, s, t) \
226     action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, t, FALSE, FALSE)
227
228 void action_run_string(const gchar *name, struct _ObClient *c, Time time);
229
230 /* Execute */
231 void action_execute(union ActionData *data);
232 /* ActivateAction */
233 void action_activate(union ActionData *data);
234 /* ClientAction */
235 void action_focus(union ActionData *data);
236 /* ClientAction */
237 void action_unfocus(union ActionData *data);
238 /* ClientAction */
239 void action_iconify(union ActionData *data);
240 /* ClientAction */
241 void action_focus_order_to_bottom(union ActionData *data);
242 /* ClientAction */
243 void action_raiselower(union ActionData *data);
244 /* ClientAction */
245 void action_raise(union ActionData *data);
246 /* ClientAction */
247 void action_lower(union ActionData *data);
248 /* ClientAction */
249 void action_close(union ActionData *data);
250 /* ClientAction */
251 void action_kill(union ActionData *data);
252 /* ClientAction */
253 void action_shade(union ActionData *data);
254 /* ClientAction */
255 void action_shadelower(union ActionData *data);
256 /* ClientAction */
257 void action_unshaderaise(union ActionData *data);
258 /* ClientAction */
259 void action_unshade(union ActionData *data);
260 /* ClientAction */
261 void action_toggle_shade(union ActionData *data);
262 /* ClientAction */
263 void action_toggle_omnipresent(union ActionData *data);
264 /* MoveResizeRelative */
265 void action_move_relative_horz(union ActionData *data);
266 /* MoveResizeRelative */
267 void action_move_relative_vert(union ActionData *data);
268 /* MoveResizeRelative */
269 void action_move_relative(union ActionData *data);
270 /* MoveResizeRelative */
271 void action_resize_relative(union ActionData *data);
272 /* ClientAction */
273 void action_move_to_center(union ActionData *data);
274 /* MoveResizeRelative */
275 void action_resize_relative_horz(union ActionData *data);
276 /* MoveResizeRelative */
277 void action_resize_relative_vert(union ActionData *data);
278 /* ClientAction */
279 void action_maximize_full(union ActionData *data);
280 /* ClientAction */
281 void action_unmaximize_full(union ActionData *data);
282 /* ClientAction */
283 void action_toggle_maximize_full(union ActionData *data);
284 /* ClientAction */
285 void action_maximize_horz(union ActionData *data);
286 /* ClientAction */
287 void action_unmaximize_horz(union ActionData *data);
288 /* ClientAction */
289 void action_toggle_maximize_horz(union ActionData *data);
290 /* ClientAction */
291 void action_maximize_vert(union ActionData *data);
292 /* ClientAction */
293 void action_unmaximize_vert(union ActionData *data);
294 /* ClientAction */
295 void action_toggle_maximize_vert(union ActionData *data);
296 /* ClientAction */
297 void action_toggle_fullscreen(union ActionData *data);
298 /* SendToDesktop */
299 void action_send_to_desktop(union ActionData *data);
300 /* SendToDesktopDirection */
301 void action_send_to_desktop_dir(union ActionData *data);
302 /* Desktop */
303 void action_desktop(union ActionData *data);
304 /* DesktopDirection */
305 void action_desktop_dir(union ActionData *data);
306 /* Any */
307 void action_desktop_last(union ActionData *data);
308 /* ClientAction */
309 void action_toggle_decorations(union ActionData *data);
310 /* MoveResize */
311 void action_moveresize(union ActionData *data);
312 /* Any */
313 void action_reconfigure(union ActionData *data);
314 /* Execute */
315 void action_restart(union ActionData *data);
316 /* Any */
317 void action_exit(union ActionData *data);
318 /* ShowMenu */
319 void action_showmenu(union ActionData *data);
320 /* CycleWindows */
321 void action_cycle_windows(union ActionData *data);
322 /* InterDirectionalAction */
323 void action_directional_focus(union ActionData *data);
324 /* DirectionalAction */
325 void action_movetoedge(union ActionData *data);
326 /* DirectionalAction */
327 void action_growtoedge(union ActionData *data);
328 /* Layer */
329 void action_send_to_layer(union ActionData *data);
330 /* Layer */
331 void action_toggle_layer(union ActionData *data);
332 /* Any */
333 void action_toggle_dockautohide(union ActionData *data);
334 /* Any */
335 void action_toggle_show_desktop(union ActionData *data);
336 /* Any */
337 void action_show_desktop(union ActionData *data);
338 /* Any */
339 void action_unshow_desktop(union ActionData *data);
340
341 #endif