gtkaction.c 48.3 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
/**
 * SECTION:gtkaction
 * @Short_description: An action which can be triggered by a menu or toolbar item
 * @Title: GtkAction
33
 * @See_also: #GtkActionGroup, #GtkUIManager, #GtkActivatable
34 35 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
 *
 * 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.
 *
61 62 63 64 65 66 67 68 69 70
 * 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.
71 72
 */

73
#include "config.h"
74 75

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


struct _GtkActionPrivate 
{
97
  const gchar *name; /* interned */
98 99 100
  gchar *label;
  gchar *short_label;
  gchar *tooltip;
101 102
  gchar *stock_id; /* stock icon */
  gchar *icon_name; /* themed icon */
103
  GIcon *gicon;
104

105 106 107 108
  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 */
109 110
  guint visible_horizontal : 1;
  guint visible_vertical   : 1;
111 112 113
  guint is_important       : 1;
  guint hide_if_empty      : 1;
  guint visible_overflown  : 1;
114
  guint always_show_image  : 1;
115 116
  guint recursion_guard    : 1;
  guint activate_blocked   : 1;
117 118

  /* accelerator */
119 120 121 122
  guint          accel_count;
  GtkAccelGroup *accel_group;
  GClosure      *accel_closure;
  GQuark         accel_quark;
123

124 125
  GtkActionGroup *action_group;

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  /* 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,
144
  PROP_ICON_NAME,
145
  PROP_GICON,
146 147
  PROP_VISIBLE_HORIZONTAL,
  PROP_VISIBLE_VERTICAL,
148
  PROP_VISIBLE_OVERFLOWN,
149
  PROP_IS_IMPORTANT,
150
  PROP_HIDE_IF_EMPTY,
151
  PROP_SENSITIVE,
152
  PROP_VISIBLE,
153 154
  PROP_ACTION_GROUP,
  PROP_ALWAYS_SHOW_IMAGE
155 156
};

157 158 159 160 161 162 163 164 165 166
/* 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))

167 168 169 170 171 172 173 174 175
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);
176
static void gtk_action_set_action_group (GtkAction	*action,
177
					 GtkActionGroup *action_group);
178 179 180

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

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;

209 210 211 212
  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;
213
  klass->toolbar_item_type = GTK_TYPE_TOOL_BUTTON;
214 215
  klass->connect_proxy    = connect_proxy;
  klass->disconnect_proxy = disconnect_proxy;
216 217 218 219

  g_object_class_install_property (gobject_class,
				   PROP_NAME,
				   g_param_spec_string ("name",
220 221
							P_("Name"),
							P_("A unique name for the action."),
222
							NULL,
223 224
							GTK_PARAM_READWRITE | 
							G_PARAM_CONSTRUCT_ONLY));
225 226 227 228 229 230 231

  /**
   * 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.
232 233 234
   *
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
235
   */
236 237 238
  g_object_class_install_property (gobject_class,
				   PROP_LABEL,
				   g_param_spec_string ("label",
239
							P_("Label"),
240 241
							P_("The label used for menu items and buttons "
							   "that activate this action."),
242
							NULL,
243
							GTK_PARAM_READWRITE));
244 245 246 247 248

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


262 263 264
  g_object_class_install_property (gobject_class,
				   PROP_TOOLTIP,
				   g_param_spec_string ("tooltip",
265 266
							P_("Tooltip"),
							P_("A tooltip for this action."),
267
							NULL,
268
							GTK_PARAM_READWRITE));
269 270 271 272 273

