gtkaction.c 48.2 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 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * 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
 * License along with the Gnome Library; see the file COPYING.LIB.  If not,
 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * 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/. 
 */

31 32 33 34
/**
 * SECTION:gtkaction
 * @Short_description: An action which can be triggered by a menu or toolbar item
 * @Title: GtkAction
35
 * @See_also: #GtkActionGroup, #GtkUIManager, #GtkActivatable
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 *
 * Actions represent operations that the user can be perform, along with
 * some information how it should be presented in the interface. Each action
 * provides methods to create icons, menu items and toolbar items
 * representing itself.
 *
 * As well as the callback that is called when the action gets activated,
 * the following also gets associated with the action:
 * <itemizedlist>
 *   <listitem><para>a name (not translated, for path lookup)</para></listitem>
 *   <listitem><para>a label (translated, for display)</para></listitem>
 *   <listitem><para>an accelerator</para></listitem>
 *   <listitem><para>whether label indicates a stock id</para></listitem>
 *   <listitem><para>a tooltip (optional, translated)</para></listitem>
 *   <listitem><para>a toolbar label (optional, shorter than label)</para></listitem>
 * </itemizedlist>
 * The action will also have some state information:
 * <itemizedlist>
 *   <listitem><para>visible (shown/hidden)</para></listitem>
 *   <listitem><para>sensitive (enabled/disabled)</para></listitem>
 * </itemizedlist>
 * Apart from regular actions, there are <link linkend="GtkToggleAction">toggle
 * actions</link>, which can be toggled between two states and <link
 * linkend="GtkRadioAction">radio actions</link>, of which only one in a group
 * can be in the "active" state. Other actions can be implemented as #GtkAction
 * subclasses.
 *
63 64 65 66 67 68 69 70 71 72
 * Each action can have one or more proxy widgets. To act as an action proxy,
 * widget needs to implement #GtkActivatable interface. Proxies mirror the state
 * of the action and should change when the action's state changes. Properties
 * that are always mirrored by proxies are #GtkAction:sensitive and
 * #GtkAction:visible. #GtkAction:gicon, #GtkAction:icon-name, #GtkAction:label,
 * #GtkAction:short-label and #GtkAction:stock-id properties are only mirorred
 * if proxy widget has #GtkActivatable:use-action-appearance property set to
 * %TRUE.
 *
 * When the proxy is activated, it should activate its action.
73 74
 */

75
#include "config.h"
76 77

#include "gtkaction.h"
78
#include "gtkactiongroup.h"
79
#include "gtkaccellabel.h"
80
#include "gtkbutton.h"
Matthias Clasen's avatar
Matthias Clasen committed
81
#include "gtkiconfactory.h"
82
#include "gtkimage.h"
83
#include "gtkimagemenuitem.h"
84
#include "gtkintl.h"
85
#include "gtklabel.h"
86
#include "gtkmarshalers.h"
87 88
#include "gtkmenuitem.h"
#include "gtkstock.h"
89
#include "gtktearoffmenuitem.h"
90 91
#include "gtktoolbutton.h"
#include "gtktoolbar.h"
92
#include "gtkprivate.h"
93
#include "gtkbuildable.h"
94
#include "gtkactivatable.h"
95 96 97 98 99 100


#define GTK_ACTION_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ACTION, GtkActionPrivate))

struct _GtkActionPrivate 
{
101
  const gchar *name; /* interned */
102 103 104
  gchar *label;
  gchar *short_label;
  gchar *tooltip;
105 106
  gchar *stock_id; /* stock icon */
  gchar *icon_name; /* themed icon */
107
  GIcon *gicon;
108

109 110 111 112
  guint sensitive          : 1;
  guint visible            : 1;
  guint label_set          : 1; /* these two used so we can set label */
  guint short_label_set    : 1; /* based on stock id */
113 114
  guint visible_horizontal : 1;
  guint visible_vertical   : 1;
115 116 117
  guint is_important       : 1;
  guint hide_if_empty      : 1;
  guint visible_overflown  : 1;
118
  guint always_show_image  : 1;
119 120
  guint recursion_guard    : 1;
  guint activate_blocked   : 1;
121 122

  /* accelerator */
123 124 125 126
  guint          accel_count;
  GtkAccelGroup *accel_group;
  GClosure      *accel_closure;
  GQuark         accel_quark;
127

128 129
  GtkActionGroup *action_group;

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  /* list of proxy widgets */
  GSList *proxies;
};

enum 
{
  ACTIVATE,
  LAST_SIGNAL
};

enum 
{
  PROP_0,
  PROP_NAME,
  PROP_LABEL,
  PROP_SHORT_LABEL,
  PROP_TOOLTIP,
  PROP_STOCK_ID,
148
  PROP_ICON_NAME,
149
  PROP_GICON,
150 151
  PROP_VISIBLE_HORIZONTAL,
  PROP_VISIBLE_VERTICAL,
152
  PROP_VISIBLE_OVERFLOWN,
153
  PROP_IS_IMPORTANT,
154
  PROP_HIDE_IF_EMPTY,
155
  PROP_SENSITIVE,
156
  PROP_VISIBLE,
157 158
  PROP_ACTION_GROUP,
  PROP_ALWAYS_SHOW_IMAGE
159 160
};

161 162 163 164 165 166 167 168 169 170
/* GtkBuildable */
static void gtk_action_buildable_init             (GtkBuildableIface *iface);
static void gtk_action_buildable_set_name         (GtkBuildable *buildable,
						   const gchar  *name);
static const gchar* gtk_action_buildable_get_name (GtkBuildable *buildable);

G_DEFINE_TYPE_WITH_CODE (GtkAction, gtk_action, G_TYPE_OBJECT,
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
						gtk_action_buildable_init))

171 172 173 174 175 176 177 178 179
static void gtk_action_finalize     (GObject *object);
static void gtk_action_set_property (GObject         *object,
				     guint            prop_id,
				     const GValue    *value,
				     GParamSpec      *pspec);
static void gtk_action_get_property (GObject         *object,
				     guint            prop_id,
				     GValue          *value,
				     GParamSpec      *pspec);
180
static void gtk_action_set_action_group (GtkAction	*action,
181
					 GtkActionGroup *action_group);
182 183 184

static GtkWidget *create_menu_item    (GtkAction *action);
static GtkWidget *create_tool_item    (GtkAction *action);
185 186
static void       connect_proxy       (GtkAction *action,
				       GtkWidget *proxy);
187 188
static void       disconnect_proxy    (GtkAction *action,
				       GtkWidget *proxy);
189
 
190 191 192 193 194 195
static void       closure_accel_activate (GClosure     *closure,
					  GValue       *return_value,
					  guint         n_param_values,
					  const GValue *param_values,
					  gpointer      invocation_hint,
					  gpointer      marshal_data);
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

static guint         action_signals[LAST_SIGNAL] = { 0 };


