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 void (*ObActionsDataFreeFunc
)(gpointer options
);
35 typedef gboolean (*ObActionsRunFunc
)(ObActionsData
*data
,
37 typedef gpointer (*ObActionsDataSetupFunc
)(xmlNodePtr node
);
39 /* functions for interactive actions */
40 typedef void (*ObActionsIPreFunc
)(gpointer options
);
41 typedef void (*ObActionsIPostFunc
)(gpointer options
);
42 typedef gboolean (*ObActionsIInputFunc
)(guint initial_state
,
46 typedef void (*ObActionsICancelFunc
)(gpointer options
);
47 typedef gpointer (*ObActionsIDataSetupFunc
)(xmlNodePtr node
,
48 ObActionsIPreFunc
*pre
,
49 ObActionsIInputFunc
*input
,
50 ObActionsICancelFunc
*cancel
,
51 ObActionsIPostFunc
*post
);
53 struct _ObActionsData
{
60 struct _ObClient
*client
;
61 ObFrameContext context
;
64 void actions_startup(gboolean reconfigure
);
65 void actions_shutdown(gboolean reconfigure
);
67 /*! Use this if the actions created from this name may be interactive */
68 gboolean
actions_register_i(const gchar
*name
,
69 ObActionsIDataSetupFunc setup
,
70 ObActionsDataFreeFunc free
,
71 ObActionsRunFunc run
);
73 gboolean
actions_register(const gchar
*name
,
74 ObActionsDataSetupFunc setup
,
75 ObActionsDataFreeFunc free
,
76 ObActionsRunFunc run
);
78 ObActionsAct
* actions_parse(xmlNodePtr node
);
79 ObActionsAct
* actions_parse_string(const gchar
*name
);
81 gboolean
actions_act_is_interactive(ObActionsAct
*act
);
83 void actions_act_ref(ObActionsAct
*act
);
84 void actions_act_unref(ObActionsAct
*act
);
86 /*! When this is true, an XAllowEvents with ReplayPointer will be called
87 if an action is going to maybe try moving windows around on screen (or
90 void actions_set_need_pointer_replay_before_move(gboolean replay
);
91 /*! Returns if a ReplayPointer is still needed. If it was called while running
92 actions then this will be false */
93 gboolean
actions_get_need_pointer_replay_before_move(void);
95 /*! Pass in a GSList of ObActionsAct's to be run. */
96 void actions_run_acts(GSList
*acts
,
103 struct _ObClient
*client
);
105 gboolean
actions_interactive_act_running(void);
106 void actions_interactive_cancel_act(void);
108 gboolean
actions_interactive_input_event(XEvent
*e
);
110 /*! Function for actions to call when they are moving a client around */
111 void actions_client_move(ObActionsData
*data
, gboolean start
);