  /**
   * GtkAction:stock-id:
   *
   * The stock icon displayed in widgets representing this action.
274 275 276
   *
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
277
   */
278 279
  g_object_class_install_property (gobject_class,
				   PROP_STOCK_ID,
280
				   g_param_spec_string ("stock-id",
281
							P_("Stock Icon"),
282 283
							P_("The stock icon displayed in widgets representing "
							   "this action."),
284
							NULL,
285
							GTK_PARAM_READWRITE));
286 287 288 289 290 291 292 293
  /**
   * 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.
   *
294 295 296
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
   *
297 298 299 300 301 302 303 304
   * 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,
305
 							GTK_PARAM_READWRITE));							
306
  /**
307
   * GtkAction:icon-name:
308 309
   *
   * The name of the icon from the icon theme. 
310 311 312 313
   * 
   * 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. 
314
   *
315 316 317
   * This is an appearance property and thus only applies if 
   * #GtkActivatable:use-action-appearance is %TRUE.
   *
318 319 320 321 322 323 324 325
   * 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,
326
 							GTK_PARAM_READWRITE));
327

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

398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
  /**
   * 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
417 418 419 420 421 422 423 424
  /**
   * GtkAction::activate:
   * @action: the #GtkAction
   *
   * The "activate" signal is emitted when the action is activated.
   *
   * Since: 2.4
   */
425
  action_signals[ACTIVATE] =
426
    g_signal_new (I_("activate"),
427 428 429 430 431 432 433 434 435 436 437 438 439
		  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)
{
440 441 442
  action->private_data = G_TYPE_INSTANCE_GET_PRIVATE (action,
                                                      GTK_TYPE_ACTION,
                                                      GtkActionPrivate);
443 444 445 446 447 448

  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;
449
  action->private_data->icon_name = NULL;
450 451
  action->private_data->visible_horizontal = TRUE;
  action->private_data->visible_vertical   = TRUE;
452
  action->private_data->visible_overflown  = TRUE;
453
  action->private_data->is_important = FALSE;
454
  action->private_data->hide_if_empty = TRUE;
455
  action->private_data->always_show_image = FALSE;
456
  action->private_data->activate_blocked = FALSE;
457 458 459 460 461 462 463

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

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

464
  action->private_data->accel_count = 0;
465 466
  action->private_data->accel_group = NULL;
  action->private_data->accel_quark = 0;
467 468 469 470 471 472 473
  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);

474 475
  action->private_data->action_group = NULL;

476
  action->private_data->proxies = NULL;
477
  action->private_data->gicon = NULL;  
478 479
}

480 481 482 483 484 485 486 487 488 489 490 491 492
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);

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

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

  return action->private_data->name;
}

