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, see <http://www.gnu.org/licenses/>.
17 * Authors: Ryan Lortie <desrt@desrt.ca>
22 #include "gsimpleaction.h"
23 #include "gactionmap.h"
30 * @short_description: Interface for action containers
32 * The GActionMap interface is implemented by #GActionGroup
33 * implementations that operate by containing a number of
34 * named #GAction instances, such as #GSimpleActionGroup.
36 * One useful application of this interface is to map the
37 * names of actions from various action groups to unique,
38 * prefixed names (e.g. by prepending "app." or "win.").
39 * This is the motivation for the 'Map' part of the interface
46 * GActionMapInterface:
47 * @lookup_action: the virtual function pointer for g_action_map_lookup_action()
48 * @add_action: the virtual function pointer for g_action_map_add_action()
49 * @remove_action: the virtual function pointer for g_action_map_remove_action()
51 * The virtual function table for #GActionMap.
56 G_DEFINE_INTERFACE (GActionMap, g_action_map, G_TYPE_OBJECT)
59 g_action_map_default_init (GActionMapInterface *iface)
64 * g_action_map_lookup_action:
65 * @action_map: a #GActionMap
66 * @action_name: the name of an action
68 * Looks up the action with the name @action_name in @action_map.
70 * If no such action exists, returns %NULL.
72 * Returns: (transfer none): a #GAction, or %NULL
77 g_action_map_lookup_action (GActionMap *action_map,
78 const gchar *action_name)
80 return G_ACTION_MAP_GET_IFACE (action_map)
81 ->lookup_action (action_map, action_name);
85 * g_action_map_add_action:
86 * @action_map: a #GActionMap
89 * Adds an action to the @action_map.
91 * If the action map already contains an action with the same name
92 * as @action then the old action is dropped from the action map.
94 * The action map takes its own reference on @action.
99 g_action_map_add_action (GActionMap *action_map,
102 G_ACTION_MAP_GET_IFACE (action_map)->add_action (action_map, action);
106 * g_action_map_remove_action:
107 * @action_map: a #GActionMap
108 * @action_name: the name of the action
110 * Removes the named action from the action map.
112 * If no action of this name is in the map then nothing happens.
117 g_action_map_remove_action (GActionMap *action_map,
118 const gchar *action_name)
120 G_ACTION_MAP_GET_IFACE (action_map)->remove_action (action_map, action_name);
125 * @name: the name of the action
126 * @activate: the callback to connect to the "activate" signal of the
127 * action. Since GLib 2.40, this can be %NULL for stateful
128 * actions, in which case the default handler is used. For
129 * boolean-stated actions with no parameter, this is a
130 * toggle. For other state types (and parameter type equal
131 * to the state type) this will be a function that
132 * just calls @change_state (which you should provide).
133 * @parameter_type: the type of the parameter that must be passed to the
134 * activate function for this action, given as a single
135 * GVariant type string (or %NULL for no parameter)
136 * @state: the initial state for this action, given in GVariant text
137 * format. The state is parsed with no extra type information,
138 * so type tags must be added to the string if they are
139 * necessary. Stateless actions should give %NULL here.
140 * @change_state: the callback to connect to the "change-state" signal
141 * of the action. All stateful actions should provide a
142 * handler here; stateless actions should not.
144 * This struct defines a single action. It is for use with
145 * g_action_map_add_action_entries().
147 * The order of the items in the structure are intended to reflect
148 * frequency of use. It is permissible to use an incomplete initialiser
149 * in order to leave some of the later values as %NULL. All values
150 * after @name are optional. Additional optional fields may be added in
153 * See g_action_map_add_action_entries() for an example.
157 * g_action_map_add_action_entries:
158 * @action_map: a #GActionMap
159 * @entries: (array length=n_entries) (element-type GActionEntry): a pointer to
160 * the first item in an array of #GActionEntry structs
161 * @n_entries: the length of @entries, or -1 if @entries is %NULL-terminated
162 * @user_data: the user data for signal connections
164 * A convenience function for creating multiple #GSimpleAction instances
165 * and adding them to a #GActionMap.
167 * Each action is constructed as per one #GActionEntry.
169 * |[<!-- language="C" -->
171 * activate_quit (GSimpleAction *simple,
172 * GVariant *parameter,
173 * gpointer user_data)
179 * activate_print_string (GSimpleAction *simple,
180 * GVariant *parameter,
181 * gpointer user_data)
183 * g_print ("%s\n", g_variant_get_string (parameter, NULL));
186 * static GActionGroup *
187 * create_action_group (void)
189 * const GActionEntry entries[] = {
190 * { "quit", activate_quit },
191 * { "print-string", activate_print_string, "s" }
193 * GSimpleActionGroup *group;
195 * group = g_simple_action_group_new ();
196 * g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL);
198 * return G_ACTION_GROUP (group);
205 g_action_map_add_action_entries (GActionMap *action_map,
206 const GActionEntry *entries,
212 g_return_if_fail (G_IS_ACTION_MAP (action_map));
213 g_return_if_fail (entries != NULL || n_entries == 0);
215 for (i = 0; n_entries == -1 ? entries[i].name != NULL : i < n_entries; i++)
217 const GActionEntry *entry = &entries[i];
218 const GVariantType *parameter_type;
219 GSimpleAction *action;
221 if (entry->parameter_type)
223 if (!g_variant_type_string_is_valid (entry->parameter_type))
225 g_critical ("g_action_map_add_entries: the type "
226 "string '%s' given as the parameter type for "
227 "action '%s' is not a valid GVariant type "
228 "string. This action will not be added.",
229 entry->parameter_type, entry->name);
233 parameter_type = G_VARIANT_TYPE (entry->parameter_type);
236 parameter_type = NULL;
240 GError *error = NULL;
243 state = g_variant_parse (NULL, entry->state, NULL, NULL, &error);
246 g_critical ("g_action_map_add_entries: GVariant could "
247 "not parse the state value given for action '%s' "
248 "('%s'): %s. This action will not be added.",
249 entry->name, entry->state, error->message);
250 g_error_free (error);
254 action = g_simple_action_new_stateful (entry->name,
258 g_variant_unref (state);
262 action = g_simple_action_new (entry->name,
266 if (entry->activate != NULL)
267 g_signal_connect (action, "activate",
268 G_CALLBACK (entry->activate), user_data);
270 if (entry->change_state != NULL)
271 g_signal_connect (action, "change-state",
272 G_CALLBACK (entry->change_state), user_data);
274 g_action_map_add_action (action_map, G_ACTION (action));
275 g_object_unref (action);