gtkactiongroup.c 43.7 KB
Newer Older
1
/*
Cody Russell's avatar
Cody Russell committed
2
 * GTK - The GIMP Toolkit
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 * Copyright (C) 1998, 1999 Red Hat, Inc.
 * All rights reserved.
 *
 * This Library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This Library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25 26 27 28
 */

/*
 * Author: James Henstridge <james@daa.com.au>
 *
 * Modified by the GTK+ Team and others 2003.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * SECTION:gtkactiongroup
 * @Short_description: A group of actions
 * @Title: GtkActionGroup
 *
 * Actions are organised into groups. An action group is essentially a
 * map from names to #GtkAction objects.
 *
 * All actions that would make sense to use in a particular context
 * should be in a single group. Multiple action groups may be used for a
 * particular user interface. In fact, it is expected that most nontrivial
 * applications will make use of multiple groups. For example, in an
 * application that can edit multiple documents, one group holding global
 * actions (e.g. quit, about, new), and one group per document holding
 * actions that act on that document (eg. save, cut/copy/paste, etc). Each
44
 * window’s menus would be constructed from a combination of two action
45
 * groups.
46
 *
47 48
 * ## Accelerators ## {#Action-Accel}
 *
49 50
 * Accelerators are handled by the GTK+ accelerator map. All actions are
 * assigned an accelerator path (which normally has the form
51 52 53 54
 * `<Actions>/group-name/action-name`) and a shortcut is associated with
 * this accelerator path. All menuitems and toolitems take on this accelerator
 * path. The GTK+ accelerator map code makes sure that the correct shortcut
 * is displayed next to the menu item.
55
 *
56 57
 * # GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI}
 *
58
 * The #GtkActionGroup implementation of the #GtkBuildable interface accepts
59
 * #GtkAction objects as <child> elements in UI definitions.
60 61 62 63 64
 *
 * Note that it is probably more common to define actions and action groups
 * in the code, since they are directly related to what the code can do.
 *
 * The GtkActionGroup implementation of the GtkBuildable interface supports
65 66 67
 * a custom <accelerator> element, which has attributes named “key“ and
 * “modifiers“ and allows to specify accelerators. This is similar to the
 * <accelerator> element of #GtkWidget, the main difference is that
68
 * it doesn’t allow you to specify a signal.
69 70
 *
 * ## A #GtkDialog UI definition fragment. ##
71
 * |[
72 73 74 75 76 77 78 79 80 81
 * <object class="GtkActionGroup" id="actiongroup">
 *   <child>
 *       <object class="GtkAction" id="About">
 *           <property name="name">About</property>
 *           <property name="stock_id">gtk-about</property>
 *           <signal handler="about_activate" name="activate"/>
 *       </object>
 *       <accelerator key="F1" modifiers="GDK_CONTROL_MASK | GDK_SHIFT_MASK"/>
 *   </child>
 * </object>
82
 * ]|
83
 *
84 85
 */

86
#include "config.h"
87
#include <string.h>
88

89 90
#define GDK_DISABLE_DEPRECATION_WARNINGS

91
#include "gtkactiongroup.h"
Johan Dahlin's avatar
Johan Dahlin committed
92
#include "gtkbuildable.h"
Matthias Clasen's avatar
Matthias Clasen committed
93
#include "gtkiconfactory.h"
Matthias Clasen's avatar
Matthias Clasen committed
94
#include "gtkicontheme.h"
95
#include "gtkstock.h"
96 97 98
#include "gtktoggleaction.h"
#include "gtkradioaction.h"
#include "gtkaccelmap.h"
99
#include "gtkmarshalers.h"
100
#include "gtkbuilderprivate.h"
101
#include "gtkprivate.h"
102 103 104 105 106
#include "gtkintl.h"


struct _GtkActionGroupPrivate 
{
107
  gchar           *name;
108 109
  gboolean	   sensitive;
  gboolean	   visible;
110
  GHashTable      *actions;
111
  GtkAccelGroup   *accel_group;
112 113 114

  GtkTranslateFunc translate_func;
  gpointer         translate_data;
115
  GDestroyNotify   translate_notify;
116 117
};

118 119 120 121 122 123 124 125 126
enum 
{
  CONNECT_PROXY,
  DISCONNECT_PROXY,
  PRE_ACTIVATE,
  POST_ACTIVATE,
  LAST_SIGNAL
};

127 128 129
enum 
{
  PROP_0,
130 131
  PROP_NAME,
  PROP_SENSITIVE,
132 133
  PROP_VISIBLE,
  PROP_ACCEL_GROUP
134 135
};

136 137 138
static void       gtk_action_group_init            (GtkActionGroup      *self);
static void       gtk_action_group_class_init      (GtkActionGroupClass *class);
static void       gtk_action_group_finalize        (GObject             *object);
139 140 141 142 143 144 145 146
static void       gtk_action_group_set_property    (GObject             *object,
						    guint                prop_id,
						    const GValue        *value,
						    GParamSpec          *pspec);
static void       gtk_action_group_get_property    (GObject             *object,
						    guint                prop_id,
						    GValue              *value,
						    GParamSpec          *pspec);
147 148 149
static GtkAction *gtk_action_group_real_get_action (GtkActionGroup      *self,
						    const gchar         *name);

Johan Dahlin's avatar
Johan Dahlin committed
150 151
/* GtkBuildable */
static void gtk_action_group_buildable_init (GtkBuildableIface *iface);
152 153 154 155
static void gtk_action_group_buildable_add_child (GtkBuildable  *buildable,
						  GtkBuilder    *builder,
						  GObject       *child,
						  const gchar   *type);