static void
gtk_action_class_init (GtkActionClass *klass)
{
  GObjectClass *gobject_class;

  gobject_class = G_OBJECT_CLASS (klass);

  gobject_class->finalize     = gtk_action_finalize;
  gobject_class->set_property = gtk_action_set_property;
  gobject_class->get_property = gtk_action_get_property;

  klass->activate = NULL;

213 214 215 216
  klass->create_menu_item  = create_menu_item;
  klass->create_tool_item  = create_tool_item;
  klass->create_menu       = NULL;
  klass->menu_item_type    = GTK_TYPE_IMAGE_MENU_ITEM;
217
  klass->toolbar_item_type = GTK_TYPE_TOOL_BUTTON;
218 219
  klass->connect_proxy    = connect_proxy;
  klass->disconnect_proxy = disconnect_proxy;
220 221 222 223

  g_object_class_install_property (gobject_class,
				   PROP_NAME,
				   g_param_spec_string ("name",
224 225
							P_("Name"),
							P_("A unique name for the action."),
226
							NULL,
227 228
							GTK_PARAM_READWRITE | 
							G_PARAM_CONSTRUCT_ONLY));
229 230 231 232 233 234 235

  /**
   * GtkAction:label:
   *
   * The label used for menu items and buttons that activate
   * this action. If the label is %NULL, GTK+ uses the stock 
   * label specified via the stock-id property.
236 237 238
   *
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
239
   */
240 241 242
  g_object_class_install_property (gobject_class,
				   PROP_LABEL,
				   g_param_spec_string ("label",
243
							P_("Label"),
244 245
							P_("The label used for menu items and buttons "
							   "that activate this action."),
246
							NULL,
247
							GTK_PARAM_READWRITE));
248 249 250 251 252

  /**
   * GtkAction:short-label:
   *
   * A shorter label that may be used on toolbar buttons.
253 254 255
   *
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
256
   */
257 258
  g_object_class_install_property (gobject_class,
				   PROP_SHORT_LABEL,
259
				   g_param_spec_string ("short-label",
260 261
							P_("Short label"),
							P_("A shorter label that may be used on toolbar buttons."),
262
							NULL,
263
							GTK_PARAM_READWRITE));
264 265


266 267 268
  g_object_class_install_property (gobject_class,
				   PROP_TOOLTIP,
				   g_param_spec_string ("tooltip",
269 270
							P_("Tooltip"),
							P_("A tooltip for this action."),
271
							NULL,
272
							GTK_PARAM_READWRITE));
273 274 275 276 277

  /**
   * GtkAction:stock-id:
   *
   * The stock icon displayed in widgets representing this action.
278 279 280
   *
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
281
   */
282 283
  g_object_class_install_property (gobject_class,
				   PROP_STOCK_ID,
284
				   g_param_spec_string ("stock-id",
285
							P_("Stock Icon"),
286 287
							P_("The stock icon displayed in widgets representing "
							   "this action."),
288
							NULL,
289
							GTK_PARAM_READWRITE));
290 291 292 293 294 295 296 297
  /**
   * GtkAction:gicon:
   *
   * The #GIcon displayed in the #GtkAction.
   *
   * Note that the stock icon is preferred, if the #GtkAction:stock-id 
   * property holds the id of an existing stock icon.
   *
298 299 300
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
   *
301 302 303 304 305 306 307 308
   * Since: 2.16
   */
  g_object_class_install_property (gobject_class,
				   PROP_GICON,
				   g_param_spec_object ("gicon",
							P_("GIcon"),
							P_("The GIcon being displayed"),
							G_TYPE_ICON,
309
 							GTK_PARAM_READWRITE));							
310
  /**
311
   * GtkAction:icon-name:
312 313
   *
   * The name of the icon from the icon theme. 
314 315 316 317
   * 
   * Note that the stock icon is preferred, if the #GtkAction:stock-id 
   * property holds the id of an existing stock icon, and the #GIcon is
   * preferred if the #GtkAction:gicon property is set. 
318
   *
319 320 321
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
   *
322 323 324 325 326 327 328 329
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
				   PROP_ICON_NAME,
				   g_param_spec_string ("icon-name",
							P_("Icon Name"),
							P_("The name of the icon from the icon theme"),
							NULL,
330
 							GTK_PARAM_READWRITE));
331

332 333
  g_object_class_install_property (gobject_class,
				   PROP_VISIBLE_HORIZONTAL,
334
				   g_param_spec_boolean ("visible-horizontal",
335
							 P_("Visible when horizontal"),
336 337 338
							 P_("Whether the toolbar item is visible when the toolbar "
							    "is in a horizontal orientation."),
							 TRUE,
339
							 GTK_PARAM_READWRITE));
340 341 342 343 344 345 346 347 348 349
  /**
   * GtkAction:visible-overflown:
   *
   * When %TRUE, toolitem proxies for this action are represented in the 
   * toolbar overflow menu.
   *
   * Since: 2.6
   */
  g_object_class_install_property (gobject_class,
				   PROP_VISIBLE_OVERFLOWN,
350
				   g_param_spec_boolean ("visible-overflown",
351 352 353
							 P_("Visible when overflown"),
							 P_("When TRUE, toolitem proxies for this action "
							    "are represented in the toolbar overflow menu."),
354
							 TRUE,
355
							 GTK_PARAM_READWRITE));
356 357
  g_object_class_install_property (gobject_class,
				   PROP_VISIBLE_VERTICAL,
358
				   g_param_spec_boolean ("visible-vertical",
359
							 P_("Visible when vertical"),
360 361
							 P_("Whether the toolbar item is visible when the toolbar "
							    "is in a vertical orientation."),
362
							 TRUE,
363
							 GTK_PARAM_READWRITE));
364 365
  g_object_class_install_property (gobject_class,
				   PROP_IS_IMPORTANT,
366
				   g_param_spec_boolean ("is-important",
367
							 P_("Is important"),
368 369 370
							 P_("Whether the action is considered important. "
							    "When TRUE, toolitem proxies for this action "
							    "show text in GTK_TOOLBAR_BOTH_HORIZ mode."),
371
							 FALSE,
372
							 GTK_PARAM_READWRITE));
373 374
  g_object_class_install_property (gobject_class,
				   PROP_HIDE_IF_EMPTY,
375
				   g_param_spec_boolean ("hide-if-empty",
376 377
							 P_("Hide if empty"),
							 P_("When TRUE, empty menu proxies for this action are hidden."),
378
							 TRUE,
379
							 GTK_PARAM_READWRITE));
380 381 382
  g_object_class_install_property (gobject_class,
				   PROP_SENSITIVE,
				   g_param_spec_boolean ("sensitive",
383 384
							 P_("Sensitive"),
							 P_("Whether the action is enabled."),
385
							 TRUE,
386
							 GTK_PARAM_READWRITE));
387 388 389
  g_object_class_install_property (gobject_class,
				   PROP_VISIBLE,
				   g_param_spec_boolean ("visible",
390 391
							 P_("Visible"),
							 P_("Whether the action is visible."),
392
							 TRUE,
393
							 GTK_PARAM_READWRITE));
394 395
  g_object_class_install_property (gobject_class,
				   PROP_ACTION_GROUP,
396
				   g_param_spec_object ("action-group",
397 398
							 P_("Action Group"),
							 P_("The GtkActionGroup this GtkAction is associated with, or NULL (for internal use)."),
399
							 GTK_TYPE_ACTION_GROUP,
400
							 GTK_PARAM_READWRITE));
401

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  /**
   * GtkAction:always-show-image:
   *
   * If %TRUE, the action's menu item proxies will ignore the #GtkSettings:gtk-menu-images 
   * setting and always show their image, if available.
   *
   * Use this property if the menu item would be useless or hard to use
   * without their image. 
   *
   * Since: 2.20
   **/
  g_object_class_install_property (gobject_class,
                                   PROP_ALWAYS_SHOW_IMAGE,
                                   g_param_spec_boolean ("always-show-image",
                                                         P_("Always show image"),
                                                         P_("Whether the image will always be shown"),
                                                         FALSE,
                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));

Matthias Clasen's avatar
Matthias Clasen committed
421 422 423 424 425 426 427 428
  /**
   * GtkAction::activate:
   * @action: the #GtkAction
   *
   * The "activate" signal is emitted when the action is activated.
   *
   * Since: 2.4
   */
429
  action_signals[ACTIVATE] =
430
    g_signal_new (I_("activate"),
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
		  G_OBJECT_CLASS_TYPE (klass),
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
		  G_STRUCT_OFFSET (GtkActionClass, activate),  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);

  g_type_class_add_private (gobject_class, sizeof (GtkActionPrivate));
}