504 505 506
/**
 * gtk_action_new:
 * @name: A unique name for the action
507 508
 * @label: (allow-none): the label displayed in menu items and on buttons,
 *         or %NULL
509
 * @tooltip: (allow-none): a tooltip for the action, or %NULL
510 511
 * @stock_id: (allow-none): the stock icon to display in widgets representing
 *            the action, or %NULL
512 513 514 515
 *
 * 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
516
 * See <xref linkend="XML-UI"/> for information on allowed action
517
 * names.
518 519 520 521 522 523 524 525 526 527 528
 *
 * 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)
{
529 530 531 532 533 534 535 536
  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);
537 538
}

539 540 541 542 543 544 545 546 547 548
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);
549
  g_free (action->private_data->icon_name);
550 551 552
  
  if (action->private_data->gicon)
    g_object_unref (action->private_data->gicon);
553

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

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

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:
574
      action->private_data->name = g_intern_string (g_value_get_string (value));
575 576
      break;
    case PROP_LABEL:
577
      gtk_action_set_label (action, g_value_get_string (value));
578 579
      break;
    case PROP_SHORT_LABEL:
580
      gtk_action_set_short_label (action, g_value_get_string (value));
581 582
      break;
    case PROP_TOOLTIP:
583
      gtk_action_set_tooltip (action, g_value_get_string (value));
584 585
      break;
    case PROP_STOCK_ID:
586
      gtk_action_set_stock_id (action, g_value_get_string (value));
587
      break;
588 589 590
    case PROP_GICON:
      gtk_action_set_gicon (action, g_value_get_object (value));
      break;
591 592 593
    case PROP_ICON_NAME:
      gtk_action_set_icon_name (action, g_value_get_string (value));
      break;
594
    case PROP_VISIBLE_HORIZONTAL:
595
      gtk_action_set_visible_horizontal (action, g_value_get_boolean (value));
596 597
      break;
    case PROP_VISIBLE_VERTICAL:
598
      gtk_action_set_visible_vertical (action, g_value_get_boolean (value));
599
      break;
600 601 602
    case PROP_VISIBLE_OVERFLOWN:
      action->private_data->visible_overflown = g_value_get_boolean (value);
      break;
603
    case PROP_IS_IMPORTANT:
604
      gtk_action_set_is_important (action, g_value_get_boolean (value));
605
      break;
606 607 608
    case PROP_HIDE_IF_EMPTY:
      action->private_data->hide_if_empty = g_value_get_boolean (value);
      break;
609
    case PROP_SENSITIVE:
610
      gtk_action_set_sensitive (action, g_value_get_boolean (value));
611 612
      break;
    case PROP_VISIBLE:
613
      gtk_action_set_visible (action, g_value_get_boolean (value));
614
      break;
615 616 617
    case PROP_ACTION_GROUP:
      gtk_action_set_action_group (action, g_value_get_object (value));
      break;
618 619 620
    case PROP_ALWAYS_SHOW_IMAGE:
      gtk_action_set_always_show_image (action, g_value_get_boolean (value));
      break;
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
    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:
640
      g_value_set_static_string (value, action->private_data->name);
641 642 643 644 645 646 647 648 649 650 651 652 653
      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;
654 655 656
    case PROP_ICON_NAME:
      g_value_set_string (value, action->private_data->icon_name);
      break;
657 658 659
    case PROP_GICON:
      g_value_set_object (value, action->private_data->gicon);
      break;
660 661 662 663 664 665
    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;
666 667 668
    case PROP_VISIBLE_OVERFLOWN:
      g_value_set_boolean (value, action->private_data->visible_overflown);
      break;
669 670 671
    case PROP_IS_IMPORTANT:
      g_value_set_boolean (value, action->private_data->is_important);
      break;
672 673 674
    case PROP_HIDE_IF_EMPTY:
      g_value_set_boolean (value, action->private_data->hide_if_empty);
      break;
675 676 677 678 679 680
    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;
681 682 683
    case PROP_ACTION_GROUP:
      g_value_set_object (value, action->private_data->action_group);
      break;
684 685 686
    case PROP_ALWAYS_SHOW_IMAGE:
      g_value_set_boolean (value, action->private_data->always_show_image);
      break;
687 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
    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
714 715
remove_proxy (GtkAction *action,
	      GtkWidget *proxy)
716
{
717
  g_object_unref (proxy);
718
  action->private_data->proxies = g_slist_remove (action->private_data->proxies, proxy);
719 720
}

721 722 723 724 725 726
static void
connect_proxy (GtkAction *action,
	       GtkWidget *proxy)
{
  action->private_data->proxies = g_slist_prepend (action->private_data->proxies, proxy);

727 728
  g_object_ref_sink (proxy);

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
  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);
}

744 745
/**
 * _gtk_action_sync_menu_visible:
746
 * @action: (allow-none): a #GtkAction, or %NULL to determine the action from @proxy
747 748 749 750 751 752 753 754
 * @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>
755 756
 * <listitem><para>if @empty is %TRUE, hide @proxy unless the "hide-if-empty" 
 *   property of @action indicates otherwise
757 758 759 760 761 762 763 764 765 766
 * </para></listitem>
 * </itemizedlist>
 * 
 * This function is used in the implementation of #GtkUIManager.
 **/
void
_gtk_action_sync_menu_visible (GtkAction *action,
			       GtkWidget *proxy,
			       gboolean   empty)
{
767 768
  gboolean visible = TRUE;
  gboolean hide_if_empty = TRUE;
769 770 771

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

773
  if (action == NULL)
774
    action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (proxy));
775

776 777 778 779 780 781
  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;
    }
782

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

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

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

801
  g_signal_emit (action, action_signals[ACTIVATE], 0);
802

803
  if (group != NULL)