Johan Dahlin's avatar
Johan Dahlin committed
156 157 158
static void gtk_action_group_buildable_set_name (GtkBuildable *buildable,
						 const gchar  *name);
static const gchar* gtk_action_group_buildable_get_name (GtkBuildable *buildable);
159 160 161 162 163 164 165 166 167 168 169
static gboolean gtk_action_group_buildable_custom_tag_start (GtkBuildable     *buildable,
							     GtkBuilder       *builder,
							     GObject          *child,
							     const gchar      *tagname,
							     GMarkupParser    *parser,
							     gpointer         *data);
static void gtk_action_group_buildable_custom_tag_end (GtkBuildable *buildable,
						       GtkBuilder   *builder,
						       GObject      *child,
						       const gchar  *tagname,
						       gpointer     *user_data);
170

171
static guint         action_group_signals[LAST_SIGNAL] = { 0 };
172

173 174 175 176 177
G_DEFINE_TYPE_WITH_CODE (GtkActionGroup, gtk_action_group, G_TYPE_OBJECT,
                         G_ADD_PRIVATE (GtkActionGroup)
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
                                                gtk_action_group_buildable_init))

178 179 180 181 182 183 184 185
static void
gtk_action_group_class_init (GtkActionGroupClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);

  gobject_class->finalize = gtk_action_group_finalize;
186 187
  gobject_class->set_property = gtk_action_group_set_property;
  gobject_class->get_property = gtk_action_group_get_property;
188 189
  klass->get_action = gtk_action_group_real_get_action;

190 191 192 193 194 195 196
  /**
   * GtkActionGroup:name:
   *
   * A name for the action.
   *
   * Deprecated: 3.10
   */