static void
gtk_action_init (GtkAction *action)
{
  action->private_data = GTK_ACTION_GET_PRIVATE (action);

  action->private_data->name = NULL;
  action->private_data->label = NULL;
  action->private_data->short_label = NULL;
  action->private_data->tooltip = NULL;
  action->private_data->stock_id = NULL;
451
  action->private_data->icon_name = NULL;
452 453
  action->private_data->visible_horizontal = TRUE;
  action->private_data->visible_vertical   = TRUE;
454
  action->private_data->visible_overflown  = TRUE;
455
  action->private_data->is_important = FALSE;
456
  action->private_data->hide_if_empty = TRUE;
457
  action->private_data->always_show_image = FALSE;
458
  action->private_data->activate_blocked = FALSE;
459 460 461 462 463 464 465

  action->private_data->sensitive = TRUE;
  action->private_data->visible = TRUE;

  action->private_data->label_set = FALSE;
  action->private_data->short_label_set = FALSE;

466
  action->private_data->accel_count = 0;
467 468
  action->private_data->accel_group = NULL;
  action->private_data->accel_quark = 0;
469 470 471 472 473 474 475
  action->private_data->accel_closure = 
    g_closure_new_object (sizeof (GClosure), G_OBJECT (action));
  g_closure_set_marshal (action->private_data->accel_closure, 
			 closure_accel_activate);
  g_closure_ref (action->private_data->accel_closure);
  g_closure_sink (action->private_data->accel_closure);

476 477
  action->private_data->action_group = NULL;

478
  action->private_data->proxies = NULL;
479
  action->private_data->gicon = NULL;  
480 481
}

482 483 484 485 486 487 488 489 490 491 492 493 494
static void
gtk_action_buildable_init (GtkBuildableIface *iface)
{
  iface->set_name = gtk_action_buildable_set_name;
  iface->get_name = gtk_action_buildable_get_name;
}

static void
gtk_action_buildable_set_name (GtkBuildable *buildable,
			       const gchar  *name)
{
  GtkAction *action = GTK_ACTION (buildable);

495
  action->private_data->name = g_intern_string (name);
496 497 498 499 500 501 502 503 504 505
}

static const gchar *
gtk_action_buildable_get_name (GtkBuildable *buildable)
{
  GtkAction *action = GTK_ACTION (buildable);

  return action->private_data->name;
}

506 507 508
/**
 * gtk_action_new:
 * @name: A unique name for the action
509 510
 * @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
 * @tooltip: (allow-none): a tooltip for the action, or %NULL
511 512
 * @stock_id: the stock icon to display in widgets representing the
 *   action, or %NULL
513 514 515 516
 *
 * Creates a new #GtkAction object. To add the action to a
 * #GtkActionGroup and set the accelerator for the action,
 * call gtk_action_group_add_action_with_accel().
Matthias Clasen's avatar
Matthias Clasen committed
517
 * See <xref linkend="XML-UI"/> for information on allowed action
518
 * names.
519 520 521 522 523 524 525 526 527 528 529
 *
 * Return value: a new #GtkAction
 *
 * Since: 2.4
 */
GtkAction *
gtk_action_new (const gchar *name,
		const gchar *label,
		const gchar *tooltip,
		const gchar *stock_id)
{
530 531 532 533 534 535 536 537
  g_return_val_if_fail (name != NULL, NULL);

  return g_object_new (GTK_TYPE_ACTION,
                       "name", name,
		       "label", label,
		       "tooltip", tooltip,
		       "stock-id", stock_id,
		       NULL);
538 539
}

540 541 542 543 544 545 546 547 548 549
static void
gtk_action_finalize (GObject *object)
{
  GtkAction *action;
  action = GTK_ACTION (object);

  g_free (action->private_data->label);
  g_free (action->private_data->short_label);
  g_free (action->private_data->tooltip);
  g_free (action->private_data->stock_id);
550
  g_free (action->private_data->icon_name);
551 552 553
  
  if (action->private_data->gicon)
    g_object_unref (action->private_data->gicon);
554

555
  g_closure_unref (action->private_data->accel_closure);
556 557
  if (action->private_data->accel_group)
    g_object_unref (action->private_data->accel_group);
558

Matthias Clasen's avatar
Matthias Clasen committed
559
  G_OBJECT_CLASS (gtk_action_parent_class)->finalize (object);  
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
}

