add a NONE user action, for internal stuff, ie running actions without direct user...

[chaz/openbox] / openbox / action.h

diff --git a/openbox/action.h b/openbox/action.h
index 18525072b2755a8a05b4284002c690fd46b642bf..78f2176fc0df0722f181dfc67c90e263837d1042 100644 (file)
--- a/openbox/action.h
+++ b/openbox/action.h
@@ -1,3 +1,21 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   action.h for the Openbox window manager
+   Copyright (c) 2003        Ben Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
 #ifndef __action_h
 #define __action_h
 
@@ -14,8 +32,17 @@ typedef struct _ObAction ObAction;
    available (possibly NULL though) if it wants it.
 */
 
+typedef enum
+{
+    OB_CLIENT_ACTION_NO,
+    OB_CLIENT_ACTION_OPTIONAL,
+    OB_CLIENT_ACTION_ALWAYS
+} ObClientActionReq;
+
 struct AnyAction {
+    ObClientActionReq client_action;
     struct _ObClient *c;
+    ObFrameContext context;
     gboolean interactive;
     gint x;
     gint y;
@@ -72,7 +99,7 @@ struct SendToDesktopDirection {
 };
 
 struct Desktop {
-    struct AnyAction any;
+    struct InteractiveAction inter;
     guint desk;
 };
 
@@ -125,7 +152,8 @@ union ActionData {
 };
 
 struct _ObAction {
-    ObUserAction act;
+    guint ref;
+
     /* The func member acts like an enum to tell which one of the structs in
        the data union are valid.
     */
@@ -146,14 +174,16 @@ struct _ObAction {
    action_resize_relative_vert - the delta
 */
 
-ObAction *action_from_string(char *name, ObUserAction uact);
-ObAction *action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
+ObAction* action_from_string(const gchar *name, ObUserAction uact);
+ObAction* action_parse(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
                        ObUserAction uact);
-void action_free(ObAction *a);
+void action_ref(ObAction *a);
+void action_unref(ObAction *a);
+
+ObAction* action_copy(const ObAction *a);
 
-/*! Executes an action.
+/*! Executes a list of actions.
   @param c The client associated with the action. Can be NULL.
-  @param context The context in which the user action occured.
   @param state The keyboard modifiers state at the time the user action occured
   @param button The mouse button used to execute the action.
   @param x The x coord at which the user action occured.
@@ -163,22 +193,25 @@ void action_free(ObAction *a);
   @param done If the action is completing an interactive action. This only
          affects interactive actions, but should generally always be FALSE.
 */
-void action_run_full(ObAction *a, struct _ObClient *c,
-                     ObFrameContext context,
+void action_run_list(GSList *acts, struct _ObClient *c, ObFrameContext context,
                      guint state, guint button, gint x, gint y,
                      gboolean cancel, gboolean done);
 
-#define action_run_mouse(a, c, t, s, b, x, y) \
-    action_run_full(a, c, t, s, b, x, y, FALSE, FALSE)
+#define action_run_mouse(a, c, n, s, b, x, y) \
+    action_run_list(a, c, n, s, b, x, y, FALSE, FALSE)
 
 #define action_run_interactive(a, c, s, n, d) \
-    action_run_full(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, n, d)
+    action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, n, d)
 
 #define action_run_key(a, c, s, x, y) \
-    action_run_full(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, FALSE,FALSE)
+    action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, x, y, FALSE, FALSE)
 
 #define action_run(a, c, s) \
-    action_run_full(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, FALSE,FALSE)
+    action_run_list(a, c, OB_FRAME_CONTEXT_NONE, s, 0, -1, -1, FALSE, FALSE)
+
+/*! This is only for internal usage, i.e. not meant for user bindings and
+  such! */
+void action_run_string(const gchar *name, struct _ObClient *c);
 
 /* Execute */
 void action_execute(union ActionData *data);