6 #include "parser/parse.h"
10 typedef struct _ObAction ObAction;
12 /* These have to all have a Client* at the top even if they don't use it, so
13 that I can set it blindly later on. So every function will have a Client*
14 available (possibly NULL though) if it wants it.
25 struct InteractiveAction {
31 struct InterDirectionalAction{
32 struct InteractiveAction inter;
33 ObDirection direction;
36 struct DirectionalAction{
38 ObDirection direction;
52 gboolean here; /* bring it to the current desktop */
55 struct MoveResizeRelative {
60 struct SendToDesktop {
66 struct SendToDesktopDirection {
67 struct InteractiveAction inter;
81 int layer; /* < 0 = below, 0 = normal, > 0 = above */
84 struct DesktopDirection {
85 struct InteractiveAction inter;
102 struct CycleWindows {
103 struct InteractiveAction inter;
109 struct AnyAction any;
110 struct InteractiveAction inter;
111 struct InterDirectionalAction interdiraction;
112 struct DirectionalAction diraction;
113 struct Execute execute;
114 struct ClientAction client;
115 struct Activate activate;
116 struct MoveResizeRelative relative;
117 struct SendToDesktop sendto;
118 struct SendToDesktopDirection sendtodir;
119 struct Desktop desktop;
120 struct DesktopDirection desktopdir;
121 struct MoveResize moveresize;
122 struct ShowMenu showmenu;
123 struct CycleWindows cycle;
129 /* The func member acts like an enum to tell which one of the structs in
130 the data union are valid.
132 void (*func)(union ActionData *data);
133 union ActionData data;
136 /* Creates a new Action from the name of the action
137 A few action types need data set after making this call still. Check if
138 the returned action's "func" is one of these.
139 action_execute - the path needs to be set
140 action_restart - the path can optionally be set
141 action_desktop - the destination desktop needs to be set
142 action_send_to_desktop - the destination desktop needs to be set
143 action_move_relative_horz - the delta
144 action_move_relative_vert - the delta
145 action_resize_relative_horz - the delta
146 action_resize_relative_vert - the delta
149 ObAction *action_from_string(char *name, ObUserAction uact);
150 ObAction *action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
152 void action_free(ObAction *a);
154 /*! Executes an action.
155 @param c The client associated with the action. Can be NULL.
156 @param state The keyboard modifiers state at the time the user action occured
157 @param button The mouse button used to execute the action.
158 @param x The x coord at which the user action occured.
159 @param y The y coord at which the user action occured.
160 @param cancel If the action is cancelling an interactive action. This only
161 affects interactive actions, but should generally always be FALSE.
162 @param done If the action is completing an interactive action. This only
163 affects interactive actions, but should generally always be FALSE.
165 void action_run_full(ObAction *a, struct _ObClient *c,
166 guint state, guint button, gint x, gint y,
167 gboolean cancel, gboolean done);
169 #define action_run_mouse(a, c, s, b, x, y) \
170 action_run_full(a, c, s, b, x, y, FALSE, FALSE)
172 #define action_run_interactive(a, c, s, n, d) \
173 action_run_full(a, c, s, 0, -1, -1, n, d)
175 #define action_run_key(a, c, s, x, y) \
176 action_run_full(a, c, s, 0, x, y, FALSE,FALSE)
178 #define action_run(a, c, s) \
179 action_run_full(a, c, s, 0, -1, -1, FALSE,FALSE)
182 void action_execute(union ActionData *data);
184 void action_activate(union ActionData *data);
186 void action_focus(union ActionData *data);
188 void action_unfocus(union ActionData *data);
190 void action_iconify(union ActionData *data);
192 void action_raiselower(union ActionData *data);
194 void action_raise(union ActionData *data);
196 void action_lower(union ActionData *data);
198 void action_close(union ActionData *data);
200 void action_kill(union ActionData *data);
202 void action_shade(union ActionData *data);
204 void action_shadelower(union ActionData *data);
206 void action_unshaderaise(union ActionData *data);
208 void action_unshade(union ActionData *data);
210 void action_toggle_shade(union ActionData *data);
212 void action_toggle_omnipresent(union ActionData *data);
213 /* MoveResizeRelative */
214 void action_move_relative_horz(union ActionData *data);
215 /* MoveResizeRelative */
216 void action_move_relative_vert(union ActionData *data);
217 /* MoveResizeRelative */
218 void action_resize_relative_horz(union ActionData *data);
219 /* MoveResizeRelative */
220 void action_resize_relative_vert(union ActionData *data);
222 void action_maximize_full(union ActionData *data);
224 void action_unmaximize_full(union ActionData *data);
226 void action_toggle_maximize_full(union ActionData *data);
228 void action_maximize_horz(union ActionData *data);
230 void action_unmaximize_horz(union ActionData *data);
232 void action_toggle_maximize_horz(union ActionData *data);
234 void action_maximize_vert(union ActionData *data);
236 void action_unmaximize_vert(union ActionData *data);
238 void action_toggle_maximize_vert(union ActionData *data);
240 void action_send_to_desktop(union ActionData *data);
241 /* SendToDesktopDirection */
242 void action_send_to_desktop_dir(union ActionData *data);
244 void action_desktop(union ActionData *data);
245 /* DesktopDirection */
246 void action_desktop_dir(union ActionData *data);
248 void action_desktop_last(union ActionData *data);
250 void action_toggle_decorations(union ActionData *data);
252 void action_moveresize(union ActionData *data);
254 void action_reconfigure(union ActionData *data);
256 void action_restart(union ActionData *data);
258 void action_exit(union ActionData *data);
260 void action_showmenu(union ActionData *data);
262 void action_cycle_windows(union ActionData *data);
263 /* InterDirectionalAction */
264 void action_directional_focus(union ActionData *data);
265 /* DirectionalAction */
266 void action_movetoedge(union ActionData *data);
267 /* DirectionalAction */
268 void action_growtoedge(union ActionData *data);
270 void action_send_to_layer(union ActionData *data);
272 void action_toggle_layer(union ActionData *data);
274 void action_toggle_show_desktop(union ActionData *data);
276 void action_show_desktop(union ActionData *data);
278 void action_unshow_desktop(union ActionData *data);