1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/* Copyright (C) 2012 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <glibmm/interface.h>
#include <giomm/simpleaction.h>
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/interface_p.h)
_PINCLUDE(gio/gio.h)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GActionMapInterface GActionMapInterface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
class GIOMM_API Action;
//TODO: Instead derive from ActionGroup, when we can break ABI,
//because the GActionMap interface requires the GActionGroup interface.
//LoadableIcon does a similar thing correctly, for instance.
/** ActionMap - Interface for action containers.
* The ActionMap interface is implemented by ActionGroup implementations that
* operate by containing a number of named Action instances, such as
* SimpleActionGroup.
*
* One useful application of this interface is to map the names of actions from
* various action groups to unique, prefixed names (e.g. by prepending "app."
* or "win."). This is the motivation for the 'Map' part of the interface name.
* @newin{2,32}
*/
class GIOMM_API ActionMap : public Glib::Interface
{
_CLASS_INTERFACE(ActionMap, GActionMap, G_ACTION_MAP, GActionMapInterface, , , GIOMM_API)
// The various add_action...() methods are our equivalent for g_action_map_add_action_entries().
_IGNORE(g_action_map_add_action_entries)
public:
_WRAP_METHOD(void add_action(const Glib::RefPtr<Action>& action), g_action_map_add_action)
_WRAP_METHOD(void remove_action(const Glib::ustring& action_name), g_action_map_remove_action)
_WRAP_METHOD(Glib::RefPtr<Action> lookup_action(const Glib::ustring& action_name), g_action_map_lookup_action, refreturn)
_WRAP_METHOD(Glib::RefPtr<const Action> lookup_action(const Glib::ustring& action_name) const, g_action_map_lookup_action, constversion, refreturn)
/** A convenience method for creating a SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action(const Glib::ustring& name);
/** A Slot to be called when an action has been activated,
* without passing a parameter to the slot.
* See add_action() and add_action_bool().
*
* For instance,
* void on_slot_activated();
*/
using ActivateSlot = sigc::slot<void>;
/** A convenience method for creating a SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action(const Glib::ustring& name, const ActivateSlot& slot);
/** A Slot to be called when an action has been activated,
* passing a parameter of a specified type.
* See add_action_with_parameter().
*
* For instance,
* void on_slot_activated(const Glib::VariantBase& parameter);
*/
using ActivateWithParameterSlot = sigc::slot<void, const Glib::VariantBase&>;
_DEPRECATE_IFDEF_START
/** A convenience method for creating a SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @return The Action.
*
* @deprecated This overload does not work as it does not set a parameter
* type on the Action, so activating it with a parameter cannot work. Use the
* other add_action_with_parameter() overload, which takes a parameter type.
*/
Glib::RefPtr<SimpleAction> add_action_with_parameter(const Glib::ustring& name, const ActivateWithParameterSlot& slot);
_DEPRECATE_IFDEF_END
/** A convenience method for creating a SimpleAction instance, which when
* activated will call a slot receiving a given type of parameter, and adding
* that SimpleAction to the ActionMap.
*
* @param name The name of the Action.
* @param parameter_type The type of parameter to be passed to the slot.
* @param slot The callback method to be called when the action is activated.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_with_parameter(const Glib::ustring& name, const Glib::VariantType& parameter_type, const ActivateWithParameterSlot& slot);
/** A convenience method for creating a boolean-stateful SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_bool(const Glib::ustring& name, bool state = false);
/** A convenience method for creating a boolean-stateful (toggle) SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_bool(const Glib::ustring& name, const ActivateSlot& slot, bool state = false);
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating a string-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_radio_string(const Glib::ustring& name, const Glib::ustring& state);
/** A Slot to be called when an action has been activated.
* See add_action_radio_string().
*
* For instance,
* void on_slot_activated(const Glib::ustring& parameter);
*/
using ActivateWithStringParameterSlot = sigc::slot<void, const Glib::ustring&>;
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating a string-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_radio_string(const Glib::ustring& name, const ActivateWithStringParameterSlot& slot, const Glib::ustring& state);
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating an integer-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_radio_integer(const Glib::ustring& name, gint32 state);
/** A Slot to be called when an action has been activated.
* See add_action_radio_integer().
*
* For instance,
* void on_slot_activated(int parameter);
*/
using ActivateWithIntParameterSlot = sigc::slot<void, int>;
//TODO: Docs: Add hints about how to specify the various possible states in the GtkBuilder XML.
/** A convenience method for creating an integer-based radio SimpleAction instance
* and adding it to the ActionMap.
*
* @param name The name of the Action.
* @param slot The callback method to be called when the action is activated.
* @param state The initial state.
* @return The Action.
*/
Glib::RefPtr<SimpleAction> add_action_radio_integer(const Glib::ustring& name, const ActivateWithIntParameterSlot& slot, gint32 state);
#m4 _CONVERSION(`Glib::RefPtr<Action>', `GAction*', `Glib::unwrap($3)')
_WRAP_VFUNC(Glib::RefPtr<Action> lookup_action(const Glib::ustring& name) const, "lookup_action", refreturn)
//TODO: Change this to use const & when we can break ABI.
// ( Changing it causes a symbol lookup error when trying to run already-built applications. )
#m4 _CONVERSION(`GAction*', `Glib::RefPtr<Action>', `Glib::wrap($3, true)')
_WRAP_VFUNC(void add_action(Glib::RefPtr<Action> action) const, "add_action")
_WRAP_VFUNC(void remove_action(const Glib::ustring& name), "remove_action")
};
} // namespace Gio
|
