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 (#GtkActionGroup)
299 * @action : the action to add (#GtkAction)
304 * Adds an action object to the action group and sets up the accelerator.
306 * If @accelerator is NULL, attempt to use the accelerator associated with
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,
318 const char *accelerator,
319 const char *stock_id)
323 GdkModifierType accel_mods;
324 GtkStockItem stock_item;
326 accel_path = g_strconcat ("<Actions>/",
327 action_group->private_data->name, "/", name, NULL);
330 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
331 else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
333 accel_key = stock_item.keyval;
334 accel_mods = stock_item.modifier;
338 gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
340 gtk_action_set_accel_path (action, accel_path);
343 gtk_action_group_add_action (action_group, action);
347 * gtk_action_group_remove_action:
348 * @action_group: the action group
351 * Removes an action object from the action group.
356 gtk_action_group_remove_action (GtkActionGroup *action_group,
359 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
360 g_return_if_fail (GTK_IS_ACTION (action));
361 g_return_if_fail (gtk_action_get_name (action) != NULL);
363 /* extra protection to make sure action->name is valid */
364 g_object_ref (action);
365 g_hash_table_remove (action_group->private_data->actions, gtk_action_get_name (action));
366 g_object_unref (action);
370 add_single_action (gpointer key,
374 GList **list = user_data;
376 *list = g_list_prepend (*list, value);
380 * gtk_action_group_list_actions:
381 * @action_group: the action group
383 * Lists the actions in the action group.
385 * Returns: an allocated list of the action objects in the action group
390 gtk_action_group_list_actions (GtkActionGroup *action_group)
392 GList *actions = NULL;
393 g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
395 g_hash_table_foreach (action_group->private_data->actions, add_single_action, &actions);
397 return g_list_reverse (actions);
402 * gtk_action_group_add_actions:
403 * @action_group: the action group
404 * @entries: an array of action descriptions
405 * @n_entries: the number of entries
406 * @user_data: data to pass to the action callbacks
408 * This is a convenience function to create a number of actions and add them
409 * to the action group.
411 * The "activate" signals of the actions are connected to the callbacks and
412 * their accel paths are set to
413 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
418 gtk_action_group_add_actions (GtkActionGroup *action_group,
419 GtkActionEntry *entries,
423 gtk_action_group_add_actions_full (action_group,
430 * gtk_action_group_add_actions_full:
431 * @action_group: the action group
432 * @entries: an array of action descriptions
433 * @n_entries: the number of entries
434 * @user_data: data to pass to the action callbacks
435 * @destroy: destroy notification callback for @user_data
437 * This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
438 * callback for @user_data.
443 gtk_action_group_add_actions_full (GtkActionGroup *action_group,
444 GtkActionEntry *entries,
447 GDestroyNotify destroy)
450 /* Keep this in sync with the other
451 * gtk_action_group_add_..._actions_full() functions.
454 GtkTranslateFunc translate_func;
455 gpointer translate_data;
457 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
459 translate_func = action_group->private_data->translate_func;
460 translate_data = action_group->private_data->translate_data;
462 for (i = 0; i < n_entries; i++)
466 const gchar *tooltip;
470 label = translate_func (entries[i].label, translate_data);
471 tooltip = translate_func (entries[i].tooltip, translate_data);
475 label = entries[i].label;
476 tooltip = entries[i].tooltip;
479 action = g_object_new (GTK_TYPE_ACTION,
480 "name", entries[i].name,
483 "stock_id", 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, action,
493 entries[i].accelerator,
494 entries[i].stock_id);
495 g_object_unref (action);
500 * gtk_action_group_add_toggle_actions:
501 * @action_group: the action group
502 * @entries: an array of toggle action descriptions
503 * @n_entries: the number of entries
504 * @user_data: data to pass to the action callbacks
506 * This is a convenience function to create a number of toggle actions and add them
507 * to the action group.
509 * The "activate" signals of the actions are connected to the callbacks and
510 * their accel paths are set to
511 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
516 gtk_action_group_add_toggle_actions (GtkActionGroup *action_group,
517 GtkToggleActionEntry *entries,
521 gtk_action_group_add_toggle_actions_full (action_group,
528 * gtk_action_group_add_toggle_actions_full:
529 * @action_group: the action group
530 * @entries: an array of toggle action descriptions
531 * @n_entries: the number of entries
532 * @user_data: data to pass to the action callbacks
533 * @destroy: destroy notification callback for @user_data
535 * This variant of gtk_action_group_add_toggle_actions() adds a
536 * #GDestroyNotify callback for @user_data.
541 gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_group,
542 GtkToggleActionEntry *entries,
545 GDestroyNotify destroy)
547 /* Keep this in sync with the other
548 * gtk_action_group_add_..._actions_full() functions.
551 GtkTranslateFunc translate_func;
552 gpointer translate_data;
554 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
556 translate_func = action_group->private_data->translate_func;
557 translate_data = action_group->private_data->translate_data;
559 for (i = 0; i < n_entries; i++)
563 const gchar *tooltip;
567 label = translate_func (entries[i].label, translate_data);
568 tooltip = translate_func (entries[i].tooltip, translate_data);
572 label = entries[i].label;
573 tooltip = entries[i].tooltip;
576 action = g_object_new (GTK_TYPE_TOGGLE_ACTION,
577 "name", entries[i].name,
580 "stock_id", entries[i].stock_id,
583 gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (action),
584 entries[i].is_active);
586 if (entries[i].callback)
587 g_signal_connect_data (action, "activate",
589 user_data, (GClosureNotify)destroy, 0);
591 gtk_action_group_add_action_with_accel (action_group, action,
593 entries[i].accelerator,
594 entries[i].stock_id);
595 g_object_unref (action);
600 * gtk_action_group_add_radio_actions:
601 * @action_group: the action group
602 * @entries: an array of radio action descriptions
603 * @n_entries: the number of entries
604 * @value: the value of the action to activate initially, or -1 if
605 * no action should be activated
606 * @on_change: the callback to connect to the changed signal
607 * @user_data: data to pass to the action callbacks
609 * This is a convenience routine to create a group of radio actions and
610 * add them to the action group.
612 * The "changed" signal of the first radio action is connected to the
613 * @on_change callback and the accel paths of the actions are set to
614 * <literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
619 gtk_action_group_add_radio_actions (GtkActionGroup *action_group,
620 GtkRadioActionEntry *entries,
626 gtk_action_group_add_radio_actions_full (action_group,
629 on_change, user_data, NULL);
633 * gtk_action_group_add_radio_actions_full:
634 * @action_group: the action group
635 * @entries: an array of radio action descriptions
636 * @n_entries: the number of entries
637 * @value: the value of the action to activate initially, or -1 if
638 * no action should be activated
639 * @on_change: the callback to connect to the changed signal
640 * @user_data: data to pass to the action callbacks
641 * @destroy: destroy notification callback for @user_data
643 * This variant of gtk_action_group_add_radio_actions() adds a
644 * #GDestroyNotify callback for @user_data.
649 gtk_action_group_add_radio_actions_full (GtkActionGroup *action_group,
650 GtkRadioActionEntry *entries,
655 GDestroyNotify destroy)
657 /* Keep this in sync with the other
658 * gtk_action_group_add_..._actions_full() functions.
661 GtkTranslateFunc translate_func;
662 gpointer translate_data;
663 GSList *group = NULL;
664 GtkAction *first_action = NULL;
666 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
668 translate_func = action_group->private_data->translate_func;
669 translate_data = action_group->private_data->translate_data;
671 for (i = 0; i < n_entries; i++)
675 const gchar *tooltip;
679 label = translate_func (entries[i].label, translate_data);
680 tooltip = translate_func (entries[i].tooltip, translate_data);
684 label = entries[i].label;
685 tooltip = entries[i].tooltip;
688 action = g_object_new (GTK_TYPE_RADIO_ACTION,
689 "name", entries[i].name,
692 "stock_id", entries[i].stock_id,
693 "value", entries[i].value,
697 first_action = action;
699 gtk_radio_action_set_group (GTK_RADIO_ACTION (action), group);
700 group = gtk_radio_action_get_group (GTK_RADIO_ACTION (action));
702 if (value == entries[i].value)
703 gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (action), TRUE);
705 gtk_action_group_add_action_with_accel (action_group, action,
707 entries[i].accelerator,
708 entries[i].stock_id);
709 g_object_unref (action);
712 if (on_change && first_action)
713 g_signal_connect_data (first_action, "changed",
714 on_change, user_data,
715 (GClosureNotify)destroy, 0);
719 * gtk_action_group_set_translate_func:
720 * @action_group: a #GtkActionGroup
721 * @func: a #GtkTranslateFunc
722 * @data: data to be passed to @func and @notify
723 * @notify: a #GtkDestroyNotify function to be called when @action_group is
724 * destroyed and when the translation function is changed again
726 * Sets a function to be used for translating the @label and @tooltip of
727 * #GtkActionGroupEntry<!-- -->s added by gtk_action_group_add_actions().
729 * If you're using gettext(), it is enough to set the translation domain
730 * with gtk_action_group_set_translation_domain().
735 gtk_action_group_set_translate_func (GtkActionGroup *action_group,
736 GtkTranslateFunc func,
738 GtkDestroyNotify notify)
740 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
742 if (action_group->private_data->translate_notify)
743 action_group->private_data->translate_notify (action_group->private_data->translate_data);
745 action_group->private_data->translate_func = func;
746 action_group->private_data->translate_data = data;
747 action_group->private_data->translate_notify = notify;
751 dgettext_swapped (const gchar *msgid,
752 const gchar *domainname)
754 return dgettext (domainname, msgid);
758 * gtk_action_group_set_translation_domain:
759 * @action_group: a #GtkActionGroup
760 * @domain: the translation domain to use for dgettext() calls
762 * Sets the translation domain and uses dgettext() for translating the
763 * @label and @tooltip of #GtkActionEntry<!-- -->s added by
764 * gtk_action_group_add_actions().
766 * If you're not using gettext() for localization, see
767 * gtk_action_group_set_translate_func().
772 gtk_action_group_set_translation_domain (GtkActionGroup *action_group,
775 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
777 gtk_action_group_set_translate_func (action_group,
778 (GtkTranslateFunc)dgettext_swapped,