static void
gtk_action_set_property (GObject         *object,
			 guint            prop_id,
			 const GValue    *value,
			 GParamSpec      *pspec)
{
  GtkAction *action;
  
  action = GTK_ACTION (object);

  switch (prop_id)
    {
    case PROP_NAME:
575
      action->private_data->name = g_intern_string (g_value_get_string (value));
576 577
      break;
    case PROP_LABEL:
578
      gtk_action_set_label (action, g_value_get_string (value));
579 580
      break;
    case PROP_SHORT_LABEL:
581
      gtk_action_set_short_label (action, g_value_get_string (value));
582 583
      break;
    case PROP_TOOLTIP:
584
      gtk_action_set_tooltip (action, g_value_get_string (value));
585 586
      break;
    case PROP_STOCK_ID:
587
      gtk_action_set_stock_id (action, g_value_get_string (value));
588
      break;
589 590 591
    case PROP_GICON:
      gtk_action_set_gicon (action, g_value_get_object (value));
      break;
592 593 594
    case PROP_ICON_NAME:
      gtk_action_set_icon_name (action, g_value_get_string (value));
      break;
595
    case PROP_VISIBLE_HORIZONTAL:
596
      gtk_action_set_visible_horizontal (action, g_value_get_boolean (value));
597 598
      break;
    case PROP_VISIBLE_VERTICAL:
599
      gtk_action_set_visible_vertical (action, g_value_get_boolean (value));
600
      break;
601 602 603
    case PROP_VISIBLE_OVERFLOWN:
      action->private_data->visible_overflown = g_value_get_boolean (value);
      break;
604
    case PROP_IS_IMPORTANT:
605
      gtk_action_set_is_important (action, g_value_get_boolean (value));
606
      break;
607 608 609
    case PROP_HIDE_IF_EMPTY:
      action->private_data->hide_if_empty = g_value_get_boolean (value);
      break;
610
    case PROP_SENSITIVE:
611
      gtk_action_set_sensitive (action, g_value_get_boolean (value));
612 613
      break;
    case PROP_VISIBLE:
614
      gtk_action_set_visible (action, g_value_get_boolean (value));
615
      break;
616 617 618
    case PROP_ACTION_GROUP:
      gtk_action_set_action_group (action, g_value_get_object (value));
      break;
619 620 621
    case PROP_ALWAYS_SHOW_IMAGE:
      gtk_action_set_always_show_image (action, g_value_get_boolean (value));
      break;
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_action_get_property (GObject    *object,
			 guint       prop_id,
			 GValue     *value,
			 GParamSpec *pspec)
{
  GtkAction *action;

  action = GTK_ACTION (object);

  switch (prop_id)
    {
    case PROP_NAME:
641
      g_value_set_static_string (value, action->private_data->name);
642 643 644 645 646 647 648 649 650 651 652 653 654
      break;
    case PROP_LABEL:
      g_value_set_string (value, action->private_data->label);
      break;
    case PROP_SHORT_LABEL:
      g_value_set_string (value, action->private_data->short_label);
      break;
    case PROP_TOOLTIP:
      g_value_set_string (value, action->private_data->tooltip);
      break;
    case PROP_STOCK_ID:
      g_value_set_string (value, action->private_data->stock_id);
      break;
655 656 657
    case PROP_ICON_NAME:
      g_value_set_string (value, action->private_data->icon_name);
      break;
658 659 660
    case PROP_GICON:
      g_value_set_object (value, action->private_data->gicon);
      break;
661 662 663 664 665 666
    case PROP_VISIBLE_HORIZONTAL:
      g_value_set_boolean (value, action->private_data->visible_horizontal);
      break;
    case PROP_VISIBLE_VERTICAL:
      g_value_set_boolean (value, action->private_data->visible_vertical);
      break;
667 668 669
    case PROP_VISIBLE_OVERFLOWN:
      g_value_set_boolean (value, action->private_data->visible_overflown);
      break;
670 671 672
    case PROP_IS_IMPORTANT:
      g_value_set_boolean (value, action->private_data->is_important);
      break;
673 674 675
    case PROP_HIDE_IF_EMPTY:
      g_value_set_boolean (value, action->private_data->hide_if_empty);
      break;
676 677 678 679 680 681
    case PROP_SENSITIVE:
      g_value_set_boolean (value, action->private_data->sensitive);
      break;
    case PROP_VISIBLE:
      g_value_set_boolean (value, action->private_data->visible);
      break;
682 683 684
    case PROP_ACTION_GROUP:
      g_value_set_object (value, action->private_data->action_group);
      break;
685 686 687
    case PROP_ALWAYS_SHOW_IMAGE:
      g_value_set_boolean (value, action->private_data->always_show_image);
      break;
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static GtkWidget *
create_menu_item (GtkAction *action)
{
  GType menu_item_type;

  menu_item_type = GTK_ACTION_GET_CLASS (action)->menu_item_type;

  return g_object_new (menu_item_type, NULL);
}

static GtkWidget *
create_tool_item (GtkAction *action)
{
  GType toolbar_item_type;

  toolbar_item_type = GTK_ACTION_GET_CLASS (action)->toolbar_item_type;

  return g_object_new (toolbar_item_type, NULL);
}

static void
715 716
remove_proxy (GtkAction *action,
	      GtkWidget *proxy)
717
{
718
  action->private_data->proxies = g_slist_remove (action->private_data->proxies, proxy);
719 720
}

721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
static void
connect_proxy (GtkAction *action,
	       GtkWidget *proxy)
{
  action->private_data->proxies = g_slist_prepend (action->private_data->proxies, proxy);

  if (action->private_data->action_group)
    _gtk_action_group_emit_connect_proxy (action->private_data->action_group, action, proxy);

}

static void
disconnect_proxy (GtkAction *action,
		  GtkWidget *proxy)
{
  remove_proxy (action, proxy);

  if (action->private_data->action_group)
    _gtk_action_group_emit_disconnect_proxy (action->private_data->action_group, action, proxy);
}

742 743
/**
 * _gtk_action_sync_menu_visible:
744
 * @action: (allow-none): a #GtkAction, or %NULL to determine the action from @proxy
745 746 747 748 749 750 751 752
 * @proxy: a proxy menu item
 * @empty: whether the submenu attached to @proxy is empty
 * 
 * Updates the visibility of @proxy from the visibility of @action
 * according to the following rules:
 * <itemizedlist>
 * <listitem><para>if @action is invisible, @proxy is too
 * </para></listitem>
753 754
 * <listitem><para>if @empty is %TRUE, hide @proxy unless the "hide-if-empty" 
 *   property of @action indicates otherwise
755 756 757 758 759 760 761 762 763 764
 * </para></listitem>
 * </itemizedlist>
 * 
 * This function is used in the implementation of #GtkUIManager.
 **/
void
_gtk_action_sync_menu_visible (GtkAction *action,
			       GtkWidget *proxy,
			       gboolean   empty)
{
765 766
  gboolean visible = TRUE;
  gboolean hide_if_empty = TRUE;
767 768 769

  g_return_if_fail (GTK_IS_MENU_ITEM (proxy));
  g_return_if_fail (action == NULL || GTK_IS_ACTION (action));
770

771
  if (action == NULL)
772
    action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (proxy));
773

774 775 776 777 778 779
  if (action)
    {
      /* a GtkMenu for a <popup/> doesn't have to have an action */
      visible = gtk_action_is_visible (action);
      hide_if_empty = action->private_data->hide_if_empty;
    }
780

781 782 783 784
  if (visible && !(empty && hide_if_empty))
    gtk_widget_show (proxy);
  else
    gtk_widget_hide (proxy);
785 786
}

787 788 789
void
_gtk_action_emit_activate (GtkAction *action)
{
790 791
  GtkActionGroup *group = action->private_data->action_group;

Matthias Clasen's avatar
Matthias Clasen committed
792 793 794 795 796
  if (group != NULL) 
    {
      g_object_ref (group);
      _gtk_action_group_emit_pre_activate (group, action);
    }
797

798
    g_signal_emit (action, action_signals[ACTIVATE], 0);
799

Matthias Clasen's avatar
Matthias Clasen committed
800 801 802 803 804
  if (group != NULL) 
    {
      _gtk_action_group_emit_post_activate (group, action);
      g_object_unref (group);
    }
805 806
}

807 808 809 810
/**
 * gtk_action_activate:
 * @action: the action object
 *
811 812 813
 * Emits the "activate" signal on the specified action, if it isn't 
 * insensitive. This gets called by the proxy widgets when they get 
 * activated.
814 815 816 817 818 819 820 821
 *
 * It can also be used to manually activate an action.
 *
 * Since: 2.4
 */
void
gtk_action_activate (GtkAction *action)
{
822 823
  g_return_if_fail (GTK_IS_ACTION (action));
  
824 825 826 827
  if (action->private_data->activate_blocked)
    return;

  if (gtk_action_is_sensitive (action))
828
    _gtk_action_emit_activate (action);
829 830
}

831 832
/**
 * gtk_action_block_activate:
Matthias Clasen's avatar
Matthias Clasen committed
833
 * @action: a #GtkAction
834 835 836 837 838 839 840
 *
 * Disable activation signals from the action 
 *
 * This is needed when updating the state of your proxy
 * #GtkActivatable widget could result in calling gtk_action_activate(),
 * this is a convenience function to avoid recursing in those
 * cases (updating toggle state for instance).
Matthias Clasen's avatar
Matthias Clasen committed
841 842
 *
 * Since: 2.16
843 844 845 846 847 848 849 850 851 852 853
 */
void
gtk_action_block_activate (GtkAction *action)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  action->private_data->activate_blocked = TRUE;
}

/**
 * gtk_action_unblock_activate:
Matthias Clasen's avatar
Matthias Clasen committed
854
 * @action: a #GtkAction
855 856
 *
 * Reenable activation signals from the action 
Matthias Clasen's avatar
Matthias Clasen committed
857 858
 *
 * Since: 2.16
859 860 861 862 863 864 865 866 867
 */
void
gtk_action_unblock_activate (GtkAction *action)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  action->private_data->activate_blocked = FALSE;
}

868 869 870
/**
 * gtk_action_create_icon:
 * @action: the action object
871
 * @icon_size: (type int): the size of the icon that should be created.
872 873 874 875 876 877 878 879 880 881 882 883 884
 *
 * This function is intended for use by action implementations to
 * create icons displayed in the proxy widgets.
 *
 * Returns: a widget that displays the icon for this action.
 *
 * Since: 2.4
 */
GtkWidget *
gtk_action_create_icon (GtkAction *action, GtkIconSize icon_size)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

885 886
  if (action->private_data->stock_id &&
      gtk_icon_factory_lookup_default (action->private_data->stock_id))
887
    return gtk_image_new_from_stock (action->private_data->stock_id, icon_size);
888 889
  else if (action->private_data->gicon)
    return gtk_image_new_from_gicon (action->private_data->gicon, icon_size);
890 891
  else if (action->private_data->icon_name)
    return gtk_image_new_from_icon_name (action->private_data->icon_name, icon_size);
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
  else
    return NULL;
}