197 198 199
  g_object_class_install_property (gobject_class,
				   PROP_NAME,
				   g_param_spec_string ("name",
200 201
							P_("Name"),
							P_("A name for the action group."),
202
							NULL,
203
							GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
204 205 206 207 208 209 210
  /**
   * GtkActionGroup:sensitive:
   *
   * Whether the action group is enabled.
   *
   * Deprecated: 3.10
   */
211 212 213
  g_object_class_install_property (gobject_class,
				   PROP_SENSITIVE,
				   g_param_spec_boolean ("sensitive",
214 215
							 P_("Sensitive"),
							 P_("Whether the action group is enabled."),
216
							 TRUE,
217
							 GTK_PARAM_READWRITE));
218 219 220 221 222 223 224
  /**
   * GtkActionGroup:visible:
   *
   * Whether the action group is visible.
   *
   * Deprecated: 3.10
   */
225 226 227
  g_object_class_install_property (gobject_class,
				   PROP_VISIBLE,
				   g_param_spec_boolean ("visible",
228 229
							 P_("Visible"),
							 P_("Whether the action group is visible."),
230
							 TRUE,
231
							 GTK_PARAM_READWRITE));
232 233 234 235 236 237 238
  /**
   * GtkActionGroup:accel-group:
   *
   * The accelerator group the actions of this group should use.
   *
   * Deprecated: 3.10
   */
239 240 241 242 243 244 245
  g_object_class_install_property (gobject_class,
				   PROP_ACCEL_GROUP,
				   g_param_spec_object ("accel-group",
							P_("Accelerator Group"),
							P_("The accelerator group the actions of this group should use."),
							GTK_TYPE_ACCEL_GROUP,
							GTK_PARAM_READWRITE));
246 247

  /**
248
   * GtkActionGroup::connect-proxy:
249 250 251 252
   * @action_group: the group
   * @action: the action
   * @proxy: the proxy
   *
253
   * The ::connect-proxy signal is emitted after connecting a proxy to 
254 255 256 257 258 259 260 261 262 263 264 265
   * an action in the group. Note that the proxy may have been connected 
   * to a different action before.
   *
   * This is intended for simple customizations for which a custom action
   * class would be too clumsy, e.g. showing tooltips for menuitems in the
   * statusbar.
   *
   * #GtkUIManager proxies the signal and provides global notification 
   * just before any action is connected to a proxy, which is probably more
   * convenient to use.
   *
   * Since: 2.4
266 267
   *
   * Deprecated: 3.10
268 269
   */
  action_group_signals[CONNECT_PROXY] =
270
    g_signal_new (I_("connect-proxy"),
271 272 273 274 275 276 277
		  G_OBJECT_CLASS_TYPE (klass),
		  0, 0, NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_OBJECT,
		  G_TYPE_NONE, 2,
		  GTK_TYPE_ACTION, GTK_TYPE_WIDGET);

  /**
278
   * GtkActionGroup::disconnect-proxy:
279 280 281 282
   * @action_group: the group
   * @action: the action
   * @proxy: the proxy
   *
283
   * The ::disconnect-proxy signal is emitted after disconnecting a proxy 
284 285 286 287 288 289 290
   * from an action in the group. 
   *
   * #GtkUIManager proxies the signal and provides global notification 
   * just before any action is connected to a proxy, which is probably more
   * convenient to use.
   *
   * Since: 2.4
291 292
   *
   * Deprecated: 3.10
293 294
   */
  action_group_signals[DISCONNECT_PROXY] =
295
    g_signal_new (I_("disconnect-proxy"),
296 297 298 299 300 301 302
		  G_OBJECT_CLASS_TYPE (klass),
		  0, 0, NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_OBJECT,
		  G_TYPE_NONE, 2, 
		  GTK_TYPE_ACTION, GTK_TYPE_WIDGET);

  /**
303
   * GtkActionGroup::pre-activate:
304 305 306
   * @action_group: the group
   * @action: the action
   *
307
   * The ::pre-activate signal is emitted just before the @action in the
308 309 310 311 312 313
   * @action_group is activated
   *
   * This is intended for #GtkUIManager to proxy the signal and provide global
   * notification just before any action is activated.
   *
   * Since: 2.4
314 315
   *
   * Deprecated: 3.10
316 317
   */
  action_group_signals[PRE_ACTIVATE] =
318
    g_signal_new (I_("pre-activate"),
319 320 321 322 323 324 325
		  G_OBJECT_CLASS_TYPE (klass),
		  0, 0, NULL, NULL,
		  _gtk_marshal_VOID__OBJECT,
		  G_TYPE_NONE, 1, 
		  GTK_TYPE_ACTION);

  /**
326
   * GtkActionGroup::post-activate:
327 328 329
   * @action_group: the group
   * @action: the action
   *
330
   * The ::post-activate signal is emitted just after the @action in the
331 332 333 334 335 336
   * @action_group is activated
   *
   * This is intended for #GtkUIManager to proxy the signal and provide global
   * notification just after any action is activated.
   *
   * Since: 2.4
337 338
   *
   * Deprecated: 3.10
339 340
   */
  action_group_signals[POST_ACTIVATE] =
341
    g_signal_new (I_("post-activate"),
342 343 344 345 346
		  G_OBJECT_CLASS_TYPE (klass),
		  0, 0, NULL, NULL,
		  _gtk_marshal_VOID__OBJECT,
		  G_TYPE_NONE, 1, 
		  GTK_TYPE_ACTION);
347 348
}

Matthias Clasen's avatar
Matthias Clasen committed
349 350 351 352

static void 
remove_action (GtkAction *action) 
{
353
  g_object_set (action, I_("action-group"), NULL, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
354 355 356
  g_object_unref (action);
}

357
static void
358
gtk_action_group_init (GtkActionGroup *action_group)
359
{
360 361 362 363 364 365 366 367 368 369
  action_group->priv = gtk_action_group_get_instance_private (action_group);
  action_group->priv->name = NULL;
  action_group->priv->sensitive = TRUE;
  action_group->priv->visible = TRUE;
  action_group->priv->actions = g_hash_table_new_full (g_str_hash, g_str_equal,
                                                       NULL,
                                                       (GDestroyNotify) remove_action);
  action_group->priv->translate_func = NULL;
  action_group->priv->translate_data = NULL;
  action_group->priv->translate_notify = NULL;
370 371
}

Johan Dahlin's avatar
Johan Dahlin committed
372 373 374
static void
gtk_action_group_buildable_init (GtkBuildableIface *iface)
{
375
  iface->add_child = gtk_action_group_buildable_add_child;
Johan Dahlin's avatar
Johan Dahlin committed
376 377
  iface->set_name = gtk_action_group_buildable_set_name;
  iface->get_name = gtk_action_group_buildable_get_name;
378 379
  iface->custom_tag_start = gtk_action_group_buildable_custom_tag_start;
  iface->custom_tag_end = gtk_action_group_buildable_custom_tag_end;
Johan Dahlin's avatar
Johan Dahlin committed
380 381 382
}

static void
383 384 385 386
gtk_action_group_buildable_add_child (GtkBuildable  *buildable,
				      GtkBuilder    *builder,
				      GObject       *child,
				      const gchar   *type)
Johan Dahlin's avatar
Johan Dahlin committed
387
{
388 389
  gtk_action_group_add_action_with_accel (GTK_ACTION_GROUP (buildable),
					  GTK_ACTION (child), NULL);
Johan Dahlin's avatar
Johan Dahlin committed
390 391 392 393 394 395 396
}

static void
gtk_action_group_buildable_set_name (GtkBuildable *buildable,
				     const gchar  *name)
{
  GtkActionGroup *self = GTK_ACTION_GROUP (buildable);
397
  GtkActionGroupPrivate *private = self->priv;
Tim Janik's avatar
Tim Janik committed
398 399

  private->name = g_strdup (name);
Johan Dahlin's avatar
Johan Dahlin committed
400 401 402 403 404 405
}

static const gchar *
gtk_action_group_buildable_get_name (GtkBuildable *buildable)
{
  GtkActionGroup *self = GTK_ACTION_GROUP (buildable);
406 407
  GtkActionGroupPrivate *private = self->priv;

Tim Janik's avatar
Tim Janik committed
408
  return private->name;
Johan Dahlin's avatar
Johan Dahlin committed
409 410
}

411
typedef struct {
412 413 414
  GObject         *child;
  guint            key;
  GdkModifierType  modifiers;
415 416 417 418 419 420 421 422 423 424 425 426
} AcceleratorParserData;

static void
accelerator_start_element (GMarkupParseContext *context,
			   const gchar         *element_name,
			   const gchar        **names,
			   const gchar        **values,
			   gpointer             user_data,
			   GError             **error)
{
  gint i;
  guint key = 0;
427
  GdkModifierType modifiers = 0;
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
  AcceleratorParserData *parser_data = (AcceleratorParserData*)user_data;

  if (strcmp (element_name, "accelerator") != 0)
    g_warning ("Unknown <accelerator> tag: %s", element_name);

  for (i = 0; names[i]; i++)
    {
      if (strcmp (names[i], "key") == 0)
	key = gdk_keyval_from_name (values[i]);
      else if (strcmp (names[i], "modifiers") == 0)
	{
	  if (!_gtk_builder_flags_from_string (GDK_TYPE_MODIFIER_TYPE,
					       values[i],
					       &modifiers,
					       error))
	      return;
	}
    }

  if (key == 0)
    {
      g_warning ("<accelerator> requires a key attribute");
      return;
    }
  parser_data->key = key;
453
  parser_data->modifiers = modifiers;
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
}

static const GMarkupParser accelerator_parser =
  {
    accelerator_start_element
  };

static gboolean
gtk_action_group_buildable_custom_tag_start (GtkBuildable     *buildable,
					     GtkBuilder       *builder,
					     GObject          *child,
					     const gchar      *tagname,
					     GMarkupParser    *parser,
					     gpointer         *user_data)
{
  AcceleratorParserData *parser_data;

  if (child && strcmp (tagname, "accelerator") == 0)
    {
      parser_data = g_slice_new0 (AcceleratorParserData);
      parser_data->child = child;
      *user_data = parser_data;
      *parser = accelerator_parser;

      return TRUE;
    }
  return FALSE;
}

static void
gtk_action_group_buildable_custom_tag_end (GtkBuildable *buildable,
					   GtkBuilder   *builder,
					   GObject      *child,
					   const gchar  *tagname,
					   gpointer     *user_data)
{
  AcceleratorParserData *data;
  
  if (strcmp (tagname, "accelerator") == 0)
    {
      GtkActionGroup *action_group;
Tim Janik's avatar
Tim Janik committed
495
      GtkActionGroupPrivate *private;
496 497 498 499 500
      GtkAction *action;
      gchar *accel_path;
      
      data = (AcceleratorParserData*)user_data;
      action_group = GTK_ACTION_GROUP (buildable);
501
      private = action_group->priv;
502 503 504
      action = GTK_ACTION (child);
	
      accel_path = g_strconcat ("<Actions>/",
Tim Janik's avatar
Tim Janik committed
505
				private->name, "/",
506 507 508 509 510 511 512 513 514 515 516 517 518 519
				gtk_action_get_name (action), NULL);

      if (gtk_accel_map_lookup_entry (accel_path, NULL))
	gtk_accel_map_change_entry (accel_path, data->key, data->modifiers, TRUE);
      else
	gtk_accel_map_add_entry (accel_path, data->key, data->modifiers);

      gtk_action_set_accel_path (action, accel_path);
      
      g_free (accel_path);
      g_slice_free (AcceleratorParserData, data);
    }
}

520 521
/**
 * gtk_action_group_new:
Matthias Clasen's avatar
Matthias Clasen committed
522
 * @name: the name of the action group.
523
 *
Matthias Clasen's avatar
Matthias Clasen committed
524
 * Creates a new #GtkActionGroup object. The name of the action group
525
 * is used when associating [keybindings][Action-Accel] 
Matthias Clasen's avatar
Matthias Clasen committed
526
 * with the actions.
527 528 529 530
 *
 * Returns: the new #GtkActionGroup
 *
 * Since: 2.4
531 532
 *
 * Deprecated: 3.10
533 534 535 536 537
 */
GtkActionGroup *
gtk_action_group_new (const gchar *name)
{
  GtkActionGroup *self;
Tim Janik's avatar
Tim Janik committed
538
  GtkActionGroupPrivate *private;
539 540

  self = g_object_new (GTK_TYPE_ACTION_GROUP, NULL);
541
  private = self->priv;
Tim Janik's avatar
Tim Janik committed
542
  private->name = g_strdup (name);
543 544 545 546 547 548 549

  return self;
}

static void
gtk_action_group_finalize (GObject *object)
{
550
  GtkActionGroup *self = GTK_ACTION_GROUP (object);
551

552
  g_free (self->priv->name);
553

554
  g_hash_table_destroy (self->priv->actions);
555

556
  g_clear_object (&self->priv->accel_group);
557

558 559
  if (self->priv->translate_notify != NULL)
    self->priv->translate_notify (self->priv->translate_data);
560

561
  G_OBJECT_CLASS (gtk_action_group_parent_class)->finalize (object);
562 563
}

564 565 566 567 568 569 570
static void
gtk_action_group_set_property (GObject         *object,
			       guint            prop_id,
			       const GValue    *value,
			       GParamSpec      *pspec)
{
  GtkActionGroup *self;
Tim Janik's avatar
Tim Janik committed
571
  GtkActionGroupPrivate *private;
572 573 574
  gchar *tmp;
  
  self = GTK_ACTION_GROUP (object);
575
  private = self->priv;
576 577 578 579

  switch (prop_id)
    {
    case PROP_NAME:
Tim Janik's avatar
Tim Janik committed
580 581
      tmp = private->name;
      private->name = g_value_dup_string (value);
582 583
      g_free (tmp);
      break;
584 585 586 587 588 589
    case PROP_SENSITIVE:
      gtk_action_group_set_sensitive (self, g_value_get_boolean (value));
      break;
    case PROP_VISIBLE:
      gtk_action_group_set_visible (self, g_value_get_boolean (value));
      break;
590 591 592
    case PROP_ACCEL_GROUP:
      gtk_action_group_set_accel_group (self, g_value_get_object (value));
      break;
593 594 595 596 597 598 599 600 601 602 603 604 605
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_action_group_get_property (GObject    *object,
			       guint       prop_id,
			       GValue     *value,
			       GParamSpec *pspec)
{
  GtkActionGroup *self;
Tim Janik's avatar
Tim Janik committed
606
  GtkActionGroupPrivate *private;
607 608
  
  self = GTK_ACTION_GROUP (object);
609
  private = self->priv;
610 611 612 613

  switch (prop_id)
    {
    case PROP_NAME:
Tim Janik's avatar
Tim Janik committed
614
      g_value_set_string (value, private->name);
615
      break;
616
    case PROP_SENSITIVE:
Tim Janik's avatar
Tim Janik committed
617
      g_value_set_boolean (value, private->sensitive);
618 619
      break;
    case PROP_VISIBLE:
Tim Janik's avatar
Tim Janik committed
620
      g_value_set_boolean (value, private->visible);
621
      break;
622 623 624
    case PROP_ACCEL_GROUP:
      g_value_set_object (value, private->accel_group);
      break;
625 626 627 628 629 630
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

631 632 633 634
static GtkAction *
gtk_action_group_real_get_action (GtkActionGroup *self,
				  const gchar    *action_name)
{
Tim Janik's avatar
Tim Janik committed
635 636
  GtkActionGroupPrivate *private;

637
  private = self->priv;
Tim Janik's avatar
Tim Janik committed
638 639

  return g_hash_table_lookup (private->actions, action_name);
640 641 642 643 644 645 646 647 648 649 650
}

/**
 * gtk_action_group_get_name:
 * @action_group: the action group
 *
 * Gets the name of the action group.
 *
 * Returns: the name of the action group.
 * 
 * Since: 2.4
651 652
 *
 * Deprecated: 3.10
653
 */
654
const gchar *
655 656
gtk_action_group_get_name (GtkActionGroup *action_group)
{
Tim Janik's avatar
Tim Janik committed
657 658
  GtkActionGroupPrivate *private;

659 660
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);

661
  private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
662 663

  return private->name;
664 665
}

666 667 668 669 670 671 672 673 674
/**
 * gtk_action_group_get_sensitive:
 * @action_group: the action group
 *
 * Returns %TRUE if the group is sensitive.  The constituent actions
 * can only be logically sensitive (see gtk_action_is_sensitive()) if
 * they are sensitive (see gtk_action_get_sensitive()) and their group
 * is sensitive.
 * 
675
 * Returns: %TRUE if the group is sensitive.
676 677
 *
 * Since: 2.4
678 679
 *
 * Deprecated: 3.10
680 681 682 683
 */
gboolean
gtk_action_group_get_sensitive (GtkActionGroup *action_group)
{
Tim Janik's avatar
Tim Janik committed
684 685
  GtkActionGroupPrivate *private;

686 687
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), FALSE);

688
  private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
689 690

  return private->sensitive;
691 692 693
}

static void
694 695
cb_set_action_sensitivity (const gchar *name, 
			   GtkAction   *action)
696
{
697 698
  /* Minor optimization, the action_groups state only affects actions 
   * that are themselves sensitive */
699 700
  g_object_notify (G_OBJECT (action), "sensitive");

701 702 703 704 705 706 707 708 709 710
}

/**
 * gtk_action_group_set_sensitive:
 * @action_group: the action group
 * @sensitive: new sensitivity
 *
 * Changes the sensitivity of @action_group
 * 
 * Since: 2.4
711 712
 *
 * Deprecated: 3.10
713 714
 */
void
715 716
gtk_action_group_set_sensitive (GtkActionGroup *action_group, 
				gboolean        sensitive)
717
{
Tim Janik's avatar
Tim Janik committed
718 719
  GtkActionGroupPrivate *private;

720 721
  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));

722
  private = action_group->priv;
723 724
  sensitive = sensitive != FALSE;

Tim Janik's avatar
Tim Janik committed
725
  if (private->sensitive != sensitive)
726
    {
Tim Janik's avatar
Tim Janik committed
727 728
      private->sensitive = sensitive;
      g_hash_table_foreach (private->actions, 
729
			    (GHFunc) cb_set_action_sensitivity, NULL);
730 731

      g_object_notify (G_OBJECT (action_group), "sensitive");
732 733 734 735 736 737 738 739 740 741 742 743
    }
}

/**
 * gtk_action_group_get_visible:
 * @action_group: the action group
 *
 * Returns %TRUE if the group is visible.  The constituent actions
 * can only be logically visible (see gtk_action_is_visible()) if
 * they are visible (see gtk_action_get_visible()) and their group
 * is visible.
 * 
744
 * Returns: %TRUE if the group is visible.
745 746
 * 
 * Since: 2.4
747 748
 *
 * Deprecated: 3.10
749 750 751 752
 */
gboolean
gtk_action_group_get_visible (GtkActionGroup *action_group)
{
Tim Janik's avatar
Tim Janik committed
753 754
  GtkActionGroupPrivate *private;

755 756
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), FALSE);

