2 * GTK - The GIMP Toolkit
3 * Copyright (C) 1998, 1999 Red Hat, Inc.
6 * This Library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This Library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with the Gnome Library; see the file COPYING.LIB. If not,
18 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * Author: James Henstridge <james@daa.com.au>
25 * Modified by the GTK+ Team and others 2003. See the AUTHORS
26 * file for a list of people on the GTK+ Team. See the ChangeLog
27 * files for a list of changes. These files are distributed with
28 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
33 #include "gtkactiongroup.h"
35 #include "gtktoggleaction.h"
36 #include "gtkradioaction.h"
37 #include "gtkaccelmap.h"
40 #define GTK_ACTION_GROUP_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroupPrivate))
42 struct _GtkActionGroupPrivate
47 GtkTranslateFunc translate_func;
48 gpointer translate_data;
49 GtkDestroyNotify translate_notify;
58 static void gtk_action_group_init (GtkActionGroup *self);
59 static void gtk_action_group_class_init (GtkActionGroupClass *class);
60 static void gtk_action_group_finalize (GObject *object);
61 static void gtk_action_group_set_property (GObject *object,
65 static void gtk_action_group_get_property (GObject *object,
69 static GtkAction *gtk_action_group_real_get_action (GtkActionGroup *self,
74 gtk_action_group_get_type (void)
76 static GType type = 0;
80 static const GTypeInfo type_info =
82 sizeof (GtkActionGroupClass),
84 NULL, /* base_finalize */
85 (GClassInitFunc) gtk_action_group_class_init,
86 NULL, /* class_finalize */
87 NULL, /* class_data */
88 sizeof (GtkActionGroup),
90 (GInstanceInitFunc) gtk_action_group_init,
93 type = g_type_register_static (G_TYPE_OBJECT, "GtkActionGroup",
100 static GObjectClass *parent_class = NULL;
103 gtk_action_group_class_init (GtkActionGroupClass *klass)
105 GObjectClass *gobject_class;
107 gobject_class = G_OBJECT_CLASS (klass);
108 parent_class = g_type_class_peek_parent (klass);
110 gobject_class->finalize = gtk_action_group_finalize;
111 gobject_class->set_property = gtk_action_group_set_property;
112 gobject_class->get_property = gtk_action_group_get_property;
113 klass->get_action = gtk_action_group_real_get_action;
115 g_object_class_install_property (gobject_class,
117 g_param_spec_string ("name",
119 _("A name for the action group."),
122 G_PARAM_CONSTRUCT_ONLY));
123 g_type_class_add_private (gobject_class, sizeof (GtkActionGroupPrivate));
127 gtk_action_group_init (GtkActionGroup *self)
129 self->private_data = GTK_ACTION_GROUP_GET_PRIVATE (self);
130 self->private_data->name = NULL;
131 self->private_data->actions = g_hash_table_new_full (g_str_hash, g_str_equal,
132 (GDestroyNotify) g_free,
133 (GDestroyNotify) g_object_unref);
134 self->private_data->translate_func = NULL;
135 self->private_data->translate_data = NULL;
136 self->private_data->translate_notify = NULL;
140 * gtk_action_group_new:
141 * @name: the name of the action group.
143 * Creates a new #GtkActionGroup object. The name of the action group
144 * is used when associating <link linkend="Action-Accel">keybindings</link>
147 * Returns: the new #GtkActionGroup
152 gtk_action_group_new (const gchar *name)
154 GtkActionGroup *self;
156 self = g_object_new (GTK_TYPE_ACTION_GROUP, NULL);
157 self->private_data->name = g_strdup (name);
163 gtk_action_group_finalize (GObject *object)
165 GtkActionGroup *self;
167 self = GTK_ACTION_GROUP (object);
169 g_free (self->private_data->name);
170 self->private_data->name = NULL;
172 g_hash_table_destroy (self->private_data->actions);
173 self->private_data->actions = NULL;
175 if (self->private_data->translate_notify)
176 self->private_data->translate_notify (self->private_data->translate_data);
178 if (parent_class->finalize)
179 (* parent_class->finalize) (object);
183 gtk_action_group_set_property (GObject *object,
188 GtkActionGroup *self;
191 self = GTK_ACTION_GROUP (object);
196 tmp = self->private_data->name;
197 self->private_data->name = g_value_dup_string (value);
201 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
207 gtk_action_group_get_property (GObject *object,
212 GtkActionGroup *self;
214 self = GTK_ACTION_GROUP (object);
219 g_value_set_string (value, self->private_data->name);
222 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
228 gtk_action_group_real_get_action (GtkActionGroup *self,
229 const gchar *action_name)
231 return g_hash_table_lookup (self->private_data->actions, action_name);
235 * gtk_action_group_get_name:
236 * @action_group: the action group
238 * Gets the name of the action group.
240 * Returns: the name of the action group.
245 gtk_action_group_get_name (GtkActionGroup *action_group)
247 g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
249 return action_group->private_data->name;
253 * gtk_action_group_get_action:
254 * @action_group: the action group
255 * @action_name: the name of the action
257 * Looks up an action in the action group by name.
259 * Returns: the action, or %NULL if no action by that name exists
264 gtk_action_group_get_action (GtkActionGroup *action_group,
265 const gchar *action_name)
267 g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
268 g_return_val_if_fail (GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action != NULL, NULL);
270 return (* GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action)
271 (action_group, action_name);
275 * gtk_action_group_add_action:
276 * @action_group: the action group
279 * Adds an action object to the action group.
284 gtk_action_group_add_action (GtkActionGroup *action_group,
287 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
288 g_return_if_fail (GTK_IS_ACTION (action));
289 g_return_if_fail (gtk_action_get_name (action) != NULL);
291 g_hash_table_insert (action_group->private_data->actions,
292 g_strdup (gtk_action_get_name (action)),
293 g_object_ref (action));
297 * gtk_action_group_add_action_with_accel:
298 * @action_group: the action group
299 * @action: the action to add
300 * @accelerator: the accelerator for the action, in
301 * the format understood by gtk_accelerator_parse(), or %NULL to use the
304 * Adds an action object to the action group and sets up the accelerator.
306 * If @accelerator is %NULL, attempts to use the accelerator associated
307 * with the stock_id of the action.
309 * Accel paths are set to
310 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
315 gtk_action_group_add_action_with_accel (GtkActionGroup *action_group,
317 const gchar *accelerator)
321 GdkModifierType accel_mods;
322 GtkStockItem stock_item;
324 const gchar *stock_id;
326 g_object_get (action, "name", &name, "stock_id", &stock_id, NULL);
328 accel_path = g_strconcat ("<Actions>/",
329 action_group->private_data->name, "/", name, NULL);
332 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
333 else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
335 accel_key = stock_item.keyval;
336 accel_mods = stock_item.modifier;
340 gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
342 gtk_action_set_accel_path (action, accel_path);
345 gtk_action_group_add_action (action_group, action);
349 * gtk_action_group_remove_action:
350 * @action_group: the action group
353 * Removes an action object from the action group.
358 gtk_action_group_remove_action (GtkActionGroup *action_group,
361 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
362 g_return_if_fail (GTK_IS_ACTION (action));
363 g_return_if_fail (gtk_action_get_name (action) != NULL);
365 /* extra protection to make sure action->name is valid */
366 g_object_ref (action);
367 g_hash_table_remove (action_group->private_data->actions, gtk_action_get_name (action));
368 g_object_unref (action);
372 add_single_action (gpointer key,
376 GList **list = user_data;
378 *list = g_list_prepend (*list, value);
382 * gtk_action_group_list_actions:
383 * @action_group: the action group
385 * Lists the actions in the action group.
387 * Returns: an allocated list of the action objects in the action group
392 gtk_action_group_list_actions (GtkActionGroup *action_group)
394 GList *actions = NULL;
395 g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
397 g_hash_table_foreach (action_group->private_data->actions, add_single_action, &actions);
399 return g_list_reverse (actions);
404 * gtk_action_group_add_actions:
405 * @action_group: the action group
406 * @entries: an array of action descriptions
407 * @n_entries: the number of entries
408 * @user_data: data to pass to the action callbacks
410 * This is a convenience function to create a number of actions and add them
411 * to the action group.
413 * The "activate" signals of the actions are connected to the callbacks and
414 * their accel paths are set to
415 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
420 gtk_action_group_add_actions (GtkActionGroup *action_group,
421 GtkActionEntry *entries,
425 gtk_action_group_add_actions_full (action_group,
432 * gtk_action_group_add_actions_full:
433 * @action_group: the action group
434 * @entries: an array of action descriptions
435 * @n_entries: the number of entries
436 * @user_data: data to pass to the action callbacks
437 * @destroy: destroy notification callback for @user_data
439 * This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
440 * callback for @user_data.
445 gtk_action_group_add_actions_full (GtkActionGroup *action_group,
446 GtkActionEntry *entries,
449 GDestroyNotify destroy)
452 /* Keep this in sync with the other
453 * gtk_action_group_add_..._actions_full() functions.
456 GtkTranslateFunc translate_func;
457 gpointer translate_data;
459 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
461 translate_func = action_group->private_data->translate_func;
462 translate_data = action_group->private_data->translate_data;
464 for (i = 0; i < n_entries; i++)
468 const gchar *tooltip;
472 label = translate_func (entries[i].label, translate_data);
473 tooltip = translate_func (entries[i].tooltip, translate_data);
477 label = entries[i].label;
478 tooltip = entries[i].tooltip;
481 action = gtk_action_new (entries[i].name,
484 entries[i].stock_id);
486 if (entries[i].callback)
487 g_signal_connect_data (action, "activate",
489 user_data, (GClosureNotify)destroy, 0);
491 gtk_action_group_add_action_with_accel (action_group,
493 entries[i].accelerator);
494 g_object_unref (action);
499 * gtk_action_group_add_toggle_actions:
500 * @action_group: the action group
501 * @entries: an array of toggle action descriptions
502 * @n_entries: the number of entries
503 * @user_data: data to pass to the action callbacks
505 * This is a convenience function to create a number of toggle actions and add them
506 * to the action group.
508 * The "activate" signals of the actions are connected to the callbacks and
509 * their accel paths are set to
510 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
515 gtk_action_group_add_toggle_actions (GtkActionGroup *action_group,
516 GtkToggleActionEntry *entries,
520 gtk_action_group_add_toggle_actions_full (action_group,
527 * gtk_action_group_add_toggle_actions_full:
528 * @action_group: the action group
529 * @entries: an array of toggle action descriptions
530 * @n_entries: the number of entries
531 * @user_data: data to pass to the action callbacks
532 * @destroy: destroy notification callback for @user_data
534 * This variant of gtk_action_group_add_toggle_actions() adds a
535 * #GDestroyNotify callback for @user_data.
540 gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_group,
541 GtkToggleActionEntry *entries,
544 GDestroyNotify destroy)
546 /* Keep this in sync with the other
547 * gtk_action_group_add_..._actions_full() functions.
550 GtkTranslateFunc translate_func;
551 gpointer translate_data;
553 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
555 translate_func = action_group->private_data->translate_func;
556 translate_data = action_group->private_data->translate_data;
558 for (i = 0; i < n_entries; i++)
560 GtkToggleAction *action;
562 const gchar *tooltip;
566 label = translate_func (entries[i].label, translate_data);
567 tooltip = translate_func (entries[i].tooltip, translate_data);
571 label = entries[i].label;
572 tooltip = entries[i].tooltip;
575 action = gtk_toggle_action_new (entries[i].name,
578 entries[i].stock_id);
580 gtk_toggle_action_set_active (action, entries[i].is_active);
582 if (entries[i].callback)
583 g_signal_connect_data (action, "activate",
585 user_data, (GClosureNotify)destroy, 0);
587 gtk_action_group_add_action_with_accel (action_group,
589 entries[i].accelerator);
590 g_object_unref (action);
595 * gtk_action_group_add_radio_actions:
596 * @action_group: the action group
597 * @entries: an array of radio action descriptions
598 * @n_entries: the number of entries
599 * @value: the value of the action to activate initially, or -1 if
600 * no action should be activated
601 * @on_change: the callback to connect to the changed signal
602 * @user_data: data to pass to the action callbacks
604 * This is a convenience routine to create a group of radio actions and
605 * add them to the action group.
607 * The "changed" signal of the first radio action is connected to the
608 * @on_change callback and the accel paths of the actions are set to
609 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
614 gtk_action_group_add_radio_actions (GtkActionGroup *action_group,
615 GtkRadioActionEntry *entries,
621 gtk_action_group_add_radio_actions_full (action_group,
624 on_change, user_data, NULL);
628 * gtk_action_group_add_radio_actions_full:
629 * @action_group: the action group
630 * @entries: an array of radio action descriptions
631 * @n_entries: the number of entries
632 * @value: the value of the action to activate initially, or -1 if
633 * no action should be activated
634 * @on_change: the callback to connect to the changed signal
635 * @user_data: data to pass to the action callbacks
636 * @destroy: destroy notification callback for @user_data
638 * This variant of gtk_action_group_add_radio_actions() adds a
639 * #GDestroyNotify callback for @user_data.
644 gtk_action_group_add_radio_actions_full (GtkActionGroup *action_group,
645 GtkRadioActionEntry *entries,
650 GDestroyNotify destroy)
652 /* Keep this in sync with the other
653 * gtk_action_group_add_..._actions_full() functions.
656 GtkTranslateFunc translate_func;
657 gpointer translate_data;
658 GSList *group = NULL;
659 GtkAction *first_action = NULL;
661 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
663 translate_func = action_group->private_data->translate_func;
664 translate_data = action_group->private_data->translate_data;
666 for (i = 0; i < n_entries; i++)
668 GtkRadioAction *action;
670 const gchar *tooltip;
674 label = translate_func (entries[i].label, translate_data);
675 tooltip = translate_func (entries[i].tooltip, translate_data);
679 label = entries[i].label;
680 tooltip = entries[i].tooltip;
683 action = gtk_radio_action_new (entries[i].name,
690 first_action = action;
692 gtk_radio_action_set_group (action, group);
693 group = gtk_radio_action_get_group (action);
695 if (value == entries[i].value)
696 gtk_toggle_action_set_active (action, TRUE);
698 gtk_action_group_add_action_with_accel (action_group,
700 entries[i].accelerator);
701 g_object_unref (action);
704 if (on_change && first_action)
705 g_signal_connect_data (first_action, "changed",
706 on_change, user_data,
707 (GClosureNotify)destroy, 0);
711 * gtk_action_group_set_translate_func:
712 * @action_group: a #GtkActionGroup
713 * @func: a #GtkTranslateFunc
714 * @data: data to be passed to @func and @notify
715 * @notify: a #GtkDestroyNotify function to be called when @action_group is
716 * destroyed and when the translation function is changed again
718 * Sets a function to be used for translating the @label and @tooltip of
719 * #GtkActionGroupEntry<!-- -->s added by gtk_action_group_add_actions().
721 * If you're using gettext(), it is enough to set the translation domain
722 * with gtk_action_group_set_translation_domain().
727 gtk_action_group_set_translate_func (GtkActionGroup *action_group,
728 GtkTranslateFunc func,
730 GtkDestroyNotify notify)
732 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
734 if (action_group->private_data->translate_notify)
735 action_group->private_data->translate_notify (action_group->private_data->translate_data);
737 action_group->private_data->translate_func = func;
738 action_group->private_data->translate_data = data;
739 action_group->private_data->translate_notify = notify;
743 dgettext_swapped (const gchar *msgid,
744 const gchar *domainname)
746 return dgettext (domainname, msgid);
750 * gtk_action_group_set_translation_domain:
751 * @action_group: a #GtkActionGroup
752 * @domain: the translation domain to use for dgettext() calls
754 * Sets the translation domain and uses dgettext() for translating the
755 * @label and @tooltip of #GtkActionEntry<!-- -->s added by
756 * gtk_action_group_add_actions().
758 * If you're not using gettext() for localization, see
759 * gtk_action_group_set_translate_func().
764 gtk_action_group_set_translation_domain (GtkActionGroup *action_group,
767 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
769 gtk_action_group_set_translate_func (action_group,
770 (GtkTranslateFunc)dgettext_swapped,