/**
 * gtk_action_create_menu_item:
 * @action: the action object
 *
 * Creates a menu item widget that proxies for the given action.
 *
 * Returns: a menu item connected to the action.
 *
 * Since: 2.4
 */
GtkWidget *
gtk_action_create_menu_item (GtkAction *action)
{
  GtkWidget *menu_item;

  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

913
  menu_item = GTK_ACTION_GET_CLASS (action)->create_menu_item (action);
914

915 916
  gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (menu_item), TRUE);
  gtk_activatable_set_related_action (GTK_ACTIVATABLE (menu_item), action);
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937

  return menu_item;
}

/**
 * gtk_action_create_tool_item:
 * @action: the action object
 *
 * Creates a toolbar item widget that proxies for the given action.
 *
 * Returns: a toolbar item connected to the action.
 *
 * Since: 2.4
 */
GtkWidget *
gtk_action_create_tool_item (GtkAction *action)
{
  GtkWidget *button;

  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

938
  button = GTK_ACTION_GET_CLASS (action)->create_tool_item (action);
939

940 941
  gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (button), TRUE);
  gtk_activatable_set_related_action (GTK_ACTIVATABLE (button), action);
942 943 944 945

  return button;
}

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
void
_gtk_action_add_to_proxy_list (GtkAction     *action,
			       GtkWidget     *proxy)
{
  g_return_if_fail (GTK_IS_ACTION (action));
  g_return_if_fail (GTK_IS_WIDGET (proxy));
 
  GTK_ACTION_GET_CLASS (action)->connect_proxy (action, proxy);
}

void
_gtk_action_remove_from_proxy_list (GtkAction     *action,
				    GtkWidget     *proxy)
{
  g_return_if_fail (GTK_IS_ACTION (action));
  g_return_if_fail (GTK_IS_WIDGET (proxy));

  GTK_ACTION_GET_CLASS (action)->disconnect_proxy (action, proxy);
}

966 967 968 969 970
/**
 * gtk_action_get_proxies:
 * @action: the action object
 * 
 * Returns the proxy widgets for an action.
971
 * See also gtk_activatable_get_related_action().
972 973
 *
 * Return value: (element-type GtkWidget) (transfer none): a #GSList of proxy widgets. The list is owned by GTK+
974
 * and must not be modified.
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
 *
 * Since: 2.4
 **/
GSList*
gtk_action_get_proxies (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->proxies;
}

/**
 * gtk_action_get_name:
 * @action: the action object
 * 
 * Returns the name of the action.
 * 
 * Return value: the name of the action. The string belongs to GTK+ and should not
 *   be freed.
 *
 * Since: 2.4
 **/
