1/*
2 * Copyright © 2011 Canonical Ltd.
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 *
19 * Author: Ryan Lortie <desrt@desrt.ca>
20 */
21
22#ifndef __G_MENU_H__
23#define __G_MENU_H__
24
25#include <gio/gmenumodel.h>
26
27G_BEGIN_DECLS
28
29#define G_TYPE_MENU (g_menu_get_type ())
30#define G_MENU(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
31 G_TYPE_MENU, GMenu))
32#define G_IS_MENU(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
33 G_TYPE_MENU))
34
35#define G_TYPE_MENU_ITEM (g_menu_item_get_type ())
36#define G_MENU_ITEM(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
37 G_TYPE_MENU_ITEM, GMenuItem))
38#define G_IS_MENU_ITEM(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
39 G_TYPE_MENU_ITEM))
40
41typedef struct _GMenuItem GMenuItem;
42typedef struct _GMenu GMenu;
43
44GIO_AVAILABLE_IN_2_32
45GType g_menu_get_type (void) G_GNUC_CONST;
46GIO_AVAILABLE_IN_2_32
47GMenu * g_menu_new (void);
48
49GIO_AVAILABLE_IN_2_32
50void g_menu_freeze (GMenu *menu);
51
52GIO_AVAILABLE_IN_2_32
53void g_menu_insert_item (GMenu *menu,
54 gint position,
55 GMenuItem *item);
56GIO_AVAILABLE_IN_2_32
57void g_menu_prepend_item (GMenu *menu,
58 GMenuItem *item);
59GIO_AVAILABLE_IN_2_32
60void g_menu_append_item (GMenu *menu,
61 GMenuItem *item);
62GIO_AVAILABLE_IN_2_32
63void g_menu_remove (GMenu *menu,
64 gint position);
65
66GIO_AVAILABLE_IN_2_38
67void g_menu_remove_all (GMenu *menu);
68
69GIO_AVAILABLE_IN_2_32
70void g_menu_insert (GMenu *menu,
71 gint position,
72 const gchar *label,
73 const gchar *detailed_action);
74GIO_AVAILABLE_IN_2_32
75void g_menu_prepend (GMenu *menu,
76 const gchar *label,
77 const gchar *detailed_action);
78GIO_AVAILABLE_IN_2_32
79void g_menu_append (GMenu *menu,
80 const gchar *label,
81 const gchar *detailed_action);
82
83GIO_AVAILABLE_IN_2_32
84void g_menu_insert_section (GMenu *menu,
85 gint position,
86 const gchar *label,
87 GMenuModel *section);
88GIO_AVAILABLE_IN_2_32
89void g_menu_prepend_section (GMenu *menu,
90 const gchar *label,
91 GMenuModel *section);
92GIO_AVAILABLE_IN_2_32
93void g_menu_append_section (GMenu *menu,
94 const gchar *label,
95 GMenuModel *section);
96
97GIO_AVAILABLE_IN_2_32
98void g_menu_insert_submenu (GMenu *menu,
99 gint position,
100 const gchar *label,
101 GMenuModel *submenu);
102GIO_AVAILABLE_IN_2_32
103void g_menu_prepend_submenu (GMenu *menu,
104 const gchar *label,
105 GMenuModel *submenu);
106GIO_AVAILABLE_IN_2_32
107void g_menu_append_submenu (GMenu *menu,
108 const gchar *label,
109 GMenuModel *submenu);
110
111
112GIO_AVAILABLE_IN_2_32
113GType g_menu_item_get_type (void) G_GNUC_CONST;
114GIO_AVAILABLE_IN_2_32
115GMenuItem * g_menu_item_new (const gchar *label,
116 const gchar *detailed_action);
117
118GIO_AVAILABLE_IN_2_34
119GMenuItem * g_menu_item_new_from_model (GMenuModel *model,
120 gint item_index);
121
122GIO_AVAILABLE_IN_2_32
123GMenuItem * g_menu_item_new_submenu (const gchar *label,
124 GMenuModel *submenu);
125
126GIO_AVAILABLE_IN_2_32
127GMenuItem * g_menu_item_new_section (const gchar *label,
128 GMenuModel *section);
129
130GIO_AVAILABLE_IN_2_34
131GVariant * g_menu_item_get_attribute_value (GMenuItem *menu_item,
132 const gchar *attribute,
133 const GVariantType *expected_type);
134GIO_AVAILABLE_IN_2_34
135gboolean g_menu_item_get_attribute (GMenuItem *menu_item,
136 const gchar *attribute,
137 const gchar *format_string,
138 ...);
139GIO_AVAILABLE_IN_2_34
140GMenuModel *g_menu_item_get_link (GMenuItem *menu_item,
141 const gchar *link);
142
143GIO_AVAILABLE_IN_2_32
144void g_menu_item_set_attribute_value (GMenuItem *menu_item,
145 const gchar *attribute,
146 GVariant *value);
147GIO_AVAILABLE_IN_2_32
148void g_menu_item_set_attribute (GMenuItem *menu_item,
149 const gchar *attribute,
150 const gchar *format_string,
151 ...);
152GIO_AVAILABLE_IN_2_32
153void g_menu_item_set_link (GMenuItem *menu_item,
154 const gchar *link,
155 GMenuModel *model);
156GIO_AVAILABLE_IN_2_32
157void g_menu_item_set_label (GMenuItem *menu_item,
158 const gchar *label);
159GIO_AVAILABLE_IN_2_32
160void g_menu_item_set_submenu (GMenuItem *menu_item,
161 GMenuModel *submenu);
162GIO_AVAILABLE_IN_2_32
163void g_menu_item_set_section (GMenuItem *menu_item,
164 GMenuModel *section);
165GIO_AVAILABLE_IN_2_32
166void g_menu_item_set_action_and_target_value (GMenuItem *menu_item,
167 const gchar *action,
168 GVariant *target_value);
169GIO_AVAILABLE_IN_2_32
170void g_menu_item_set_action_and_target (GMenuItem *menu_item,
171 const gchar *action,
172 const gchar *format_string,
173 ...);
174GIO_AVAILABLE_IN_2_32
175void g_menu_item_set_detailed_action (GMenuItem *menu_item,
176 const gchar *detailed_action);
177
178GIO_AVAILABLE_IN_2_38
179void g_menu_item_set_icon (GMenuItem *menu_item,
180 GIcon *icon);
181
182G_END_DECLS
183
184#endif /* __G_MENU_H__ */
185

source code of include/glib-2.0/gio/gmenu.h