2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
26 #ifndef __G_ACTION_GROUP_H__
27 #define __G_ACTION_GROUP_H__
29 #include <gio/giotypes.h>
34 #define G_TYPE_ACTION_GROUP (g_action_group_get_type ())
35 #define G_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
36 G_TYPE_ACTION_GROUP, GActionGroup))
37 #define G_IS_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
39 #define G_ACTION_GROUP_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), \
40 G_TYPE_ACTION_GROUP, GActionGroupInterface))
42 typedef struct _GActionGroupInterface GActionGroupInterface;
45 * GActionGroupInterface:
46 * @has_action: the virtual function pointer for g_action_group_has_action()
47 * @list_actions: the virtual function pointer for g_action_group_list_actions()
48 * @get_action_parameter_type: the virtual function pointer for g_action_group_get_action_parameter_type()
49 * @get_action_state_type: the virtual function pointer for g_action_group_get_action_state_type()
50 * @get_action_state_hint: the virtual function pointer for g_action_group_get_action_state_hint()
51 * @get_action_enabled: the virtual function pointer for g_action_group_get_action_enabled()
52 * @get_action_state: the virtual function pointer for g_action_group_get_action_state()
53 * @set_action_state: the virtual function pointer for g_action_group_set_action_state()
54 * @activate_action: the virtual function pointer for g_action_group_activate_action()
55 * @action_added: the class closure for the #GActionGroup::action-added signal
56 * @action_removed: the class closure for the #GActionGroup::action-removed signal
57 * @action_enabled_changed: the class closure for the #GActionGroup::action-enabled-changed signal
58 * @action_state_changed: the class closure for the #GActionGroup::action-enabled-changed signal
60 * The virtual function table for #GActionGroup.
64 struct _GActionGroupInterface
66 GTypeInterface g_iface;
68 /* virtual functions */
69 gboolean (* has_action) (GActionGroup *action_group,
70 const gchar *action_name);
72 gchar ** (* list_actions) (GActionGroup *action_group);
74 gboolean (* get_action_enabled) (GActionGroup *action_group,
75 const gchar *action_name);
77 const GVariantType * (* get_action_parameter_type) (GActionGroup *action_group,
78 const gchar *action_name);
80 const GVariantType * (* get_action_state_type) (GActionGroup *action_group,
81 const gchar *action_name);
83 GVariant * (* get_action_state_hint) (GActionGroup *action_group,
84 const gchar *action_name);
86 GVariant * (* get_action_state) (GActionGroup *action_group,
87 const gchar *action_name);
89 void (* change_action_state) (GActionGroup *action_group,
90 const gchar *action_name,
93 void (* activate_action) (GActionGroup *action_group,
94 const gchar *action_name,
98 void (* action_added) (GActionGroup *action_group,
99 const gchar *action_name);
100 void (* action_removed) (GActionGroup *action_group,
101 const gchar *action_name);
102 void (* action_enabled_changed) (GActionGroup *action_group,
103 const gchar *action_name,
105 void (* action_state_changed) (GActionGroup *action_group,
106 const gchar *action_name,
109 /* more virtual functions */
110 gboolean (* query_action) (GActionGroup *action_group,
111 const gchar *action_name,
113 const GVariantType **parameter_type,
114 const GVariantType **state_type,
115 GVariant **state_hint,
119 GType g_action_group_get_type (void) G_GNUC_CONST;
121 gboolean g_action_group_has_action (GActionGroup *action_group,
122 const gchar *action_name);
123 gchar ** g_action_group_list_actions (GActionGroup *action_group);
125 const GVariantType * g_action_group_get_action_parameter_type (GActionGroup *action_group,
126 const gchar *action_name);
127 const GVariantType * g_action_group_get_action_state_type (GActionGroup *action_group,
128 const gchar *action_name);
129 GVariant * g_action_group_get_action_state_hint (GActionGroup *action_group,
130 const gchar *action_name);
132 gboolean g_action_group_get_action_enabled (GActionGroup *action_group,
133 const gchar *action_name);
135 GVariant * g_action_group_get_action_state (GActionGroup *action_group,
136 const gchar *action_name);
137 void g_action_group_change_action_state (GActionGroup *action_group,
138 const gchar *action_name,
141 void g_action_group_activate_action (GActionGroup *action_group,
142 const gchar *action_name,
143 GVariant *parameter);
146 void g_action_group_action_added (GActionGroup *action_group,
147 const gchar *action_name);
148 void g_action_group_action_removed (GActionGroup *action_group,
149 const gchar *action_name);
150 void g_action_group_action_enabled_changed (GActionGroup *action_group,
151 const gchar *action_name,
154 void g_action_group_action_state_changed (GActionGroup *action_group,
155 const gchar *action_name,
158 gboolean g_action_group_query_action (GActionGroup *action_group,
159 const gchar *action_name,
161 const GVariantType **parameter_type,
162 const GVariantType **state_type,
163 GVariant **state_hint,
168 #endif /* __G_ACTION_GROUP_H__ */