757
  private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
758 759

  return private->visible;
760 761
}

762 763 764 765 766 767 768 769 770 771
/**
 * gtk_action_group_get_accel_group:
 * @action_group: a #GtkActionGroup
 *
 * Gets the accelerator group.
 * 
 * Returns: (transfer none): the accelerator group associated with this action
 * group or %NULL if there is none.
 *
 * Since: 3.6
772 773
 *
 * Deprecated: 3.10
774 775 776 777 778 779 780 781 782
 */
GtkAccelGroup *
gtk_action_group_get_accel_group (GtkActionGroup *action_group)
{
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), FALSE);

  return action_group->priv->accel_group;
}

783
static void
784 785
cb_set_action_visiblity (const gchar *name, 
			 GtkAction   *action)
786
{
787 788
  /* Minor optimization, the action_groups state only affects actions 
   * that are themselves visible */
789
  g_object_notify (G_OBJECT (action), "visible");
790 791 792 793 794 795 796 797 798 799
}

/**
 * gtk_action_group_set_visible:
 * @action_group: the action group
 * @visible: new visiblity
 *
 * Changes the visible of @action_group.
 * 
 * Since: 2.4
800 801
 *
 * Deprecated: 3.10
802 803
 */
void
804 805
gtk_action_group_set_visible (GtkActionGroup *action_group, 
			      gboolean        visible)
