add interactive action functions. some other changes to stuff that wasnt going to...
[dana/openbox.git] / openbox / actions.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    actions.h for the Openbox window manager
4    Copyright (c) 2007        Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #include "misc.h"
20 #include "frame.h"
21 #include "parser/parse.h"
22 #include <glib.h>
23 #include <X11/Xlib.h>
24
25 typedef struct _ObActionsDefinition   ObActionsDefinition;
26 typedef struct _ObActionsAct          ObActionsAct;
27 typedef struct _ObActionsData         ObActionsData;
28 typedef struct _ObActionsAnyData      ObActionsAnyData;
29 typedef struct _ObActionsGlobalData   ObActionsGlobalData;
30 typedef struct _ObActionsClientData   ObActionsClientData;
31 typedef struct _ObActionsSelectorData ObActionsSelectorData;
32
33 typedef gpointer (*ObActionsDataSetupFunc)(ObParseInst *i,
34                                            xmlDocPtr doc, xmlNodePtr node);
35 typedef void     (*ObActionsDataFreeFunc)(gpointer options);
36 typedef gboolean (*ObActionsRunFunc)(ObActionsData *data,
37                                      gpointer options);
38 typedef gboolean (*ObActionsInteractiveInputFunc)(guint initial_state,
39                                                   XEvent *e,
40                                                   gpointer options);
41 typedef void     (*ObActionsInteractiveCancelFunc)(gpointer options);
42
43 typedef enum {
44     OB_ACTION_TYPE_GLOBAL,
45     OB_ACTION_TYPE_CLIENT
46 } ObActionsType;
47
48 /* These structures are all castable as eachother */
49
50 struct _ObActionsAnyData {
51     ObUserAction uact;
52     Time time;
53     guint state;
54     gint x;
55     gint y;
56 };
57
58 struct _ObActionsGlobalData {
59     ObActionsType type;
60     ObActionsAnyData any;
61 };
62
63 struct _ObActionsClientData {
64     ObActionsType type;
65     ObActionsAnyData any;
66
67     struct _ObClient *c;
68     ObFrameContext context;
69 };
70
71 struct _ObActionsData {
72     ObActionsType type;
73
74     union {
75         ObActionsAnyData      any;
76         ObActionsGlobalData   global;
77         ObActionsClientData   client;
78     };
79 };
80
81 void actions_startup(gboolean reconfigure);
82 void actions_shutdown(gboolean reconfigure);
83
84 /*! If the action is interactive, then i_input and i_cancel are not NULL.
85   Otherwise, they should both be NULL. */
86 gboolean actions_register(const gchar *name,
87                           ObActionsType type,
88                           ObActionsDataSetupFunc setup,
89                           ObActionsDataFreeFunc free,
90                           ObActionsRunFunc run,
91                           ObActionsInteractiveInputFunc i_input,
92                           ObActionsInteractiveCancelFunc i_cancel);
93
94 ObActionsAct* actions_parse(ObParseInst *i,
95                             xmlDocPtr doc,
96                             xmlNodePtr node);
97 ObActionsAct* actions_parse_string(const gchar *name);
98
99 gboolean actions_act_is_interactive(ObActionsAct *act);
100
101 void actions_act_ref(ObActionsAct *act);
102 void actions_act_unref(ObActionsAct *act);
103
104 /*! Pass in a GSList of ObActionsAct's to be run.
105   @return TRUE if an action is in interactive state, FALSE is none are
106 */
107 void actions_run_acts(GSList *acts,
108                       ObUserAction uact,
109                       Time time,
110                       guint state,
111                       gint x,
112                       gint y,
113                       ObFrameContext con,
114                       struct _ObClient *client);