997
G_CONST_RETURN gchar *
998 999 1000 1001 1002 1003 1004
gtk_action_get_name (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->name;
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
/**
 * gtk_action_is_sensitive:
 * @action: the action object
 * 
 * Returns whether the action is effectively sensitive.
 *
 * Return value: %TRUE if the action and its associated action group 
 * are both sensitive.
 *
 * Since: 2.4
 **/
gboolean
gtk_action_is_sensitive (GtkAction *action)
{
  GtkActionPrivate *priv;
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  priv = action->private_data;
  return priv->sensitive &&
    (priv->action_group == NULL ||
     gtk_action_group_get_sensitive (priv->action_group));
}

/**
 * gtk_action_get_sensitive:
 * @action: the action object
 * 
 * Returns whether the action itself is sensitive. Note that this doesn't 
 * necessarily mean effective sensitivity. See gtk_action_is_sensitive() 
 * for that.
 *
 * Return value: %TRUE if the action itself is sensitive.
 *
 * Since: 2.4
 **/
gboolean
gtk_action_get_sensitive (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->sensitive;
}

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
/**
 * gtk_action_set_sensitive:
 * @action: the action object
 * @sensitive: %TRUE to make the action sensitive
 * 
 * Sets the ::sensitive property of the action to @sensitive. Note that 
 * this doesn't necessarily mean effective sensitivity. See 
 * gtk_action_is_sensitive() 
 * for that.
 *
 * Since: 2.6
 **/
void
gtk_action_set_sensitive (GtkAction *action,
			  gboolean   sensitive)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  sensitive = sensitive != FALSE;
  
  if (action->private_data->sensitive != sensitive)
    {
      action->private_data->sensitive = sensitive;

      g_object_notify (G_OBJECT (action), "sensitive");
    }
}

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
/**
 * gtk_action_is_visible:
 * @action: the action object
 * 
 * Returns whether the action is effectively visible.
 *
 * Return value: %TRUE if the action and its associated action group 
 * are both visible.
 *
 * Since: 2.4
 **/
gboolean
gtk_action_is_visible (GtkAction *action)
{
  GtkActionPrivate *priv;
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  priv = action->private_data;
  return priv->visible &&
    (priv->action_group == NULL ||
     gtk_action_group_get_visible (priv->action_group));
}

/**
 * gtk_action_get_visible:
 * @action: the action object
 * 
 * Returns whether the action itself is visible. Note that this doesn't 
 * necessarily mean effective visibility. See gtk_action_is_sensitive() 
 * for that.
 *
 * Return value: %TRUE if the action itself is visible.
 *
 * Since: 2.4
 **/
gboolean
gtk_action_get_visible (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->visible;
}

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
/**
 * gtk_action_set_visible:
 * @action: the action object
 * @visible: %TRUE to make the action visible
 * 
 * Sets the ::visible property of the action to @visible. Note that 
 * this doesn't necessarily mean effective visibility. See 
 * gtk_action_is_visible() 
 * for that.
 *
 * Since: 2.6
 **/
void
gtk_action_set_visible (GtkAction *action,
			gboolean   visible)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  visible = visible != FALSE;
  
  if (action->private_data->visible != visible)
    {
      action->private_data->visible = visible;

      g_object_notify (G_OBJECT (action), "visible");
    }
}
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
/**
 * gtk_action_set_is_important:
 * @action: the action object
 * @is_important: %TRUE to make the action important
 *
 * Sets whether the action is important, this attribute is used
 * primarily by toolbar items to decide whether to show a label
 * or not.
 *
 * Since: 2.16
 */
void 
1158 1159 1160
gtk_action_set_is_important (GtkAction *action,
			     gboolean   is_important)
{
1161
  g_return_if_fail (GTK_IS_ACTION (action));
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172

  is_important = is_important != FALSE;
  
  if (action->private_data->is_important != is_important)
    {
      action->private_data->is_important = is_important;
      
      g_object_notify (G_OBJECT (action), "is-important");
    }  
}

1173 1174 1175 1176 1177
/**
 * gtk_action_get_is_important:
 * @action: a #GtkAction
 *
 * Checks whether @action is important or not
1178
 * 
1179 1180 1181 1182
 * Returns: whether @action is important
 *
 * Since: 2.16
 */
1183
gboolean 
1184 1185 1186 1187 1188 1189 1190
gtk_action_get_is_important (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->is_important;
}

1191 1192
/**
 * gtk_action_set_always_show_image:
Matthias Clasen's avatar
Matthias Clasen committed
1193
 * @action: a #GtkAction
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
 * @always_show: %TRUE if menuitem proxies should always show their image
 *
 * Sets whether @action<!-- -->'s menu item proxies will ignore the
 * #GtkSettings:gtk-menu-images setting and always show their image, if available.
 *
 * Use this if the menu item would be useless or hard to use
 * without their image.
 *
 * Since: 2.20
 */
void
gtk_action_set_always_show_image (GtkAction *action,
                                  gboolean   always_show)
{
  GtkActionPrivate *priv;

  g_return_if_fail (GTK_IS_ACTION (action));

  priv = action->private_data;

  always_show = always_show != FALSE;
  
  if (priv->always_show_image != always_show)
    {
      priv->always_show_image = always_show;

      g_object_notify (G_OBJECT (action), "always-show-image");
    }
}

/**
 * gtk_action_get_always_show_image:
Matthias Clasen's avatar
Matthias Clasen committed
1226
 * @action: a #GtkAction
1227 1228
 *
 * Returns whether @action<!-- -->'s menu item proxies will ignore the
Matthias Clasen's avatar
Matthias Clasen committed
1229 1230
 * #GtkSettings:gtk-menu-images setting and always show their image,
 * if available.
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
 *
 * Returns: %TRUE if the menu item proxies will always show their image
 *
 * Since: 2.20
 */
gboolean
gtk_action_get_always_show_image  (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->always_show_image;
}

1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
/**
 * gtk_action_set_label:
 * @action: a #GtkAction
 * @label: the label text to set
 *
 * Sets the label of @action.
 *
 * Since: 2.16
 */
void 
1254 1255 1256 1257 1258
gtk_action_set_label (GtkAction	  *action,
		      const gchar *label)
{
  gchar *tmp;
  
1259 1260
  g_return_if_fail (GTK_IS_ACTION (action));
  
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
  tmp = action->private_data->label;
  action->private_data->label = g_strdup (label);
  g_free (tmp);
  action->private_data->label_set = (action->private_data->label != NULL);
  /* if label is unset, then use the label from the stock item */
  if (!action->private_data->label_set && action->private_data->stock_id)
    {
      GtkStockItem stock_item;
      
      if (gtk_stock_lookup (action->private_data->stock_id, &stock_item))
	action->private_data->label = g_strdup (stock_item.label);
    }
1273

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
  g_object_notify (G_OBJECT (action), "label");
  
  /* if short_label is unset, set short_label=label */
  if (!action->private_data->short_label_set)
    {
      gtk_action_set_short_label (action, action->private_data->label);
      action->private_data->short_label_set = FALSE;
    }
}

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
/**
 * gtk_action_get_label:
 * @action: a #GtkAction
 *
 * Gets the label text of @action.
 *
 * Returns: the label text
 *
 * Since: 2.16
 */
1294
G_CONST_RETURN gchar * 
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
gtk_action_get_label (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->label;
}

/**
 * gtk_action_set_short_label:
 * @action: a #GtkAction
Matthias Clasen's avatar
Matthias Clasen committed
1305
 * @short_label: the label text to set
1306
 *
1307
 * Sets a shorter label text on @action.
1308 1309 1310 1311
 *
 * Since: 2.16
 */