806
{
Tim Janik's avatar
Tim Janik committed
807 808
  GtkActionGroupPrivate *private;

809 810
  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));

811
  private = action_group->priv;
812 813
  visible = visible != FALSE;

Tim Janik's avatar
Tim Janik committed
814
  if (private->visible != visible)
815
    {
Tim Janik's avatar
Tim Janik committed
816 817
      private->visible = visible;
      g_hash_table_foreach (private->actions, 
818
			    (GHFunc) cb_set_action_visiblity, NULL);
819 820

      g_object_notify (G_OBJECT (action_group), "visible");
821 822 823
    }
}

824 825 826 827 828 829 830 831 832 833 834 835 836 837
static void 
gtk_action_group_accel_group_foreach (gpointer key, gpointer val, gpointer data)
{
  gtk_action_set_accel_group (val, data);
}

/**
 * gtk_action_group_set_accel_group:
 * @action_group: a #GtkActionGroup
 * @accel_group: (allow-none): a #GtkAccelGroup to set or %NULL
 *
 * Sets the accelerator group to be used by every action in this group.
 * 
 * Since: 3.6
838 839
 *
 * Deprecated: 3.10
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
 */
void
gtk_action_group_set_accel_group (GtkActionGroup *action_group,
                                  GtkAccelGroup  *accel_group)
{
  GtkActionGroupPrivate *private;

  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));

  private = action_group->priv;

  if (private->accel_group == accel_group)
    return;

  g_clear_object (&private->accel_group);

  if (accel_group)
    private->accel_group = g_object_ref (accel_group);

  /* Set the new accel group on every action */
  g_hash_table_foreach (private->actions,
                        gtk_action_group_accel_group_foreach,
                        accel_group);

  g_object_notify (G_OBJECT (action_group), "accel-group");
}