Matthias Clasen's avatar
Matthias Clasen committed
804 805 806
    {
      _gtk_action_group_emit_post_activate (group, action);
      g_object_unref (group);
807
      g_object_unref (action);
Matthias Clasen's avatar
Matthias Clasen committed
808
    }
809 810
}

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

  if (gtk_action_is_sensitive (action))
832
    _gtk_action_emit_activate (action);
833 834
}

835 836
/**
 * gtk_action_block_activate:
Matthias Clasen's avatar
Matthias Clasen committed
837
 * @action: a #GtkAction
838 839 840 841 842 843 844
 *
 * 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
845 846
 *
 * Since: 2.16
847 848 849 850 851 852 853 854 855 856 857
 */
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
858
 * @action: a #GtkAction
859 860
 *
 * Reenable activation signals from the action 
Matthias Clasen's avatar
Matthias Clasen committed
861 862
 *
 * Since: 2.16
863 864 865 866 867 868 869 870 871
 */
void
gtk_action_unblock_activate (GtkAction *action)
{
  g_return_if_fail (GTK_IS_ACTION (action));

  action->private_data->activate_blocked = FALSE;
}

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

889 890
  if (action->private_data->stock_id &&
      gtk_icon_factory_lookup_default (action->private_data->stock_id))
891
    return gtk_image_new_from_stock (action->private_data->stock_id, icon_size);
892 893
  else if (action->private_data->gicon)
    return gtk_image_new_from_gicon (action->private_data->gicon, icon_size);
894 895
  else if (action->private_data->icon_name)
    return gtk_image_new_from_icon_name (action->private_data->icon_name, icon_size);
896 897 898 899 900 901 902 903 904 905
  else
    return NULL;
}

/**
 * gtk_action_create_menu_item:
 * @action: the action object
 *
 * Creates a menu item widget that proxies for the given action.
 *
906
 * Returns: (transfer none): a menu item connected to the action.
907 908 909 910 911 912 913 914 915 916
 *
 * Since: 2.4
 */
GtkWidget *
gtk_action_create_menu_item (GtkAction *action)
{
  GtkWidget *menu_item;

  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

917
  menu_item = GTK_ACTION_GET_CLASS (action)->create_menu_item (action);
918

919 920
  gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (menu_item), TRUE);
  gtk_activatable_set_related_action (GTK_ACTIVATABLE (menu_item), action);
921 922 923 924 925 926 927 928 929 930

  return menu_item;
}

/**
 * gtk_action_create_tool_item:
 * @action: the action object
 *
 * Creates a toolbar item widget that proxies for the given action.
 *
931
 * Returns: (transfer none): a toolbar item connected to the action.
932 933 934 935 936 937 938 939 940 941
 *
 * Since: 2.4
 */
GtkWidget *
gtk_action_create_tool_item (GtkAction *action)
{
  GtkWidget *button;

  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

942
  button = GTK_ACTION_GET_CLASS (action)->create_tool_item (action);
943

944 945
  gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (button), TRUE);
  gtk_activatable_set_related_action (GTK_ACTIVATABLE (button), action);
946 947 948 949

  return button;
}

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
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);
}

970 971 972 973 974
/**
 * gtk_action_get_proxies:
 * @action: the action object
 * 
 * Returns the proxy widgets for an action.
975
 * See also gtk_activatable_get_related_action().
976 977
 *
 * Return value: (element-type GtkWidget) (transfer none): a #GSList of proxy widgets. The list is owned by GTK+
978
 * and must not be modified.
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
 *
 * 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
 **/