void 
1312
gtk_action_set_short_label (GtkAction   *action,
Matthias Clasen's avatar
Matthias Clasen committed
1313
			    const gchar *short_label)
1314 1315 1316
{
  gchar *tmp;

1317 1318
  g_return_if_fail (GTK_IS_ACTION (action));

1319
  tmp = action->private_data->short_label;
Matthias Clasen's avatar
Matthias Clasen committed
1320
  action->private_data->short_label = g_strdup (short_label);
1321 1322 1323 1324 1325 1326 1327 1328 1329
  g_free (tmp);
  action->private_data->short_label_set = (action->private_data->short_label != NULL);
  /* if short_label is unset, then use the value of label */
  if (!action->private_data->short_label_set)
    action->private_data->short_label = g_strdup (action->private_data->label);

  g_object_notify (G_OBJECT (action), "short-label");
}

1330 1331 1332 1333
/**
 * gtk_action_get_short_label:
 * @action: a #GtkAction
 *
1334 1335 1336
 * Gets the short label text of @action.
 *
 * Returns: the short label text.
1337 1338 1339
 *
 * Since: 2.16
 */
1340
G_CONST_RETURN gchar * 
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
gtk_action_get_short_label (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->short_label;
}

/**
 * gtk_action_set_visible_horizontal:
 * @action: a #GtkAction
 * @visible_horizontal: whether the action is visible horizontally
 *
 * Sets whether @action is visible when horizontal
 *
 * Since: 2.16
 */
void 
1358 1359 1360
gtk_action_set_visible_horizontal (GtkAction *action,
				   gboolean   visible_horizontal)
{
1361
  g_return_if_fail (GTK_IS_ACTION (action));
1362

1363 1364
  g_return_if_fail (GTK_IS_ACTION (action));

1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
  visible_horizontal = visible_horizontal != FALSE;
  
  if (action->private_data->visible_horizontal != visible_horizontal)
    {
      action->private_data->visible_horizontal = visible_horizontal;
      
      g_object_notify (G_OBJECT (action), "visible-horizontal");
    }  
}

1375 1376 1377 1378 1379
/**
 * gtk_action_get_visible_horizontal:
 * @action: a #GtkAction
 *
 * Checks whether @action is visible when horizontal
1380
 * 
1381 1382 1383 1384
 * Returns: whether @action is visible when horizontal
 *
 * Since: 2.16
 */
1385
gboolean 
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
gtk_action_get_visible_horizontal (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->visible_horizontal;
}

/**
 * gtk_action_set_visible_vertical:
 * @action: a #GtkAction
 * @visible_vertical: whether the action is visible vertically
 *
1398
 * Sets whether @action is visible when vertical 
1399 1400 1401 1402
 *
 * Since: 2.16
 */
void 
1403 1404 1405
gtk_action_set_visible_vertical (GtkAction *action,
				 gboolean   visible_vertical)
{
1406
  g_return_if_fail (GTK_IS_ACTION (action));
1407

1408 1409
  g_return_if_fail (GTK_IS_ACTION (action));

1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
  visible_vertical = visible_vertical != FALSE;
  
  if (action->private_data->visible_vertical != visible_vertical)
    {
      action->private_data->visible_vertical = visible_vertical;
      
      g_object_notify (G_OBJECT (action), "visible-vertical");
    }  
}

1420 1421 1422 1423 1424
/**
 * gtk_action_get_visible_vertical:
 * @action: a #GtkAction
 *
 * Checks whether @action is visible when horizontal
1425
 * 
1426 1427 1428 1429
 * Returns: whether @action is visible when horizontal
 *
 * Since: 2.16
 */
1430
gboolean 
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
gtk_action_get_visible_vertical (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);

  return action->private_data->visible_vertical;
}

/**
 * gtk_action_set_tooltip:
 * @action: a #GtkAction
 * @tooltip: the tooltip text
 *
 * Sets the tooltip text on @action
 *
 * Since: 2.16
 */
void 
1448 1449 1450 1451 1452
gtk_action_set_tooltip (GtkAction   *action,
			const gchar *tooltip)
{
  gchar *tmp;

1453 1454
  g_return_if_fail (GTK_IS_ACTION (action));

1455 1456 1457 1458 1459 1460 1461
  tmp = action->private_data->tooltip;
  action->private_data->tooltip = g_strdup (tooltip);
  g_free (tmp);

  g_object_notify (G_OBJECT (action), "tooltip");
}

1462 1463 1464 1465 1466 1467
/**
 * gtk_action_get_tooltip:
 * @action: a #GtkAction
 *
 * Gets the tooltip text of @action.
 *
1468
 * Returns: the tooltip text
1469 1470 1471
 *
 * Since: 2.16
 */
1472
G_CONST_RETURN gchar * 
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
gtk_action_get_tooltip (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->tooltip;
}

/**
 * gtk_action_set_stock_id:
 * @action: a #GtkAction
Matthias Clasen's avatar
Matthias Clasen committed
1483
 * @stock_id: the stock id
1484 1485 1486 1487 1488 1489
 *
 * Sets the stock id on @action
 *
 * Since: 2.16
 */
void 
1490 1491 1492 1493
gtk_action_set_stock_id (GtkAction   *action,
			 const gchar *stock_id)
{
  gchar *tmp;
1494 1495 1496

  g_return_if_fail (GTK_IS_ACTION (action));

1497 1498
  g_return_if_fail (GTK_IS_ACTION (action));

1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
  tmp = action->private_data->stock_id;
  action->private_data->stock_id = g_strdup (stock_id);
  g_free (tmp);

  g_object_notify (G_OBJECT (action), "stock-id");
  
  /* update label and short_label if appropriate */
  if (!action->private_data->label_set)
    {
      GtkStockItem stock_item;
      
1510 1511
      if (action->private_data->stock_id &&
	  gtk_stock_lookup (action->private_data->stock_id, &stock_item))
1512 1513 1514 1515 1516 1517 1518 1519
	gtk_action_set_label (action, stock_item.label);
      else 
	gtk_action_set_label (action, NULL);
      
      action->private_data->label_set = FALSE;
    }
}

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
/**
 * gtk_action_get_stock_id:
 * @action: a #GtkAction
 *
 * Gets the stock id of @action.
 *
 * Returns: the stock id
 *
 * Since: 2.16
 */
1530
G_CONST_RETURN gchar * 
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
gtk_action_get_stock_id (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->stock_id;
}

/**
 * gtk_action_set_icon_name:
 * @action: a #GtkAction
Matthias Clasen's avatar
Matthias Clasen committed
1541
 * @icon_name: the icon name to set
1542 1543 1544 1545 1546 1547
 *
 * Sets the icon name on @action
 *
 * Since: 2.16
 */
void 
1548 1549 1550 1551
gtk_action_set_icon_name (GtkAction   *action,
			  const gchar *icon_name)
{
  gchar *tmp;
1552 1553 1554

  g_return_if_fail (GTK_IS_ACTION (action));

1555 1556 1557 1558 1559 1560 1561
  tmp = action->private_data->icon_name;
  action->private_data->icon_name = g_strdup (icon_name);
  g_free (tmp);

  g_object_notify (G_OBJECT (action), "icon-name");
}

