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
215
216
217
218
219
220
221
222
|
/* 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/>.
*/
_CONFIGINCLUDE(giommconfig.h)
#include <glibmm/object.h>
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/object_p.h)
namespace Gio
{
class GIOMM_API MenuAttributeIter;
class GIOMM_API MenuLinkIter;
/** MenuModel - An abstract class representing the contents of a menu.
* MenuModel represents the contents of a menu -- an ordered list of menu
* items. The items are associated with actions, which can be activated through
* them. Items can be grouped in sections, and may have submenus associated
* with them. Both items and sections usually have some representation data,
* such as labels or icons. The type of the associated action (ie whether it is
* stateful, and what kind of state it has) can influence the representation of
* the item.
*
* The conceptual model of menus in MenuModel is hierarchical: sections and
* submenus are again represented by MenuModels. Menus themselves do not define
* their own roles. Rather, the role of a particular MenuModel is defined by
* the item that references it (or, in the case of the 'root' menu, is defined
* by the context in which it is used).
*
* The motivation for this abstract model of application controls is that
* modern user interfaces tend to make these controls available outside the
* application. Examples include global menus, jumplists, dash boards, etc. To
* support such uses, it is necessary to 'export' information about actions and
* their representation in menus, which is exactly what
* Gio::DBus::Connection::export_action_group() and the
* Gio::DBus::Connection::export_menu_model() do for ActionGroup and MenuModel.
* The client-side counterparts to make use of the exported information are
* Gio::DBus::ActionGroup and Gio::DBus::MenuModel.
*
* The API of MenuModel is very generic, with iterators for the attributes and
* links of an item, see iterate_item_attributes() and iterate_item_links().
* The 'standard' attributes and link types have predefined names,
* listed in the enums Gio::MenuModel::Attribute and Gio::MenuModel::Link.
*
* Items in a MenuModel represent active controls if they refer to an action
* that can get activated when the user interacts with the menu item. The
* reference to the action is encoded by the string id in the
* Gio::MenuModel::Attribute::ACTION attribute. An action id uniquely identifies an
* action in an action group. Which action group(s) provide actions depends on
* the context in which the menu model is used. E.g. when the model is exported
* as the application menu of a Gtk::Application, actions can be
* application-wide or window-specific (and thus come from two different action
* groups). By convention, the application-wide actions have names that start
* with "app.", while the names of window-specific actions start with "win.".
*
* While a wide variety of stateful actions is possible, the following is the
* minimum that is expected to be supported by all users of exported menu
* information:
*
* - an action with no parameter type and no state
* - an action with no parameter type and boolean state
* - an action with string parameter type and string state
*
* <b>Stateless.</b> A stateless action typically corresponds to an ordinary
* menu item. Selecting such a menu item will activate the action (with no
* parameter).
*
* <b>Boolean State.</b> An action with a boolean state will most typically be
* used with a "toggle" or "switch" menu item. The state can be set directly,
* but activating the action (with no parameter) results in the state being
* toggled. Selecting a toggle menu item will activate the action. The menu
* item should be rendered as "checked" when the state is true.
*
* <b>String Parameter and State.</b> Actions with string parameters and state
* will most typically be used to represent an enumerated choice over the items
* available for a group of radio menu items. Activating the action with a
* string parameter is equivalent to setting that parameter as the state. Radio
* menu items, in addition to being associated with the action, will have a
* target value. Selecting that menu item will result in activation of the
* action with the target value as the parameter. The menu item should be
* rendered as "selected" when the state of the action is equal to the target
* value of the menu item.
*
* See the C API docs for a graphical example.
* @newin{2,32}
*/
class GIOMM_API MenuModel : public Glib::Object
{
_CLASS_GOBJECT(MenuModel, GMenuModel, G_MENU_MODEL, Glib::Object, GObject, , , GIOMM_API)
protected:
_CTOR_DEFAULT
public:
// Keep the enum values in sync with giomm_get_menu_attribute() in menumodel.ccg.
/** Attributes in Gio::MenuModel::get_item_attribute().
*
* @ingroup giommEnums
*/
enum class Attribute
{
/** The "action" menu attribute.
*
* The menu item attribute which holds the action name of the item. %Action
* names are namespaced with an identifier for the action group in which the
* action resides. For example, "win." for window-specific actions and "app."
* for application-wide actions.
*/
ACTION,
/** The "label" menu attribute.
*
* The menu item attribute which holds the label of the item.
*/
LABEL,
/** The "target" menu attribute.
*
* The menu item attribute which holds the target with which the item's action
* will be activated.
*/
TARGET,
/** The "action-namespace" menu attribute.
*
* The menu item attribute that holds the namespace for all action names in
* menus that are linked from this item.
*
* @newin{2,66}
*/
ACTION_NAMESPACE,
/** The "icon" menu attribute.
*
* The menu item attribute which holds the icon of the item.
*
* The icon is stored in the format returned by Gio::Icon::serialize().
*
* This attribute is intended only to represent 'noun' icons such as
* favicons for a webpage, or application icons. It should not be used
* for 'verbs' (ie: stock icons).
*
* @newin{2,66}
*/
ICON,
};
// Keep the enum values in sync with giomm_get_menu_link() in menumodel.ccg.
/** %Link types in Gio::MenuModel::get_item_link().
*
* @ingroup giommEnums
*/
enum class Link
{
/** The "section" menu link.
*
* The name of the link that associates a menu item with a section. The linked
* menu will usually be shown in place of the menu item, using the item's label
* as a header.
*/
SECTION,
/** The "submenu" menu link.
*
* The name of the link that associates a menu item with a submenu.
*/
SUBMENU
};
#m4begin
dnl See the .ccg implementation for how this conversion works.
_CONVERSION(`Attribute',`const gchar*',`giomm_get_menu_attribute($3)')
#m4end
//TODO: Add a get_item_attribute() templated method to get values directly
//instead of returning a Glib::VariantBase?
_WRAP_METHOD(Glib::VariantBase get_item_attribute(int item_index, Attribute attribute,
const Glib::VariantType& expected_type) const, g_menu_model_get_item_attribute_value)
// Ignore varargs function
_IGNORE(g_menu_model_get_item_attribute)
#m4begin
dnl See the .ccg implementation for how this conversion works.
_CONVERSION(`Link',`const gchar*',`giomm_get_menu_link($3)')
#m4end
_WRAP_METHOD(Glib::RefPtr<MenuModel> get_item_link(int item_index, Link link), g_menu_model_get_item_link)
_WRAP_METHOD(Glib::RefPtr<const MenuModel> get_item_link(int item_index, Link link) const,
g_menu_model_get_item_link, constversion)
_WRAP_METHOD(bool is_mutable() const, g_menu_model_is_mutable)
_WRAP_METHOD(int get_n_items() const, g_menu_model_get_n_items)
_WRAP_METHOD(Glib::RefPtr<MenuAttributeIter> iterate_item_attributes(int item_index), g_menu_model_iterate_item_attributes)
_WRAP_METHOD(Glib::RefPtr<const MenuAttributeIter> iterate_item_attributes(int item_index) const, g_menu_model_iterate_item_attributes, constversion)
_WRAP_METHOD(Glib::RefPtr<MenuLinkIter> iterate_item_links(int item_index), g_menu_model_iterate_item_links)
_WRAP_METHOD(Glib::RefPtr<const MenuLinkIter> iterate_item_links(int item_index) const, g_menu_model_iterate_item_links, constversion)
_WRAP_METHOD(void items_changed(int position, int removed, int added), g_menu_model_items_changed)
// The items-changed signal can't have a default handler in glibmm, because it does not have one in glib.
_WRAP_SIGNAL(void items_changed(int position, int removed, int added), "items-changed", no_default_handler)
};
} // namespace Gio
|