1001
const gchar *
1002 1003 1004 1005 1006 1007 1008
gtk_action_get_name (GtkAction *action)
{
  g_return_val_if_fail (GTK_IS_ACTION (action), NULL);

  return action->private_data->name;
}

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 1048 1049 1050 1051
/**
 * 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;
}

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
/**
 * 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");
    }
}

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 1119 1120 1121 1122
/**
 * 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;
}

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
/**
 * 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");
    }
}
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/**
 * 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 
1162 1163 1164
gtk_action_set_is_important (GtkAction *action,
			     gboolean   is_important)
{
1165
  g_return_if_fail (GTK_IS_ACTION (action));
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176

  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");
    }  
}

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

  return action->private_data->is_important;
}

1195 1196
/**
 * gtk_action_set_always_show_image:
Matthias Clasen's avatar
Matthias Clasen committed
1197
 * @action: a #GtkAction
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 1226 1227 1228 1229
 * @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
1230
 * @action: a #GtkAction
1231 1232
 *
 * Returns whether @action<!-- -->'s menu item proxies will ignore the
Matthias Clasen's avatar
Matthias Clasen committed
1233 1234
 * #GtkSettings:gtk-menu-images setting and always show their image,
 * if available.
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
 *
 * 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;
}

1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
/**
 * gtk_action_set_label:
 * @action: a #GtkAction
 * @label: the label text to set
 *
 * Sets the label of @action.
 *
 * Since: 2.16
 */
void 
1258 1259 1260 1261 1262
gtk_action_set_label (GtkAction	  *action,
		      const gchar *label)
{
  gchar *tmp;
  
1263 1264
  g_return_if_fail (GTK_IS_ACTION (action));
  
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
  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);
    }
1277

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
  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;
    }
}

1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
/**
 * gtk_action_get_label:
 * @action: a #GtkAction
 *
 * Gets the label text of @action.
 *
 * Returns: the label text
 *
 * Since: 2.16
 */
1298
const gchar *
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
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
1309
 * @short_label: the label text to set
1310
 *
1311
 * Sets a shorter label text on @action.
1312 1313 1314 1315
 *
 * Since: 2.16
 */
void 
1316
gtk_action_set_short_label (GtkAction   *action,
Matthias Clasen's avatar
Matthias Clasen committed
1317
			    const gchar *short_label)
1318 1319 1320
{
  gchar *tmp;

1321 1322
  g_return_if_fail (GTK_IS_ACTION (action));

1323
  tmp = action->private_data->short_label;
Matthias Clasen's avatar
Matthias Clasen committed
1324
  action->private_data->short_label = g_strdup (short_label);
1325 1326 1327 1328 1329 1330 1331 1332 1333
  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");
}

1334 1335 1336 1337
/**
 * gtk_action_get_short_label:
 * @action: a #GtkAction
 *
1338 1339 1340
 * Gets the short label text of @action.
 *
 * Returns: the short label text.
1341 1342 1343
 *
 * Since: 2.16
 */
1344
const gchar *
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
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 
1362 1363 1364
gtk_action_set_visible_horizontal (GtkAction *action,
				   gboolean   visible_horizontal)
{
1365
  g_return_if_fail (GTK_IS_ACTION (action));
1366

1367 1368
  g_return_if_fail (GTK_IS_ACTION (action));

1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
  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");
    }  
}

1379 1380 1381 1382 1383
/**
 * gtk_action_get_visible_horizontal:
 * @action: a #GtkAction
 *
 * Checks whether @action is visible when horizontal
1384
 * 
1385 1386 1387 1388
 * Returns: whether @action is visible when horizontal
 *
 * Since: 2.16
 */
1389
gboolean 
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
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
 *
1402
 * Sets whether @action is visible when vertical 
1403 1404 1405 1406
 *
 * Since: 2.16
 */
void 
1407 1408 1409
gtk_action_set_visible_vertical (GtkAction *action,
				 gboolean   visible_vertical)
{
1410
  g_return_if_fail (GTK_IS_ACTION (action));
1411

1412 1413
  g_return_if_fail (GTK_IS_ACTION (action));

1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
  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");
    }  
}

1424 1425 1426 1427 1428
/**
 * gtk_action_get_visible_vertical:
 * @action: a #GtkAction
 *
 * Checks whether @action is visible when horizontal
1429
 * 
1430 1431 1432 1433
 * Returns: whether @action is visible when horizontal
 *
 * Since: 2.16
 */