1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
/**
 * gtk_action_get_icon_name:
 * @action: a #GtkAction
 *
 * Gets the icon name of @action.
 *
 * Returns: the icon name
 *
 * Since: 2.16
 */
1572
G_CONST_RETURN gchar * 
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
gtk_action_get_icon_name (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->icon_name;
}

/**
 * gtk_action_set_gicon:
 * @action: a #GtkAction
 * @icon: the #GIcon to set
 *
 * Sets the icon of @action.
 *
 * Since: 2.16
 */
void
1590 1591 1592
gtk_action_set_gicon (GtkAction *action,
                      GIcon     *icon)
{
1593 1594
  g_return_if_fail (GTK_IS_ACTION (action));

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
  if (action->private_data->gicon)
    g_object_unref (action->private_data->gicon);

  action->private_data->gicon = icon;

  if (action->private_data->gicon)
    g_object_ref (action->private_data->gicon);

  g_object_notify (G_OBJECT (action), "gicon");
}
1605

1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623
/**
 * gtk_action_get_gicon:
 * @action: a #GtkAction
 *
 * Gets the gicon of @action.
 *
 * Returns: The action's #GIcon if one is set.
 *
 * Since: 2.16
 */
GIcon *
gtk_action_get_gicon (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->gicon;
}

1624 1625 1626 1627 1628 1629 1630 1631
static void
closure_accel_activate (GClosure     *closure,
                        GValue       *return_value,
                        guint         n_param_values,
                        const GValue *param_values,
                        gpointer      invocation_hint,
                        gpointer      marshal_data)
{
1632
  if (gtk_action_is_sensitive (GTK_ACTION (closure->data)))
1633 1634 1635 1636 1637 1638
    {
      _gtk_action_emit_activate (GTK_ACTION (closure->data));
      
      /* we handled the accelerator */
      g_value_set_boolean (return_value, TRUE);
    }
1639 1640
}

1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
static void
gtk_action_set_action_group (GtkAction	    *action,
			     GtkActionGroup *action_group)
{
  if (action->private_data->action_group == NULL)
    g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
  else
    g_return_if_fail (action_group == NULL);

  action->private_data->action_group = action_group;
}

1653 1654 1655 1656 1657 1658 1659 1660 1661
/**
 * gtk_action_set_accel_path:
 * @action: the action object
 * @accel_path: the accelerator path
 *
 * Sets the accel path for this action.  All proxy widgets associated
 * with the action will have this accel path, so that their
 * accelerators are consistent.
 *
1662 1663 1664 1665
 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
 * pass a static string, you can save some memory by interning it first with 
 * g_intern_static_string().
 *
1666 1667 1668 1669 1670 1671
 * Since: 2.4
 */
void
gtk_action_set_accel_path (GtkAction   *action, 
			   const gchar *accel_path)
{
1672 1673
  g_return_if_fail (GTK_IS_ACTION (action));

1674 1675
  action->private_data->accel_quark = g_quark_from_string (accel_path);
}
1676

1677 1678 1679 1680 1681 1682 1683 1684 1685
/**
 * gtk_action_get_accel_path:
 * @action: the action object
 *
 * Returns the accel path for this action.  
 *
 * Since: 2.6
 *
 * Returns: the accel path for this action, or %NULL
1686
 *   if none is set. The returned string is owned by GTK+ 
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
 *   and must not be freed or modified.
 */
G_CONST_RETURN gchar *
gtk_action_get_accel_path (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  if (action->private_data->accel_quark)
    return g_quark_to_string (action->private_data->accel_quark);
  else
    return NULL;
}

1700 1701 1702 1703 1704 1705 1706 1707 1708
/**
 * gtk_action_get_accel_closure:
 * @action: the action object
 *
 * Returns the accel closure for this action.
 *
 * Since: 2.8
 *
 * Returns: the accel closure for this action. The returned closure is
1709
 *          owned by GTK+ and must not be unreffed or modified.
1710 1711 1712 1713 1714 1715 1716 1717 1718
 */
GClosure *
gtk_action_get_accel_closure (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->accel_closure;
}

1719

1720 1721 1722
/**
 * gtk_action_set_accel_group:
 * @action: the action object
1723 1724
 * @accel_group: (allow-none): a #GtkAccelGroup or %NULL
 *
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
 * Sets the #GtkAccelGroup in which the accelerator for this action
 * will be installed.
 *
 * Since: 2.4
 **/
void
gtk_action_set_accel_group (GtkAction     *action,
			    GtkAccelGroup *accel_group)
{
  g_return_if_fail (GTK_IS_ACTION (action));
  g_return_if_fail (accel_group == NULL || GTK_IS_ACCEL_GROUP (accel_group));
  
  if (accel_group)
    g_object_ref (accel_group);
  if (action->private_data->accel_group)
    g_object_unref (action->private_data->accel_group);

  action->private_data->accel_group = accel_group;
}

/**
 * gtk_action_connect_accelerator:
 * @action: a #GtkAction
 * 
 * Installs the accelerator for @action if @action has an
 * accel path and group. See gtk_action_set_accel_path() and 
 * gtk_action_set_accel_group()
 *
 * Since multiple proxies may independently trigger the installation
 * of the accelerator, the @action counts the number of times this
 * function has been called and doesn't remove the accelerator until
 * gtk_action_disconnect_accelerator() has been called as many times.
 *
 * Since: 2.4
 **/
void 
gtk_action_connect_accelerator (GtkAction *action)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  if (!action->private_data->accel_quark ||
      !action->private_data->accel_group)
    return;

  if (action->private_data->accel_count == 0)
    {
      const gchar *accel_path = 
	g_quark_to_string (action->private_data->accel_quark);
      
      gtk_accel_group_connect_by_path (action->private_data->accel_group,
				       accel_path,
				       action->private_data->accel_closure);
    }

  action->private_data->accel_count++;
}

/**
 * gtk_action_disconnect_accelerator:
 * @action: a #GtkAction
 * 
 * Undoes the effect of one call to gtk_action_connect_accelerator().
 *
 * Since: 2.4
 **/
void 
gtk_action_disconnect_accelerator (GtkAction *action)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  if (!action->private_data->accel_quark ||
      !action->private_data->accel_group)
    return;

  action->private_data->accel_count--;

  if (action->private_data->accel_count == 0)
    gtk_accel_group_disconnect (action->private_data->accel_group,
				action->private_data->accel_closure);
}
1805

1806
/**
1807
 * gtk_action_create_menu:
1808 1809 1810
 * @action: a #GtkAction
 *
 * If @action provides a #GtkMenu widget as a submenu for the menu
1811 1812
 * item or the toolbar item it creates, this function returns an
 * instance of that menu.
1813