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>
24 #include "gsimpleactiongroup.h"
26 #include "gsimpleaction.h"
27 #include "gactionmap.h"
31 * SECTION:gsimpleactiongroup
32 * @title: GSimpleActionGroup
33 * @short_description: A simple GActionGroup implementation
35 * #GSimpleActionGroup is a hash table filled with #GAction objects,
36 * implementing the #GActionGroup and #GActionMap interfaces.
39 struct _GSimpleActionGroupPrivate
41 GHashTable
*table
; /* string -> GAction */
44 static void g_simple_action_group_iface_init (GActionGroupInterface
*);
45 static void g_simple_action_group_map_iface_init (GActionMapInterface
*);
46 G_DEFINE_TYPE_WITH_CODE (GSimpleActionGroup
,
47 g_simple_action_group
, G_TYPE_OBJECT
,
48 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP
,
49 g_simple_action_group_iface_init
);
50 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP
,
51 g_simple_action_group_map_iface_init
))
54 g_simple_action_group_list_actions (GActionGroup
*group
)
56 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (group
);
62 n
= g_hash_table_size (simple
->priv
->table
);
63 keys
= g_new (gchar
*, n
+ 1);
65 g_hash_table_iter_init (&iter
, simple
->priv
->table
);
66 while (g_hash_table_iter_next (&iter
, &key
, NULL
))
67 keys
[i
++] = g_strdup (key
);
68 g_assert_cmpint (i
, ==, n
);
75 g_simple_action_group_query_action (GActionGroup
*group
,
76 const gchar
*action_name
,
78 const GVariantType
**parameter_type
,
79 const GVariantType
**state_type
,
80 GVariant
**state_hint
,
83 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (group
);
86 action
= g_hash_table_lookup (simple
->priv
->table
, action_name
);
92 *enabled
= g_action_get_enabled (action
);
95 *parameter_type
= g_action_get_parameter_type (action
);
98 *state_type
= g_action_get_state_type (action
);
101 *state_hint
= g_action_get_state_hint (action
);
104 *state
= g_action_get_state (action
);
110 g_simple_action_group_change_state (GActionGroup
*group
,
111 const gchar
*action_name
,
114 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (group
);
117 action
= g_hash_table_lookup (simple
->priv
->table
, action_name
);
122 g_action_change_state (action
, value
);
126 g_simple_action_group_activate (GActionGroup
*group
,
127 const gchar
*action_name
,
130 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (group
);
133 action
= g_hash_table_lookup (simple
->priv
->table
, action_name
);
138 g_action_activate (action
, parameter
);
142 action_enabled_notify (GAction
*action
,
146 g_action_group_action_enabled_changed (user_data
,
147 g_action_get_name (action
),
148 g_action_get_enabled (action
));
152 action_state_notify (GAction
*action
,
158 value
= g_action_get_state (action
);
159 g_action_group_action_state_changed (user_data
,
160 g_action_get_name (action
),
162 g_variant_unref (value
);
166 g_simple_action_group_disconnect (gpointer key
,
170 g_signal_handlers_disconnect_by_func (value
, action_enabled_notify
,
172 g_signal_handlers_disconnect_by_func (value
, action_state_notify
,
177 g_simple_action_group_lookup_action (GActionMap
*action_map
,
178 const gchar
*action_name
)
180 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (action_map
);
182 return g_hash_table_lookup (simple
->priv
->table
, action_name
);
186 g_simple_action_group_add_action (GActionMap
*action_map
,
189 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (action_map
);
190 const gchar
*action_name
;
193 action_name
= g_action_get_name (action
);
194 old_action
= g_hash_table_lookup (simple
->priv
->table
, action_name
);
196 if (old_action
!= action
)
198 if (old_action
!= NULL
)
200 g_action_group_action_removed (G_ACTION_GROUP (simple
),
202 g_simple_action_group_disconnect (NULL
, old_action
, simple
);
205 g_signal_connect (action
, "notify::enabled",
206 G_CALLBACK (action_enabled_notify
), simple
);
208 if (g_action_get_state_type (action
) != NULL
)
209 g_signal_connect (action
, "notify::state",
210 G_CALLBACK (action_state_notify
), simple
);
212 g_hash_table_insert (simple
->priv
->table
,
213 g_strdup (action_name
),
214 g_object_ref (action
));
216 g_action_group_action_added (G_ACTION_GROUP (simple
), action_name
);
221 g_simple_action_group_remove_action (GActionMap
*action_map
,
222 const gchar
*action_name
)
224 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (action_map
);
227 action
= g_hash_table_lookup (simple
->priv
->table
, action_name
);
231 g_action_group_action_removed (G_ACTION_GROUP (simple
), action_name
);
232 g_simple_action_group_disconnect (NULL
, action
, simple
);
233 g_hash_table_remove (simple
->priv
->table
, action_name
);
238 g_simple_action_group_finalize (GObject
*object
)
240 GSimpleActionGroup
*simple
= G_SIMPLE_ACTION_GROUP (object
);
242 g_hash_table_foreach (simple
->priv
->table
,
243 g_simple_action_group_disconnect
,
245 g_hash_table_unref (simple
->priv
->table
);
247 G_OBJECT_CLASS (g_simple_action_group_parent_class
)
252 g_simple_action_group_init (GSimpleActionGroup
*simple
)
254 simple
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (simple
,
255 G_TYPE_SIMPLE_ACTION_GROUP
,
256 GSimpleActionGroupPrivate
);
257 simple
->priv
->table
= g_hash_table_new_full (g_str_hash
, g_str_equal
,
258 g_free
, g_object_unref
);
262 g_simple_action_group_class_init (GSimpleActionGroupClass
*class)
264 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
266 object_class
->finalize
= g_simple_action_group_finalize
;
268 g_type_class_add_private (class, sizeof (GSimpleActionGroupPrivate
));
272 g_simple_action_group_iface_init (GActionGroupInterface
*iface
)
274 iface
->list_actions
= g_simple_action_group_list_actions
;
275 iface
->query_action
= g_simple_action_group_query_action
;
276 iface
->change_action_state
= g_simple_action_group_change_state
;
277 iface
->activate_action
= g_simple_action_group_activate
;
281 g_simple_action_group_map_iface_init (GActionMapInterface
*iface
)
283 iface
->add_action
= g_simple_action_group_add_action
;
284 iface
->remove_action
= g_simple_action_group_remove_action
;
285 iface
->lookup_action
= g_simple_action_group_lookup_action
;
289 * g_simple_action_group_new:
291 * Creates a new, empty, #GSimpleActionGroup.
293 * Returns: a new #GSimpleActionGroup
298 g_simple_action_group_new (void)
300 return g_object_new (G_TYPE_SIMPLE_ACTION_GROUP
, NULL
);
304 * g_simple_action_group_lookup:
305 * @simple: a #GSimpleActionGroup
306 * @action_name: the name of an action
308 * Looks up the action with the name @action_name in the group.
310 * If no such action exists, returns %NULL.
312 * Returns: (transfer none): a #GAction, or %NULL
317 g_simple_action_group_lookup (GSimpleActionGroup
*simple
,
318 const gchar
*action_name
)
320 g_return_val_if_fail (G_IS_SIMPLE_ACTION_GROUP (simple
), NULL
);
322 return g_action_map_lookup_action (G_ACTION_MAP (simple
), action_name
);
326 * g_simple_action_group_insert:
327 * @simple: a #GSimpleActionGroup
328 * @action: a #GAction
330 * Adds an action to the action group.
332 * If the action group already contains an action with the same name as
333 * @action then the old action is dropped from the group.
335 * The action group takes its own reference on @action.
340 g_simple_action_group_insert (GSimpleActionGroup
*simple
,
343 g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP (simple
));
345 g_action_map_add_action (G_ACTION_MAP (simple
), action
);
349 * g_simple_action_group_remove:
350 * @simple: a #GSimpleActionGroup
351 * @action_name: the name of the action
353 * Removes the named action from the action group.
355 * If no action of this name is in the group then nothing happens.
360 g_simple_action_group_remove (GSimpleActionGroup
*simple
,
361 const gchar
*action_name
)
363 g_return_if_fail (G_IS_SIMPLE_ACTION_GROUP (simple
));
365 g_action_map_remove_action (G_ACTION_MAP (simple
), action_name
);
370 * g_simple_action_group_add_entries:
371 * @simple: a #GSimpleActionGroup
372 * @entries: (array length=n_entries): a pointer to the first item in
373 * an array of #GActionEntry structs
374 * @n_entries: the length of @entries, or -1
375 * @user_data: the user data for signal connections
377 * A convenience function for creating multiple #GSimpleAction instances
378 * and adding them to the action group.
383 g_simple_action_group_add_entries (GSimpleActionGroup
*simple
,
384 const GActionEntry
*entries
,
388 g_action_map_add_action_entries (G_ACTION_MAP (simple
), entries
, n_entries
, user_data
);