add 'movetoedge' actions
[mikachu/openbox.git] / openbox / action.h
1 #ifndef __action_h
2 #define __action_h
3
4 #include "client.h"
5
6 /* These have to all have a Client* at the top even if they don't use it, so
7    that I can set it blindly later on. So every function will have a Client*
8    available (possibly NULL though) if it wants it.
9 */
10
11 struct AnyAction {
12     Client *c;
13 };
14
15 struct DirectionalAction{
16     Client *c;
17     int direction;
18 };
19
20 struct Execute {
21     Client *c;
22     char *path;
23 };
24
25 struct ClientAction {
26     Client *c;
27 };
28
29 struct MoveResizeRelative {
30     Client *c;
31     int delta;
32 };
33
34 struct SendToDesktop {
35     Client *c;
36     guint desk;
37     gboolean follow;
38 };
39
40 struct SendToNextPreviousDesktop {
41     Client *c;
42     gboolean wrap;
43     gboolean follow;
44 };
45
46 struct Desktop {
47     Client *c;
48     guint desk;
49 };
50
51 struct NextPreviousDesktop {
52     Client *c;
53     gboolean wrap;
54 };
55
56 struct MoveResize {
57     Client *c;
58     int x;
59     int y;
60     guint32 corner; /* prop_atoms.net_wm_moveresize_* */
61     guint button;
62 };
63
64 struct ShowMenu {
65     Client *c;
66     char *name;
67     int x;
68     int y;
69 };
70
71 struct CycleWindows {
72     Client *c;
73     gboolean linear;
74     gboolean forward;
75     gboolean final;
76     gboolean cancel;
77 };
78
79 union ActionData {
80     struct AnyAction any;
81     struct DirectionalAction diraction;
82     struct Execute execute;
83     struct ClientAction client;
84     struct MoveResizeRelative relative;
85     struct SendToDesktop sendto;
86     struct SendToNextPreviousDesktop sendtonextprev;
87     struct Desktop desktop;
88     struct NextPreviousDesktop nextprevdesktop;
89     struct MoveResize moveresize;
90     struct ShowMenu showmenu;
91     struct CycleWindows cycle;
92 };
93
94 typedef struct {
95     /* The func member acts like an enum to tell which one of the structs in
96        the data union are valid.
97     */
98     void (*func)(union ActionData *data);
99     union ActionData data;
100 } Action;
101
102 Action *action_new(void (*func)(union ActionData *data));
103
104 /* Creates a new Action from the name of the action
105    A few action types need data set after making this call still. Check if
106    the returned action's "func" is one of these.
107    action_execute - the path needs to be set
108    action_restart - the path can optionally be set
109    action_desktop - the destination desktop needs to be set
110    action_move_relative_horz - the delta
111    action_move_relative_vert - the delta
112    action_resize_relative_horz - the delta
113    action_resize_relative_vert - the delta
114 */
115
116 Action *action_from_string(char *name);
117 void action_free(Action *a);
118
119 /* Execute */
120 void action_execute(union ActionData *data);
121 /* ClientAction */
122 void action_focus(union ActionData *data);
123 /* ClientAction */
124 void action_unfocus(union ActionData *data);
125 /* ClientAction */
126 void action_iconify(union ActionData *data);
127 /* ClientAction */
128 void action_raise(union ActionData *data);
129 /* ClientAction */
130 void action_lower(union ActionData *data);
131 /* ClientAction */
132 void action_focusraise(union ActionData *data);
133 /* ClientAction */
134 void action_close(union ActionData *data);
135 /* ClientAction */
136 void action_kill(union ActionData *data);
137 /* ClientAction */
138 void action_shade(union ActionData *data);
139 /* ClientAction */
140 void action_shadelower(union ActionData *data);
141 /* ClientAction */
142 void action_unshaderaise(union ActionData *data);
143 /* ClientAction */
144 void action_unshade(union ActionData *data);
145 /* ClientAction */
146 void action_toggle_shade(union ActionData *data);
147 /* ClientAction */
148 void action_toggle_omnipresent(union ActionData *data);
149 /* MoveResizeRelative */
150 void action_move_relative_horz(union ActionData *data);
151 /* MoveResizeRelative */
152 void action_move_relative_vert(union ActionData *data);
153 /* MoveResizeRelative */
154 void action_resize_relative_horz(union ActionData *data);
155 /* MoveResizeRelative */
156 void action_resize_relative_vert(union ActionData *data);
157 /* ClientAction */
158 void action_maximize_full(union ActionData *data);
159 /* ClientAction */
160 void action_unmaximize_full(union ActionData *data);
161 /* ClientAction */
162 void action_toggle_maximize_full(union ActionData *data);
163 /* ClientAction */
164 void action_maximize_horz(union ActionData *data);
165 /* ClientAction */
166 void action_unmaximize_horz(union ActionData *data);
167 /* ClientAction */
168 void action_toggle_maximize_horz(union ActionData *data);
169 /* ClientAction */
170 void action_maximize_vert(union ActionData *data);
171 /* ClientAction */
172 void action_unmaximize_vert(union ActionData *data);
173 /* ClientAction */
174 void action_toggle_maximize_vert(union ActionData *data);
175 /* SendToDesktop */
176 void action_send_to_desktop(union ActionData *data);
177 /* SendToNextPreviousDesktop */
178 void action_send_to_next_desktop(union ActionData *data);
179 /* SendToNextPreviousDesktop */
180 void action_send_to_previous_desktop(union ActionData *data);
181 /* Desktop */
182 void action_desktop(union ActionData *data);
183 /* NextPreviousDesktop */
184 void action_next_desktop(union ActionData *data);
185 /* NextPreviousDesktop */
186 void action_previous_desktop(union ActionData *data);
187 /* NextPreviousDesktop */
188 void action_next_desktop_column(union ActionData *data);
189 /* NextPreviousDesktop */
190 void action_previous_desktop_column(union ActionData *data);
191 /* NextPreviousDesktop */
192 void action_next_desktop_row(union ActionData *data);
193 /* NextPreviousDesktop */
194 void action_previous_desktop_row(union ActionData *data);
195 /* ClientAction */
196 void action_toggle_decorations(union ActionData *data);
197 /* MoveResize */
198 void action_moveresize(union ActionData *data);
199 /* Execute */
200 void action_restart(union ActionData *data);
201 /* Any */
202 void action_exit(union ActionData *data);
203 /* ShowMenu */
204 void action_showmenu(union ActionData *data);
205 /* CycleWindows */
206 void action_cycle_windows(union ActionData *data);
207
208 void action_directional_focus(union ActionData *data);
209 void action_movetoedge(union ActionData *data);
210 #endif