867 868 869 870 871 872 873
/**
 * gtk_action_group_get_action:
 * @action_group: the action group
 * @action_name: the name of the action
 *
 * Looks up an action in the action group by name.
 *
874
 * Returns: (transfer none): the action, or %NULL if no action by that name exists
875 876
 *
 * Since: 2.4
877 878
 *
 * Deprecated: 3.10
879 880 881 882 883 884 885 886
 */
GtkAction *
gtk_action_group_get_action (GtkActionGroup *action_group,
			     const gchar    *action_name)
{
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
  g_return_val_if_fail (GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action != NULL, NULL);

887 888
  return GTK_ACTION_GROUP_GET_CLASS (action_group)->get_action (action_group,
                                                                action_name);
889 890
}

891 892 893 894 895 896
static gboolean
check_unique_action (GtkActionGroup *action_group,
	             const gchar    *action_name)
{
  if (gtk_action_group_get_action (action_group, action_name) != NULL)
    {
Tim Janik's avatar
Tim Janik committed
897 898
      GtkActionGroupPrivate *private;

899
      private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
900

901 902
      g_warning ("Refusing to add non-unique action '%s' to action group '%s'",
	 	 action_name,
Tim Janik's avatar
Tim Janik committed
903
		 private->name);
904 905 906 907 908 909
      return FALSE;
    }

  return TRUE;
}

910 911 912 913 914
/**
 * gtk_action_group_add_action:
 * @action_group: the action group
 * @action: an action
 *
915 916 917 918 919
 * Adds an action object to the action group. Note that this function
 * does not set up the accel path of the action, which can lead to problems
 * if a user tries to modify the accelerator of a menuitem associated with
 * the action. Therefore you must either set the accel path yourself with
 * gtk_action_set_accel_path(), or use 
920
 * `gtk_action_group_add_action_with_accel (..., NULL)`.
921 922
 *
 * Since: 2.4
923 924
 *
 * Deprecated: 3.10
925 926 927 928 929
 */
void
gtk_action_group_add_action (GtkActionGroup *action_group,
			     GtkAction      *action)
{
Tim Janik's avatar
Tim Janik committed
930
  GtkActionGroupPrivate *private;
931 932
  const gchar *name;

933 934
  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
  g_return_if_fail (GTK_IS_ACTION (action));
935 936 937

  name = gtk_action_get_name (action);
  g_return_if_fail (name != NULL);
938
  
939
  if (!check_unique_action (action_group, name))
940
    return;
941

942
  private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
943 944

  g_hash_table_insert (private->actions, 
945
		       (gpointer) name,
946
                       g_object_ref (action));
947
  g_object_set (action, I_("action-group"), action_group, NULL);
948 949 950
  
  if (private->accel_group)
    gtk_action_set_accel_group (action, private->accel_group);
951 952
}

