Pileus Git - ~andy/gtk/blob - gtk/gtkactiongroup.c

   1 /*
   2  * GTK - The GIMP Toolkit
   3  * Copyright (C) 1998, 1999 Red Hat, Inc.
   4  * All rights reserved.
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 /*
  23  * Author: James Henstridge <james@daa.com.au>
  24  *
  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/.
  29  */
  30
  31 #include <config.h>
  32
  33 #include "gtkactiongroup.h"
  34 #include "gtkstock.h"
  35 #include "gtktoggleaction.h"
  36 #include "gtkradioaction.h"
  37 #include "gtkaccelmap.h"
  38 #include "gtkmarshalers.h"
  39 #include "gtkintl.h"
  40
  41 #define GTK_ACTION_GROUP_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ACTION_GROUP, GtkActionGroupPrivate))
  42
  43 struct _GtkActionGroupPrivate
  44 {
  45   gchar           *name;
  46   gboolean         sensitive;
  47   gboolean         visible;
  48   GHashTable      *actions;
  49
  50   GtkTranslateFunc translate_func;
  51   gpointer         translate_data;
  52   GtkDestroyNotify translate_notify;
  53 };
  54
  55 enum
  56 {
  57   CONNECT_PROXY,
  58   DISCONNECT_PROXY,
  59   PRE_ACTIVATE,
  60   POST_ACTIVATE,
  61   LAST_SIGNAL
  62 };
  63
  64 enum
  65 {
  66   PROP_0,
  67   PROP_NAME,
  68   PROP_SENSITIVE,
  69   PROP_VISIBLE
  70 };
  71
  72 static void       gtk_action_group_init            (GtkActionGroup      *self);
  73 static void       gtk_action_group_class_init      (GtkActionGroupClass *class);
  74 static void       gtk_action_group_finalize        (GObject             *object);
  75 static void       gtk_action_group_set_property    (GObject             *object,
  76                                                     guint                prop_id,
  77                                                     const GValue        *value,
  78                                                     GParamSpec          *pspec);
  79 static void       gtk_action_group_get_property    (GObject             *object,
  80                                                     guint                prop_id,
  81                                                     GValue              *value,
  82                                                     GParamSpec          *pspec);
  83 static GtkAction *gtk_action_group_real_get_action (GtkActionGroup      *self,
  84                                                     const gchar         *name);
  85
  86
  87 GType
  88 gtk_action_group_get_type (void)
  89 {
  90   static GType type = 0;
  91
  92   if (!type)
  93     {
  94       static const GTypeInfo type_info =
  95       {
  96         sizeof (GtkActionGroupClass),
  97         NULL,           /* base_init */
  98         NULL,           /* base_finalize */
  99         (GClassInitFunc) gtk_action_group_class_init,
 100         NULL,           /* class_finalize */
 101         NULL,           /* class_data */
 102         sizeof (GtkActionGroup),
 103         0, /* n_preallocs */
 104         (GInstanceInitFunc) gtk_action_group_init,
 105       };
 106
 107       type = g_type_register_static (G_TYPE_OBJECT, "GtkActionGroup",
 108                                      &type_info, 0);
 109     }
 110
 111   return type;
 112 }
 113
 114 static GObjectClass *parent_class = NULL;
 115 static guint         action_group_signals[LAST_SIGNAL] = { 0 };
 116
 117 static void
 118 gtk_action_group_class_init (GtkActionGroupClass *klass)
 119 {
 120   GObjectClass *gobject_class;
 121
 122   gobject_class = G_OBJECT_CLASS (klass);
 123   parent_class = g_type_class_peek_parent (klass);
 124
 125   gobject_class->finalize = gtk_action_group_finalize;
 126   gobject_class->set_property = gtk_action_group_set_property;
 127   gobject_class->get_property = gtk_action_group_get_property;
 128   klass->get_action = gtk_action_group_real_get_action;
 129
 130   g_object_class_install_property (gobject_class,
 131                                    PROP_NAME,
 132                                    g_param_spec_string ("name",
 133                                                         P_("Name"),
 134                                                         P_("A name for the action group."),
 135                                                         NULL,
 136                                                         G_PARAM_READWRITE |
 137                                                         G_PARAM_CONSTRUCT_ONLY));
 138   g_object_class_install_property (gobject_class,
 139                                    PROP_SENSITIVE,
 140                                    g_param_spec_boolean ("sensitive",
 141                                                          P_("Sensitive"),
 142                                                          P_("Whether the action group is enabled."),
 143                                                          TRUE,
 144                                                          G_PARAM_READWRITE));
 145   g_object_class_install_property (gobject_class,
 146                                    PROP_VISIBLE,
 147                                    g_param_spec_boolean ("visible",
 148                                                          P_("Visible"),
 149                                                          P_("Whether the action group is visible."),
 150                                                          TRUE,
 151                                                          G_PARAM_READWRITE));
 152
 153   /**
 154    * GtkGroupAction::connect-proxy:
 155    * @action_group: the group
 156    * @action: the action
 157    * @proxy: the proxy
 158    *
 159    * The connect_proxy signal is emitted after connecting a proxy to
 160    * an action in the group. Note that the proxy may have been connected
 161    * to a different action before.
 162    *
 163    * This is intended for simple customizations for which a custom action
 164    * class would be too clumsy, e.g. showing tooltips for menuitems in the
 165    * statusbar.
 166    *
 167    * #GtkUIManager proxies the signal and provides global notification
 168    * just before any action is connected to a proxy, which is probably more
 169    * convenient to use.
 170    *
 171    * Since: 2.4
 172    */
 173   action_group_signals[CONNECT_PROXY] =
 174     g_signal_new ("connect_proxy",
 175                   G_OBJECT_CLASS_TYPE (klass),
 176                   0, 0, NULL, NULL,
 177                   _gtk_marshal_VOID__OBJECT_OBJECT,
 178                   G_TYPE_NONE, 2,
 179                   GTK_TYPE_ACTION, GTK_TYPE_WIDGET);
 180
 181   /**
 182    * GtkAction::disconnect-proxy:
 183    * @action_group: the group
 184    * @action: the action
 185    * @proxy: the proxy
 186    *
 187    * The disconnect_proxy signal is emitted after disconnecting a proxy
 188    * from an action in the group.
 189    *
 190    * #GtkUIManager proxies the signal and provides global notification
 191    * just before any action is connected to a proxy, which is probably more
 192    * convenient to use.
 193    *
 194    * Since: 2.4
 195    */
 196   action_group_signals[DISCONNECT_PROXY] =
 197     g_signal_new ("disconnect_proxy",
 198                   G_OBJECT_CLASS_TYPE (klass),
 199                   0, 0, NULL, NULL,
 200                   _gtk_marshal_VOID__OBJECT_OBJECT,
 201                   G_TYPE_NONE, 2,
 202                   GTK_TYPE_ACTION, GTK_TYPE_WIDGET);
 203
 204   /**
 205    * GtkActionGroup::pre_activate:
 206    * @action_group: the group
 207    * @action: the action
 208    *
 209    * The pre_activate signal is emitted just before the @action in the
 210    * @action_group is activated
 211    *
 212    * This is intended for #GtkUIManager to proxy the signal and provide global
 213    * notification just before any action is activated.
 214    *
 215    * Since: 2.4
 216    */
 217   action_group_signals[PRE_ACTIVATE] =
 218     g_signal_new ("pre_activate",
 219                   G_OBJECT_CLASS_TYPE (klass),
 220                   0, 0, NULL, NULL,
 221                   _gtk_marshal_VOID__OBJECT,
 222                   G_TYPE_NONE, 1,
 223                   GTK_TYPE_ACTION);
 224
 225   /**
 226    * GtkActionGroup::post_activate:
 227    * @action_group: the group
 228    * @action: the action
 229    *
 230    * The post_activate signal is emitted just after the @action in the
 231    * @action_group is activated
 232    *
 233    * This is intended for #GtkUIManager to proxy the signal and provide global
 234    * notification just after any action is activated.
 235    *
 236    * Since: 2.4
 237    */
 238   action_group_signals[POST_ACTIVATE] =
 239     g_signal_new ("post_activate",
 240                   G_OBJECT_CLASS_TYPE (klass),
 241                   0, 0, NULL, NULL,
 242                   _gtk_marshal_VOID__OBJECT,
 243                   G_TYPE_NONE, 1,
 244                   GTK_TYPE_ACTION);
 245
 246   g_type_class_add_private (gobject_class, sizeof (GtkActionGroupPrivate));
 247 }
 248
 249
 250 static void
 251 remove_action (GtkAction *action)
 252 {
 253   g_object_set (action, "action_group", NULL, NULL);
 254   g_object_unref (action);
 255 }
 256
 257 static void
 258 gtk_action_group_init (GtkActionGroup *self)
 259 {
 260   self->private_data = GTK_ACTION_GROUP_GET_PRIVATE (self);
 261   self->private_data->name = NULL;
 262   self->private_data->sensitive = TRUE;
 263   self->private_data->visible = TRUE;
 264   self->private_data->actions = g_hash_table_new_full (g_str_hash, g_str_equal,
 265                                                        (GDestroyNotify) g_free,
 266                                                        (GDestroyNotify) remove_action);
 267   self->private_data->translate_func = NULL;
 268   self->private_data->translate_data = NULL;
 269   self->private_data->translate_notify = NULL;
 270 }
 271
 272 /**
 273  * gtk_action_group_new:
 274  * @name: the name of the action group.
 275  *
 276  * Creates a new #GtkActionGroup object. The name of the action group
 277  * is used when associating <link linkend="Action-Accel">keybindings</link>
 278  * with the actions.
 279  *
 280  * Returns: the new #GtkActionGroup
 281  *
 282  * Since: 2.4
 283  */
 284 GtkActionGroup *
 285 gtk_action_group_new (const gchar *name)
 286 {
 287   GtkActionGroup *self;
 288
 289   self = g_object_new (GTK_TYPE_ACTION_GROUP, NULL);
 290   self->private_data->name = g_strdup (name);
 291
 292   return self;
 293 }
 294
 295 static void
 296 gtk_action_group_finalize (GObject *object)
 297 {
 298   GtkActionGroup *self;
 299
 300   self = GTK_ACTION_GROUP (object);
 301
 302   g_free (self->private_data->name);
 303   self->private_data->name = NULL;
 304
 305   g_hash_table_destroy (self->private_data->actions);
 306   self->private_data->actions = NULL;
 307
 308   if (self->private_data->translate_notify)
 309     self->private_data->translate_notify (self->private_data->translate_data);
 310
 311   if (parent_class->finalize)
 312     (* parent_class->finalize) (object);
 313 }
 314
 315 static void
 316 gtk_action_group_set_property (GObject         *object,
 317                                guint            prop_id,
 318                                const GValue    *value,
 319                                GParamSpec      *pspec)
 320 {
 321   GtkActionGroup *self;
 322   gchar *tmp;
 323
 324   self = GTK_ACTION_GROUP (object);
 325
 326   switch (prop_id)
 327     {
 328     case PROP_NAME:
 329       tmp = self->private_data->name;
 330       self->private_data->name = g_value_dup_string (value);
 331       g_free (tmp);
 332       break;
 333     case PROP_SENSITIVE:
 334       gtk_action_group_set_sensitive (self, g_value_get_boolean (value));
 335       break;
 336     case PROP_VISIBLE:
 337       gtk_action_group_set_visible (self, g_value_get_boolean (value));
 338       break;
 339     default:
 340       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 341       break;
 342     }
 343 }
 344
 345 static void
 346 gtk_action_group_get_property (GObject    *object,
 347                                guint       prop_id,
 348                                GValue     *value,
 349                                GParamSpec *pspec)
 350 {
 351   GtkActionGroup *self;
 352
 353   self = GTK_ACTION_GROUP (object);
 354
 355   switch (prop_id)
 356     {
 357     case PROP_NAME:
 358       g_value_set_string (value, self->private_data->name);
 359       break;
 360     case PROP_SENSITIVE:
 361       g_value_set_boolean (value, self->private_data->sensitive);
 362       break;
 363     case PROP_VISIBLE:
 364       g_value_set_boolean (value, self->private_data->visible);
 365       break;
 366     default:
 367       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 368       break;
 369     }
 370 }
 371
 372 static GtkAction *
 373 gtk_action_group_real_get_action (GtkActionGroup *self,
 374                                   const gchar    *action_name)
 375 {
 376   return g_hash_table_lookup (self->private_data->actions, action_name);
 377 }
 378
 379 /**
 380  * gtk_action_group_get_name:
 381  * @action_group: the action group
 382  *
 383  * Gets the name of the action group.
 384  *
 385  * Returns: the name of the action group.
 386  *
 387  * Since: 2.4
 388  */
 389 const gchar *
 390 gtk_action_group_get_name (GtkActionGroup *action_group)
 391 {
 392   g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
 393
 394   return action_group->private_data->name;
 395 }
 396
 397 /**
 398  * gtk_action_group_get_sensitive:
 399  * @action_group: the action group
 400  *
 401  * Returns %TRUE if the group is sensitive.  The constituent actions
 402  * can only be logically sensitive (see gtk_action_is_sensitive()) if
 403  * they are sensitive (see gtk_action_get_sensitive()) and their group
 404  * is sensitive.
 405  *
 406  * Return value: %TRUE if the group is sensitive.
 407  *
 408  * Since: 2.4
 409  */
 410 gboolean
 411 gtk_action_group_get_sensitive (GtkActionGroup *action_group)
 412 {
 413   g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), FALSE);
 414
 415   return action_group->private_data->sensitive;
 416 }
 417
 418 static void
 419 cb_set_action_sensitivity (const gchar *name, GtkAction *action)
 420 {
 421   /* Minor optimization, the action_groups state only effects actions that are
 422    * themselves sensitive */
 423   if (gtk_action_get_sensitive (action))
 424     g_object_notify (G_OBJECT (action), "sensitive");
 425 }
 426
 427 /**
 428  * gtk_action_group_set_sensitive:
 429  * @action_group: the action group
 430  * @sensitive: new sensitivity
 431  *
 432  * Changes the sensitivity of @action_group
 433  *
 434  * Since: 2.4
 435  */
 436 void
 437 gtk_action_group_set_sensitive (GtkActionGroup *action_group, gboolean sensitive)
 438 {
 439   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 440
 441   if (action_group->private_data->sensitive ^ sensitive)
 442     {
 443       action_group->private_data->sensitive = sensitive;
 444       g_hash_table_foreach (action_group->private_data->actions,
 445                             (GHFunc) cb_set_action_sensitivity, NULL);
 446     }
 447 }
 448
 449 /**
 450  * gtk_action_group_get_visible:
 451  * @action_group: the action group
 452  *
 453  * Returns %TRUE if the group is visible.  The constituent actions
 454  * can only be logically visible (see gtk_action_is_visible()) if
 455  * they are visible (see gtk_action_get_visible()) and their group
 456  * is visible.
 457  *
 458  * Return value: %TRUE if the group is sensitive.
 459  *
 460  * Since: 2.4
 461  */
 462 gboolean
 463 gtk_action_group_get_visible (GtkActionGroup *action_group)
 464 {
 465   g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), FALSE);
 466
 467   return action_group->private_data->visible;
 468 }
 469
 470 static void
 471 cb_set_action_visiblity (const gchar *name, GtkAction *action)
 472 {
 473   /* Minor optimization, the action_groups state only effects actions that are
 474    * themselves sensitive */
 475   if (gtk_action_get_visible (action))
 476     g_object_notify (G_OBJECT (action), "visible");
 477 }
 478
 479 /**
 480  * gtk_action_group_set_visible:
 481  * @action_group: the action group
 482  * @visible: new visiblity
 483  *
 484  * Changes the visible of @action_group.
 485  *
 486  * Since: 2.4
 487  */
 488 void
 489 gtk_action_group_set_visible (GtkActionGroup *action_group, gboolean visible)
 490 {
 491   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 492
 493   if (action_group->private_data->visible ^ visible)
 494     {
 495       action_group->private_data->visible = visible;
 496       g_hash_table_foreach (action_group->private_data->actions,
 497                             (GHFunc) cb_set_action_visiblity, NULL);
 498     }
 499 }
 500
 501 /**
 502  * gtk_action_group_get_action:
 503  * @action_group: the action group
 504  * @action_name: the name of the action
 505  *
 506  * Looks up an action in the action group by name.
 507  *
 508  * Returns: the action, or %NULL if no action by that name exists
 509  *
 510  * Since: 2.4
 511  */
 512 GtkAction *
 513 gtk_action_group_get_action (GtkActionGroup *action_group,
 514                              const gchar    *action_name)
 515 {
 516   g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
 517   g_return_val_if_fail (GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action != NULL, NULL);
 518
 519   return (* GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action)
 520     (action_group, action_name);
 521 }
 522
 523 /**
 524  * gtk_action_group_add_action:
 525  * @action_group: the action group
 526  * @action: an action
 527  *
 528  * Adds an action object to the action group.
 529  *
 530  * Since: 2.4
 531  */
 532 void
 533 gtk_action_group_add_action (GtkActionGroup *action_group,
 534                              GtkAction      *action)
 535 {
 536   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 537   g_return_if_fail (GTK_IS_ACTION (action));
 538   g_return_if_fail (gtk_action_get_name (action) != NULL);
 539
 540   g_hash_table_insert (action_group->private_data->actions,
 541                        g_strdup (gtk_action_get_name (action)),
 542                        g_object_ref (action));
 543   g_object_set (G_OBJECT (action), "action_group", action_group, NULL);
 544 }
 545
 546 /**
 547  * gtk_action_group_add_action_with_accel:
 548  * @action_group: the action group
 549  * @action: the action to add
 550  * @accelerator: the accelerator for the action, in
 551  *   the format understood by gtk_accelerator_parse(), or %NULL to use the
 552  *   stock accelerator
 553  *
 554  * Adds an action object to the action group and sets up the accelerator.
 555  *
 556  * If @accelerator is %NULL, attempts to use the accelerator associated
 557  * with the stock_id of the action.
 558  *
 559  * Accel paths are set to
 560  * <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
 561  *
 562  * Since: 2.4
 563  */
 564 void
 565 gtk_action_group_add_action_with_accel (GtkActionGroup *action_group,
 566                                         GtkAction *action,
 567                                         const gchar *accelerator)
 568 {
 569   gchar *accel_path;
 570   guint  accel_key = 0;
 571   GdkModifierType accel_mods;
 572   GtkStockItem stock_item;
 573   gchar *name;
 574   gchar *stock_id;
 575
 576   g_object_get (action, "name", &name, "stock_id", &stock_id, NULL);
 577
 578   accel_path = g_strconcat ("<Actions>/",
 579                             action_group->private_data->name, "/", name, NULL);
 580
 581   if (accelerator)
 582     gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
 583   else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
 584     {
 585       accel_key = stock_item.keyval;
 586       accel_mods = stock_item.modifier;
 587     }
 588
 589   if (accel_key)
 590     gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
 591
 592   gtk_action_set_accel_path (action, accel_path);
 593   gtk_action_group_add_action (action_group, action);
 594
 595   g_free (accel_path);
 596   g_free (stock_id);
 597   g_free (name);
 598 }
 599
 600 /**
 601  * gtk_action_group_remove_action:
 602  * @action_group: the action group
 603  * @action: an action
 604  *
 605  * Removes an action object from the action group.
 606  *
 607  * Since: 2.4
 608  */
 609 void
 610 gtk_action_group_remove_action (GtkActionGroup *action_group,
 611                                 GtkAction      *action)
 612 {
 613   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 614   g_return_if_fail (GTK_IS_ACTION (action));
 615   g_return_if_fail (gtk_action_get_name (action) != NULL);
 616
 617   /* extra protection to make sure action->name is valid */
 618   g_object_ref (action);
 619   g_hash_table_remove (action_group->private_data->actions, gtk_action_get_name (action));
 620   g_object_unref (action);
 621 }
 622
 623 static void
 624 add_single_action (gpointer key,
 625                    gpointer value,
 626                    gpointer user_data)
 627 {
 628   GList **list = user_data;
 629
 630   *list = g_list_prepend (*list, value);
 631 }
 632
 633 /**
 634  * gtk_action_group_list_actions:
 635  * @action_group: the action group
 636  *
 637  * Lists the actions in the action group.
 638  *
 639  * Returns: an allocated list of the action objects in the action group
 640  *
 641  * Since: 2.4
 642  */
 643 GList *
 644 gtk_action_group_list_actions (GtkActionGroup *action_group)
 645 {
 646   GList *actions = NULL;
 647   g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
 648
 649   g_hash_table_foreach (action_group->private_data->actions, add_single_action, &actions);
 650
 651   return g_list_reverse (actions);
 652 }
 653
 654
 655 /**
 656  * gtk_action_group_add_actions:
 657  * @action_group: the action group
 658  * @entries: an array of action descriptions
 659  * @n_entries: the number of entries
 660  * @user_data: data to pass to the action callbacks
 661  *
 662  * This is a convenience function to create a number of actions and add them
 663  * to the action group.
 664  *
 665  * The "activate" signals of the actions are connected to the callbacks and
 666  * their accel paths are set to
 667  * <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
 668  *
 669  * Since: 2.4
 670  */
 671 void
 672 gtk_action_group_add_actions (GtkActionGroup *action_group,
 673                               GtkActionEntry *entries,
 674                               guint           n_entries,
 675                               gpointer        user_data)
 676 {
 677   gtk_action_group_add_actions_full (action_group,
 678                                      entries, n_entries,
 679                                      user_data, NULL);
 680 }
 681
 682 typedef struct _SharedData  SharedData;
 683
 684 struct _SharedData {
 685   guint          ref_count;
 686   gpointer       data;
 687   GDestroyNotify destroy;
 688 };
 689
 690 static void
 691 shared_data_unref (gpointer data)
 692 {
 693   SharedData *shared_data = (SharedData *)data;
 694
 695   shared_data->ref_count--;
 696   if (shared_data->ref_count == 0)
 697     {
 698       if (shared_data->destroy)
 699         (*shared_data->destroy) (shared_data->data);
 700
 701       g_free (shared_data);
 702     }
 703 }
 704
 705
 706 /**
 707  * gtk_action_group_add_actions_full:
 708  * @action_group: the action group
 709  * @entries: an array of action descriptions
 710  * @n_entries: the number of entries
 711  * @user_data: data to pass to the action callbacks
 712  * @destroy: destroy notification callback for @user_data
 713  *
 714  * This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
 715  * callback for @user_data.
 716  *
 717  * Since: 2.4
 718  */
 719 void
 720 gtk_action_group_add_actions_full (GtkActionGroup *action_group,
 721                                    GtkActionEntry *entries,
 722                                    guint           n_entries,
 723                                    gpointer        user_data,
 724                                    GDestroyNotify  destroy)
 725 {
 726
 727   /* Keep this in sync with the other
 728    * gtk_action_group_add_..._actions_full() functions.
 729    */
 730   guint i;
 731   GtkTranslateFunc translate_func;
 732   gpointer translate_data;
 733   SharedData *shared_data;
 734
 735   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 736
 737   translate_func = action_group->private_data->translate_func;
 738   translate_data = action_group->private_data->translate_data;
 739
 740   shared_data = g_new0 (SharedData, 1);
 741   shared_data->ref_count = 1;
 742   shared_data->data = user_data;
 743   shared_data->destroy = destroy;
 744
 745   for (i = 0; i < n_entries; i++)
 746     {
 747       GtkAction *action;
 748       const gchar *label;
 749       const gchar *tooltip;
 750
 751       if (translate_func)
 752         {
 753           label = translate_func (entries[i].label, translate_data);
 754           tooltip = translate_func (entries[i].tooltip, translate_data);
 755         }
 756       else
 757         {
 758           label = entries[i].label;
 759           tooltip = entries[i].tooltip;
 760         }
 761
 762       action = gtk_action_new (entries[i].name,
 763                                label,
 764                                tooltip,
 765                                entries[i].stock_id);
 766
 767       if (entries[i].callback)
 768         {
 769           GClosure *closure;
 770
 771           closure = g_cclosure_new (entries[i].callback, user_data, NULL);
 772           g_closure_add_finalize_notifier (closure, shared_data,
 773                                            (GClosureNotify)shared_data_unref);
 774           shared_data->ref_count++;
 775
 776           g_signal_connect_closure (action, "activate", closure, FALSE);
 777         }
 778
 779       gtk_action_group_add_action_with_accel (action_group,
 780                                               action,
 781                                               entries[i].accelerator);
 782       g_object_unref (action);
 783     }
 784
 785   shared_data_unref (shared_data);
 786 }
 787
 788 /**
 789  * gtk_action_group_add_toggle_actions:
 790  * @action_group: the action group
 791  * @entries: an array of toggle action descriptions
 792  * @n_entries: the number of entries
 793  * @user_data: data to pass to the action callbacks
 794  *
 795  * This is a convenience function to create a number of toggle actions and add them
 796  * to the action group.
 797  *
 798  * The "activate" signals of the actions are connected to the callbacks and
 799  * their accel paths are set to
 800  * <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
 801  *
 802  * Since: 2.4
 803  */
 804 void
 805 gtk_action_group_add_toggle_actions (GtkActionGroup       *action_group,
 806                                      GtkToggleActionEntry *entries,
 807                                      guint                 n_entries,
 808                                      gpointer              user_data)
 809 {
 810   gtk_action_group_add_toggle_actions_full (action_group,
 811                                             entries, n_entries,
 812                                             user_data, NULL);
 813 }
 814
 815
 816 /**
 817  * gtk_action_group_add_toggle_actions_full:
 818  * @action_group: the action group
 819  * @entries: an array of toggle action descriptions
 820  * @n_entries: the number of entries
 821  * @user_data: data to pass to the action callbacks
 822  * @destroy: destroy notification callback for @user_data
 823  *
 824  * This variant of gtk_action_group_add_toggle_actions() adds a
 825  * #GDestroyNotify callback for @user_data.
 826  *
 827  * Since: 2.4
 828  */
 829 void
 830 gtk_action_group_add_toggle_actions_full (GtkActionGroup       *action_group,
 831                                           GtkToggleActionEntry *entries,
 832                                           guint                 n_entries,
 833                                           gpointer              user_data,
 834                                           GDestroyNotify        destroy)
 835 {
 836   /* Keep this in sync with the other
 837    * gtk_action_group_add_..._actions_full() functions.
 838    */
 839   guint i;
 840   GtkTranslateFunc translate_func;
 841   gpointer translate_data;
 842   SharedData *shared_data;
 843
 844   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 845
 846   translate_func = action_group->private_data->translate_func;
 847   translate_data = action_group->private_data->translate_data;
 848
 849   shared_data = g_new0 (SharedData, 1);
 850   shared_data->ref_count = 1;
 851   shared_data->data = user_data;
 852   shared_data->destroy = destroy;
 853
 854   for (i = 0; i < n_entries; i++)
 855     {
 856       GtkToggleAction *action;
 857       const gchar *label;
 858       const gchar *tooltip;
 859
 860       if (translate_func)
 861         {
 862           label = translate_func (entries[i].label, translate_data);
 863           tooltip = translate_func (entries[i].tooltip, translate_data);
 864         }
 865       else
 866         {
 867           label = entries[i].label;
 868           tooltip = entries[i].tooltip;
 869         }
 870
 871       action = gtk_toggle_action_new (entries[i].name,
 872                                       label,
 873                                       tooltip,
 874                                       entries[i].stock_id);
 875
 876       gtk_toggle_action_set_active (action, entries[i].is_active);
 877
 878       if (entries[i].callback)
 879         {
 880           GClosure *closure;
 881
 882           closure = g_cclosure_new (entries[i].callback, user_data, NULL);
 883           g_closure_add_finalize_notifier (closure, shared_data,
 884                                            (GClosureNotify)shared_data_unref);
 885           shared_data->ref_count++;
 886
 887           g_signal_connect_closure (action, "activate", closure, FALSE);
 888         }
 889
 890       gtk_action_group_add_action_with_accel (action_group,
 891                                               GTK_ACTION (action),
 892                                               entries[i].accelerator);
 893       g_object_unref (action);
 894     }
 895
 896     shared_data_unref (shared_data);
 897 }
 898
 899 /**
 900  * gtk_action_group_add_radio_actions:
 901  * @action_group: the action group
 902  * @entries: an array of radio action descriptions
 903  * @n_entries: the number of entries
 904  * @value: the value of the action to activate initially, or -1 if
 905  *   no action should be activated
 906  * @on_change: the callback to connect to the changed signal
 907  * @user_data: data to pass to the action callbacks
 908  *
 909  * This is a convenience routine to create a group of radio actions and
 910  * add them to the action group.
 911  *
 912  * The "changed" signal of the first radio action is connected to the
 913  * @on_change callback and the accel paths of the actions are set to
 914  * <literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
 915  *
 916  * Since: 2.4
 917  **/
 918 void
 919 gtk_action_group_add_radio_actions (GtkActionGroup      *action_group,
 920                                     GtkRadioActionEntry *entries,
 921                                     guint                n_entries,
 922                                     gint                 value,
 923                                     GCallback            on_change,
 924                                     gpointer             user_data)
 925 {
 926   gtk_action_group_add_radio_actions_full (action_group,
 927                                            entries, n_entries,
 928                                            value,
 929                                            on_change, user_data, NULL);
 930 }
 931
 932 /**
 933  * gtk_action_group_add_radio_actions_full:
 934  * @action_group: the action group
 935  * @entries: an array of radio action descriptions
 936  * @n_entries: the number of entries
 937  * @value: the value of the action to activate initially, or -1 if
 938  *   no action should be activated
 939  * @on_change: the callback to connect to the changed signal
 940  * @user_data: data to pass to the action callbacks
 941  * @destroy: destroy notification callback for @user_data
 942  *
 943  * This variant of gtk_action_group_add_radio_actions() adds a
 944  * #GDestroyNotify callback for @user_data.
 945  *
 946  * Since: 2.4
 947  **/
 948 void
 949 gtk_action_group_add_radio_actions_full (GtkActionGroup      *action_group,
 950                                          GtkRadioActionEntry *entries,
 951                                          guint                n_entries,
 952                                          gint                 value,
 953                                          GCallback            on_change,
 954                                          gpointer             user_data,
 955                                          GDestroyNotify       destroy)
 956 {
 957   /* Keep this in sync with the other
 958    * gtk_action_group_add_..._actions_full() functions.
 959    */
 960   guint i;
 961   GtkTranslateFunc translate_func;
 962   gpointer translate_data;
 963   GSList *group = NULL;
 964   GtkRadioAction *first_action = NULL;
 965
 966   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
 967
 968   translate_func = action_group->private_data->translate_func;
 969   translate_data = action_group->private_data->translate_data;
 970
 971   for (i = 0; i < n_entries; i++)
 972     {
 973       GtkRadioAction *action;
 974       const gchar *label;
 975       const gchar *tooltip;
 976
 977       if (translate_func)
 978         {
 979           label = translate_func (entries[i].label, translate_data);
 980           tooltip = translate_func (entries[i].tooltip, translate_data);
 981         }
 982       else
 983         {
 984           label = entries[i].label;
 985           tooltip = entries[i].tooltip;
 986         }
 987
 988       action = gtk_radio_action_new (entries[i].name,
 989                                      label,
 990                                      tooltip,
 991                                      entries[i].stock_id,
 992                                      entries[i].value);
 993
 994       if (i == 0)
 995         first_action = action;
 996
 997       gtk_radio_action_set_group (action, group);
 998       group = gtk_radio_action_get_group (action);
 999
1000       if (value == entries[i].value)
1001         gtk_toggle_action_set_active (GTK_TOGGLE_ACTION (action), TRUE);
1002
1003       gtk_action_group_add_action_with_accel (action_group,
1004                                               GTK_ACTION (action),
1005                                               entries[i].accelerator);
1006       g_object_unref (action);
1007     }
1008
1009   if (on_change && first_action)
1010     g_signal_connect_data (first_action, "changed",
1011                            on_change, user_data,
1012                            (GClosureNotify)destroy, 0);
1013 }
1014
1015 /**
1016  * gtk_action_group_set_translate_func:
1017  * @action_group: a #GtkActionGroup
1018  * @func: a #GtkTranslateFunc
1019  * @data: data to be passed to @func and @notify
1020  * @notify: a #GtkDestroyNotify function to be called when @action_group is
1021  *   destroyed and when the translation function is changed again
1022  *
1023  * Sets a function to be used for translating the @label and @tooltip of
1024  * #GtkActionGroupEntry<!-- -->s added by gtk_action_group_add_actions().
1025  *
1026  * If you're using gettext(), it is enough to set the translation domain
1027  * with gtk_action_group_set_translation_domain().
1028  *
1029  * Since: 2.4
1030  **/
1031 void
1032 gtk_action_group_set_translate_func (GtkActionGroup      *action_group,
1033                                      GtkTranslateFunc     func,
1034                                      gpointer             data,
1035                                      GtkDestroyNotify     notify)
1036 {
1037   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
1038
1039   if (action_group->private_data->translate_notify)
1040     action_group->private_data->translate_notify (action_group->private_data->translate_data);
1041
1042   action_group->private_data->translate_func = func;
1043   action_group->private_data->translate_data = data;
1044   action_group->private_data->translate_notify = notify;
1045 }
1046
1047 static gchar *
1048 dgettext_swapped (const gchar *msgid,
1049                   const gchar *domainname)
1050 {
1051   return dgettext (domainname, msgid);
1052 }
1053
1054 /**
1055  * gtk_action_group_set_translation_domain:
1056  * @action_group: a #GtkActionGroup
1057  * @domain: the translation domain to use for dgettext() calls
1058  *
1059  * Sets the translation domain and uses dgettext() for translating the
1060  * @label and @tooltip of #GtkActionEntry<!-- -->s added by
1061  * gtk_action_group_add_actions().
1062  *
1063  * If you're not using gettext() for localization, see
1064  * gtk_action_group_set_translate_func().
1065  *
1066  * Since: 2.4
1067  **/
1068 void
1069 gtk_action_group_set_translation_domain (GtkActionGroup *action_group,
1070                                          const gchar    *domain)
1071 {
1072   g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
1073
1074   gtk_action_group_set_translate_func (action_group,
1075                                        (GtkTranslateFunc)dgettext_swapped,
1076                                        g_strdup (domain),
1077                                        g_free);
1078 }
1079
1080 /* Protected for use by GtkAction */
1081 void
1082 _gtk_action_group_emit_connect_proxy  (GtkActionGroup *action_group,
1083                                        GtkAction      *action,
1084                                        GtkWidget      *proxy)
1085 {
1086   g_signal_emit (action_group, action_group_signals[CONNECT_PROXY], 0,
1087                  action, proxy);
1088 }
1089
1090 void
1091 _gtk_action_group_emit_disconnect_proxy  (GtkActionGroup *action_group,
1092                                           GtkAction      *action,
1093                                           GtkWidget      *proxy)
1094 {
1095   g_signal_emit (action_group, action_group_signals[DISCONNECT_PROXY], 0,
1096                  action, proxy);
1097 }
1098
1099 void
1100 _gtk_action_group_emit_pre_activate  (GtkActionGroup *action_group,
1101                                       GtkAction      *action)
1102 {
1103   g_signal_emit (action_group, action_group_signals[PRE_ACTIVATE], 0, action);
1104 }
1105
1106 void
1107 _gtk_action_group_emit_post_activate (GtkActionGroup *action_group,
1108                                       GtkAction *action)
1109 {
1110   g_signal_emit (action_group, action_group_signals[POST_ACTIVATE], 0, action);
1111 }