1434
gboolean 
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
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 
1452 1453 1454 1455 1456
gtk_action_set_tooltip (GtkAction   *action,
			const gchar *tooltip)
{
  gchar *tmp;

1457 1458
  g_return_if_fail (GTK_IS_ACTION (action));

1459 1460 1461 1462 1463 1464 1465
  tmp = action->private_data->tooltip;
  action->private_data->tooltip = g_strdup (tooltip);
  g_free (tmp);

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

1466 1467 1468 1469 1470 1471
/**
 * gtk_action_get_tooltip:
 * @action: a #GtkAction
 *
 * Gets the tooltip text of @action.
 *
1472
 * Returns: the tooltip text
1473 1474 1475
 *
 * Since: 2.16
 */
1476
const gchar *
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
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
1487
 * @stock_id: the stock id
1488 1489 1490 1491 1492 1493
 *
 * Sets the stock id on @action
 *
 * Since: 2.16
 */
void 
1494 1495 1496 1497
gtk_action_set_stock_id (GtkAction   *action,
			 const gchar *stock_id)
{
  gchar *tmp;
1498 1499 1500

  g_return_if_fail (GTK_IS_ACTION (action));

1501 1502
  g_return_if_fail (GTK_IS_ACTION (action));

1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
  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;
      
1514 1515
      if (action->private_data->stock_id &&
	  gtk_stock_lookup (action->private_data->stock_id, &stock_item))
1516 1517 1518 1519 1520 1521 1522 1523
	gtk_action_set_label (action, stock_item.label);
      else 
	gtk_action_set_label (action, NULL);
      
      action->private_data->label_set = FALSE;
    }
}

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
/**
 * gtk_action_get_stock_id:
 * @action: a #GtkAction
 *
 * Gets the stock id of @action.
 *
 * Returns: the stock id
 *
 * Since: 2.16
 */
1534
const gchar *
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
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
1545
 * @icon_name: the icon name to set
1546 1547 1548 1549 1550 1551
 *
 * Sets the icon name on @action
 *
 * Since: 2.16
 */
void 
1552 1553 1554 1555
gtk_action_set_icon_name (GtkAction   *action,
			  const gchar *icon_name)
{
  gchar *tmp;
1556 1557 1558

  g_return_if_fail (GTK_IS_ACTION (action));

1559 1560 1561 1562 1563 1564 1565
  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");
}

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
/**
 * gtk_action_get_icon_name:
 * @action: a #GtkAction
 *
 * Gets the icon name of @action.
 *
 * Returns: the icon name
 *
 * Since: 2.16
 */
1576
const gchar *
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
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
1594 1595 1596
gtk_action_set_gicon (GtkAction *action,
                      GIcon     *icon)
{
1597 1598
  g_return_if_fail (GTK_IS_ACTION (action));

1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
  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");
}
1609

1610 1611 1612 1613 1614 1615
/**
 * gtk_action_get_gicon:
 * @action: a #GtkAction
 *
 * Gets the gicon of @action.
 *
1616
 * Returns: (transfer none): The action's #GIcon if one is set.
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
 *
 * 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;
}

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

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656
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;
}

1657 1658 1659 1660 1661 1662 1663 1664 1665
/**
 * 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.
 *
1666 1667 1668 1669
 * 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().
 *
1670 1671 1672 1673 1674 1675
 * Since: 2.4
 */
void
gtk_action_set_accel_path (GtkAction   *action, 
			   const gchar *accel_path)
{
1676 1677
  g_return_if_fail (GTK_IS_ACTION (action));

1678 1679
  action->private_data->accel_quark = g_quark_from_string (accel_path);
}
1680

1681 1682 1683 1684 1685 1686 1687 1688 1689
/**
 * 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
1690
 *   if none is set. The returned string is owned by GTK+ 
1691 1692
 *   and must not be freed or modified.
 */
1693
const gchar *
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
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;
}

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

  return action->private_data->accel_closure;
}

1724

1725 1726 1727
/**
 * gtk_action_set_accel_group:
 * @action: the action object
1728 1729
 * @accel_group: (allow-none): a #GtkAccelGroup or %NULL
 *
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