953 954
/**
 * gtk_action_group_add_action_with_accel:
955 956 957 958 959
 * @action_group: the action group
 * @action: the action to add
 * @accelerator: (allow-none): the accelerator for the action, in
 *   the format understood by gtk_accelerator_parse(), or "" for no accelerator, or
 *   %NULL to use the stock accelerator
960 961 962
 *
 * Adds an action object to the action group and sets up the accelerator.
 *
963
 * If @accelerator is %NULL, attempts to use the accelerator associated 
Matthias Clasen's avatar
Matthias Clasen committed
964
 * with the stock_id of the action. 
965
 *
966
 * Accel paths are set to `<Actions>/group-name/action-name`.
967
 *
968
 * Since: 2.4
969 970
 *
 * Deprecated: 3.10
971 972 973
 */
void
gtk_action_group_add_action_with_accel (GtkActionGroup *action_group,
974 975
					GtkAction      *action,
					const gchar    *accelerator)
976
{
Tim Janik's avatar
Tim Janik committed
977
  GtkActionGroupPrivate *private;
978 979 980
  gchar *accel_path;
  guint  accel_key = 0;
  GdkModifierType accel_mods;
981
  const gchar *name;
982

983 984
  name = gtk_action_get_name (action);
  if (!check_unique_action (action_group, name))
985
    return;
986

987
  private = action_group->priv;
988
  accel_path = g_strconcat ("<Actions>/",
Tim Janik's avatar
Tim Janik committed
989
			    private->name, "/", name, NULL);
990 991

  if (accelerator)
992
    {
Matthias Clasen's avatar
Matthias Clasen committed
993 994 995 996 997 998 999 1000 1001
      if (accelerator[0] == 0) 
	accel_key = 0;
      else
	{
	  gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
	  if (accel_key == 0)
	    g_warning ("Unable to parse accelerator '%s' for action '%s'",
		       accelerator, name);
	}
1002
    }
1003
  else 
1004
    {
1005 1006 1007 1008 1009
      gchar *stock_id;
      GtkStockItem stock_item;

      g_object_get (action, "stock-id", &stock_id, NULL);

1010 1011
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

1012 1013 1014 1015 1016 1017
      if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
        {
          accel_key = stock_item.keyval;
          accel_mods = stock_item.modifier;
	}

1018 1019
      G_GNUC_END_IGNORE_DEPRECATIONS;

1020
      g_free (stock_id);
1021 1022 1023
    }

  if (accel_key)
Matthias Clasen's avatar
Matthias Clasen committed
1024
    gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
1025 1026 1027

  gtk_action_set_accel_path (action, accel_path);
  gtk_action_group_add_action (action_group, action);
1028 1029

  g_free (accel_path);
1030 1031
}

1032
/**
Matthias Clasen's avatar
Matthias Clasen committed
1033
 * gtk_action_group_remove_action:
1034 1035 1036 1037 1038 1039
 * @action_group: the action group
 * @action: an action
 *
 * Removes an action object from the action group.
 *
 * Since: 2.4
1040 1041
 *
 * Deprecated: 3.10
1042 1043 1044 1045 1046
 */
void
gtk_action_group_remove_action (GtkActionGroup *action_group,
				GtkAction      *action)
{
Tim Janik's avatar
Tim Janik committed
1047
  GtkActionGroupPrivate *private;
1048 1049
  const gchar *name;

1050 1051 1052
  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
  g_return_if_fail (GTK_IS_ACTION (action));

1053 1054 1055
  name = gtk_action_get_name (action);
  g_return_if_fail (name != NULL);

1056
  private = action_group->priv;
Tim Janik's avatar
Tim Janik committed
1057 1058

  g_hash_table_remove (private->actions, name);
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
}

static void
add_single_action (gpointer key, 
		   gpointer value, 
		   gpointer user_data)
{
  GList **list = user_data;

  *list = g_list_prepend (*list, value);
}

/**
 * gtk_action_group_list_actions:
 * @action_group: the action group
 *
 * Lists the actions in the action group.
 *
1077 1078
 * Returns: (element-type GtkAction) (transfer container): an allocated list of the action objects in the action group
 *
1079
 * Since: 2.4
1080 1081
 *
 * Deprecated: 3.10
1082 1083 1084 1085
 */
GList *
gtk_action_group_list_actions (GtkActionGroup *action_group)
{
Tim Janik's avatar
Tim Janik committed
1086
  GtkActionGroupPrivate *private;
1087
  GList *actions = NULL;
Tim Janik's avatar
Tim Janik committed
1088

1089
  g_return_val_if_fail (GTK_IS_ACTION_GROUP (action_group), NULL);
Tim Janik's avatar
Tim Janik committed
1090

1091
  private = action_group->priv;
1092
  
Tim Janik's avatar
Tim Janik committed
1093
  g_hash_table_foreach (private->actions, add_single_action, &actions);
1094 1095 1096 1097 1098 1099

  return g_list_reverse (actions);
}


/**
1100
 * gtk_action_group_add_actions: (skip)
1101
 * @action_group: the action group
1102
 * @entries: (array length=n_entries): an array of action descriptions
1103
 * @n_entries: the number of entries
1104
 * @user_data: data to pass to the action callbacks
1105
 *
1106 1107
 * This is a convenience function to create a number of actions and add them 
 * to the action group.
Matthias Clasen's avatar
Matthias Clasen committed
1108
 *
1109 1110
 * The “activate” signals of the actions are connected to the callbacks
 * and their accel paths are set to `<Actions>/group-name/action-name`.  
1111 1112
 * 
 * Since: 2.4
1113 1114
 *
 * Deprecated: 3.10
1115 1116
 */
