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
|
/* Copyright (C) 2011 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, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/action.h>
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/object_p.h)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GSimpleAction GSimpleAction;
typedef GObjectClass GSimpleActionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** SimpleAction - A simple Action implementation.
* A SimpleAction is the obvious simple implementation of the Action
* interface. This is the easiest way to create an action for purposes of
* adding it to a SimpleActionGroup.
*
* See also Gtk::Action.
*
* @newin{2,32}
*/
class SimpleAction : public Glib::Object, public Action
{
_CLASS_GOBJECT(SimpleAction, GSimpleAction, G_SIMPLE_ACTION, Glib::Object, GObject)
_IMPLEMENTS_INTERFACE(Action)
_STRUCT_NOT_HIDDEN
protected:
/** Creates a new action.
*
* The created action is stateless.
*
* @param name The name of the action.
*/
explicit SimpleAction(const Glib::ustring& name);
/** Creates a new new stateful action.
*
* The created action is stateless.
*
* @a state is the initial state of the action. All future state values
* must have the same VariantType as the initial state.
*
* @param name The name of the action.
* @param state The initial state of the action.
*/
SimpleAction(const Glib::ustring& name, const Glib::VariantBase& state);
#m4 _CONVERSION(`const Glib::VariantType&',`const GVariantType*',`$3.gobj()')
_WRAP_CTOR(SimpleAction(const Glib::ustring& name, const Glib::VariantType& parameter_type), g_simple_action_new)
_WRAP_CTOR(SimpleAction(const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& state), g_simple_action_new_stateful)
public:
_WRAP_CREATE(const Glib::ustring& name)
_WRAP_METHOD_DOCS_ONLY(g_simple_action_new)
_WRAP_CREATE(const Glib::ustring& name, const Glib::VariantType& parameter_type)
//TODO: Add a templated version of this to avoid the need fo Gio::Variant by the caller.
_WRAP_METHOD_DOCS_ONLY(g_simple_action_new_stateful)
_WRAP_CREATE(const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& state)
//TODO: Add a templated version of this to avoid the need fo Gio::Variant by the caller.
/** Creates a new stateful action.
*
* @a state is the initial state of the action. All future state values
* must have the same VariantType as the initial state.
*
* @newin{2,38}
*
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
*/
_WRAP_CREATE(const Glib::ustring& name, const Glib::VariantBase& state)
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Document how the app must handle signal_activate() to call change_state().
/** Creates a new boolean stateful action.
*
* @a state is the initial state of the action. All future state values
* must also be bool.
*
* @newin{2,38}
*
* @param name The name of the action.
* @param state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_bool(const Glib::ustring&name, bool state = false);
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Create convenience API that auto-changes the state, like Gtk::TreeView's append_column_editable()?
// See https://bugzilla.gnome.org/show_bug.cgi?id=705133 (it's not documented clearly at all).
//TODO: Check whether glib now has API to use enums for this: See https://bugzilla.gnome.org/show_bug.cgi?id=705483
//TODO: Suggest other API that could be used to activate or discover the currently-select radio value.
/** Creates a new radio action with a string-based target value.
*
* @newin{2,38}
*
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_radio_string(const Glib::ustring& name, const Glib::ustring& initial_state);
//TODO: Use similar C API if they ever add it. Doing this manually is tedious. See https://bugzilla.gnome.org/show_bug.cgi?id=705655
//TODO: Create a derived SimpleToggleAction class for this?
//TODO: Create convenience API that auto-changes the state, like Gtk::TreeView's append_column_editable()?
// See https://bugzilla.gnome.org/show_bug.cgi?id=705133 (it's not documented clearly at all).
//TODO: Check whether glib now has API to use enums for this: See https://bugzilla.gnome.org/show_bug.cgi?id=705483
//TODO: Suggest other API that could be used to activate or discover the currently-select radio value.
//TODO: Check that the need for type="i" in the XML is documented: See https://bugzilla.gnome.org/show_bug.cgi?id=704392#c14
/** Creates a new radio action with an integer-based target value.
*
* @newin{2,38}
*
* @param name The name of the action.
* @param initial_state The initial state of the action.
* @return A new SimpleAction.
*/
static Glib::RefPtr<SimpleAction> create_radio_integer(const Glib::ustring& name, gint32 initial_state);
_WRAP_METHOD(void set_enabled(bool enabled = true), g_simple_action_set_enabled)
_WRAP_PROPERTY("enabled", bool)
_WRAP_PROPERTY("name", Glib::ustring)
_WRAP_PROPERTY("parameter-type", Glib::VariantType)
_WRAP_PROPERTY("state", Glib::VariantBase)
_WRAP_PROPERTY("state-type", Glib::VariantType)
#m4 _CONVERSION(`GVariant*',`const Glib::VariantBase&',`Glib::wrap($3, true)')
_WRAP_SIGNAL(void activate(const Glib::VariantBase& parameter), "activate", no_default_handler)
_WRAP_SIGNAL(void change_state(const Glib::VariantBase& value), "change-state", no_default_handler)
protected:
//TODO: Add templated version of this, renaming this to set_state_variant(), like Action::change_state()?
//This is protected because the C docs say "This should only be called by the implementor of the action."
// though that is not entirely clear. We can make this public if somebody needs it.
_WRAP_METHOD(void set_state(const Glib::VariantBase& value), g_simple_action_set_state)
};
} // namespace Gio
|
