1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 actions.h for the Openbox window manager
4 Copyright (c) 2007 Dana Jansens
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.
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.
16 See the COPYING file for a copy of the GNU General Public License.
21 #include "obt/parse.h"
26 typedef struct _ObActionsDefinition ObActionsDefinition;
27 typedef struct _ObActionsAct ObActionsAct;
28 typedef struct _ObActionsData ObActionsData;
29 typedef struct _ObActionsAnyData ObActionsAnyData;
30 typedef struct _ObActionsGlobalData ObActionsGlobalData;
31 typedef struct _ObActionsClientData ObActionsClientData;
32 typedef struct _ObActionsSelectorData ObActionsSelectorData;
34 typedef gpointer (*ObActionsDataSetupFunc)(xmlNodePtr node);
35 typedef void (*ObActionsDataFreeFunc)(gpointer options);
36 typedef gboolean (*ObActionsRunFunc)(ObActionsData *data,
38 typedef gboolean (*ObActionsInteractiveInputFunc)(guint initial_state,
42 typedef void (*ObActionsInteractiveCancelFunc)(gpointer options);
44 struct _ObActionsData {
51 struct _ObClient *client;
52 ObFrameContext context;
55 void actions_startup(gboolean reconfigure);
56 void actions_shutdown(gboolean reconfigure);
58 /*! If the action is interactive, then i_input and i_cancel are not NULL.
59 Otherwise, they should both be NULL. */
60 gboolean actions_register(const gchar *name,
61 ObActionsDataSetupFunc setup,
62 ObActionsDataFreeFunc free,
64 ObActionsInteractiveInputFunc i_input,
65 ObActionsInteractiveCancelFunc i_cancel);
67 ObActionsAct* actions_parse(xmlNodePtr node);
68 ObActionsAct* actions_parse_string(const gchar *name);
70 gboolean actions_act_is_interactive(ObActionsAct *act);
72 void actions_act_ref(ObActionsAct *act);
73 void actions_act_unref(ObActionsAct *act);
75 /*! When this is true, an XAllowEvents with ReplayPointer will be called
76 if an action is going to maybe try moving windows around on screen (or
79 void actions_set_need_pointer_replay_before_move(gboolean replay);
80 /*! Returns if a ReplayPointer is still needed. If it was called while running
81 actions then this will be false */
82 gboolean actions_get_need_pointer_replay_before_move();
84 /*! Pass in a GSList of ObActionsAct's to be run. */
85 void actions_run_acts(GSList *acts,
92 struct _ObClient *client);
94 gboolean actions_interactive_act_running();
95 void actions_interactive_cancel_act();
97 gboolean actions_interactive_input_event(XEvent *e);
99 /*! Function for actions to call when they are moving a client around */
100 void actions_client_move(ObActionsData *data, gboolean start);