void
1117 1118 1119 1120
gtk_action_group_add_actions (GtkActionGroup       *action_group,
			      const GtkActionEntry *entries,
			      guint                 n_entries,
			      gpointer              user_data)
1121 1122 1123 1124 1125 1126
{
  gtk_action_group_add_actions_full (action_group, 
				     entries, n_entries, 
				     user_data, NULL);
}

1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
typedef struct _SharedData  SharedData;

struct _SharedData {
  guint          ref_count;
  gpointer       data;
  GDestroyNotify destroy;
};

static void
shared_data_unref (gpointer data)
{
  SharedData *shared_data = (SharedData *)data;

  shared_data->ref_count--;
  if (shared_data->ref_count == 0)
    {
1143 1144 1145
      if (shared_data->destroy)
	shared_data->destroy (shared_data->data);

1146
      g_slice_free (SharedData, shared_data);
1147 1148 1149
    }
}

1150 1151

/**
1152
 * gtk_action_group_add_actions_full: (skip)
1153
 * @action_group: the action group
1154
 * @entries: (array length=n_entries): an array of action descriptions
1155 1156
 * @n_entries: the number of entries
 * @user_data: data to pass to the action callbacks
1157
 * @destroy: (nullable): destroy notification callback for @user_data
1158 1159 1160 1161 1162
 *
 * This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
 * callback for @user_data. 
 * 
 * Since: 2.4
1163 1164
 *
 * Deprecated: 3.10
1165 1166
 */
void
1167 1168 1169 1170 1171
gtk_action_group_add_actions_full (GtkActionGroup       *action_group,
				   const GtkActionEntry *entries,
				   guint                 n_entries,
				   gpointer              user_data,
				   GDestroyNotify        destroy)
1172
{
1173 1174 1175 1176

  /* Keep this in sync with the other 
   * gtk_action_group_add_..._actions_full() functions.
   */
1177
  guint i;
1178
  SharedData *shared_data;
1179

1180
  g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
1181

1182
  shared_data = g_slice_new0 (SharedData);
1183 1184 1185 1186
  shared_data->ref_count = 1;
  shared_data->data = user_data;
  shared_data->destroy = destroy;

1187 1188 1189
  for (i = 0; i < n_entries; i++)
    {
      GtkAction *action;
1190 1191
      const gchar *label;
      const gchar *tooltip;
1192

1193 1194 1195
      if (!check_unique_action (action_group, entries[i].name))
        continue;

1196 1197
      label = gtk_action_group_translate_string (action_group, entries[i].label);
      tooltip = gtk_action_group_translate_string (action_group, entries[i].tooltip);
1198

1199 1200 1201
      action = gtk_action_new (entries[i].name,
			       label,
			       tooltip,
1202
			       NULL);
1203

1204 1205
      if (entries[i].stock_id) 
	{
1206 1207 1208
	  g_object_set (action, "stock-id", entries[i].stock_id, NULL);
	  if (gtk_icon_theme_has_icon (gtk_icon_theme_get_default (), 
				       entries[i].stock_id))
1209 1210 1211
	    g_object_set (action, "icon-name", entries[i].stock_id, NULL);
	}
	  
1212
      if (entries[i].callback)
1213 1214 1215 1216 1217 1218 1219
	{
	  GClosure *closure;

	  closure = g_cclosure_new (entries[i].callback, user_data, NULL);
	  g_closure_add_finalize_notifier (closure, shared_data, 
					   (GClosureNotify)shared_data_unref);
	  shared_data->ref_count++;
1220

1221 1222 1223
	  g_signal_connect_closure (action, "activate", closure, FALSE);
	}
	  
1224 1225 1226
      gtk_action_group_add_action_with_accel (action_group, 
					      action,
					      entries[i].accelerator);
1227 1228
      g_object_unref (action);
    }
1229 1230

  shared_data_unref (shared_data);
1231 1232 1233
}

/**
1234
 * gtk_action_group_add_toggle_actions: (skip)
1235
 * @action_group: the action group
1236
 * @entries: (array length=n_entries): an array of toggle action descriptions
1237 1238 1239 1240 1241 1242
 * @n_entries: the number of entries
 * @user_data: data to pass to the action callbacks
 *
 * This is a convenience function to create a number of toggle actions and add them 
 * to the action group.
 *
1243 1244
 * The “activate” signals of the actions are connected to the callbacks
 * and their accel paths are set to `<Actions>/group-name/action-name`.  
1245 1246
 * 
 * Since: 2.4
1247 1248
 *
 * Deprecated: 3.10
1249 1250
 */
void
1251 1252 1253 1254
gtk_action_group_add_toggle_actions (GtkActionGroup             *action_group,
				     const GtkToggleActionEntry *entries,
				     guint                       n_entries,
				     gpointer                    user_data)
1255 1256 1257 1258 1259 1260 1261 1262
{
  gtk_action_group_add_toggle_actions_full (action_group, 
					    entries, n_entries, 
					    user_data, NULL);
}


/**
1263
 * gtk_action_group_add_toggle_actions_full: (skip)
1264
 * @action_group: the action group
1265
 * @entries: (array length=n_entries): an array of toggle action descriptions
1266 1267
 * @n_entries: the number of entries
 * @user_data: data to pass to the action callbacks
1268
 * @destroy: (nullable): destroy notification callback for @user_data