2 * GTK - The GIMP Toolkit
3 * Copyright (C) 1998, 1999 Red Hat, Inc.
6 * This Library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This Library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with the Gnome Library; see the file COPYING.LIB. If not,
18 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 * Author: James Henstridge <james@daa.com.au>
25 * Modified by the GTK+ Team and others 2003. See the AUTHORS
26 * file for a list of people on the GTK+ Team. See the ChangeLog
27 * files for a list of changes. These files are distributed with
28 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
33 * @Short_description: An action which can be triggered by a menu or toolbar item
35 * @See_also: #GtkActionGroup, #GtkUIManager, #GtkActivatable
37 * Actions represent operations that the user can be perform, along with
38 * some information how it should be presented in the interface. Each action
39 * provides methods to create icons, menu items and toolbar items
40 * representing itself.
42 * As well as the callback that is called when the action gets activated,
43 * the following also gets associated with the action:
45 * <listitem><para>a name (not translated, for path lookup)</para></listitem>
46 * <listitem><para>a label (translated, for display)</para></listitem>
47 * <listitem><para>an accelerator</para></listitem>
48 * <listitem><para>whether label indicates a stock id</para></listitem>
49 * <listitem><para>a tooltip (optional, translated)</para></listitem>
50 * <listitem><para>a toolbar label (optional, shorter than label)</para></listitem>
52 * The action will also have some state information:
54 * <listitem><para>visible (shown/hidden)</para></listitem>
55 * <listitem><para>sensitive (enabled/disabled)</para></listitem>
57 * Apart from regular actions, there are <link linkend="GtkToggleAction">toggle
58 * actions</link>, which can be toggled between two states and <link
59 * linkend="GtkRadioAction">radio actions</link>, of which only one in a group
60 * can be in the "active" state. Other actions can be implemented as #GtkAction
63 * Each action can have one or more proxy widgets. To act as an action proxy,
64 * widget needs to implement #GtkActivatable interface. Proxies mirror the state
65 * of the action and should change when the action's state changes. Properties
66 * that are always mirrored by proxies are #GtkAction:sensitive and
67 * #GtkAction:visible. #GtkAction:gicon, #GtkAction:icon-name, #GtkAction:label,
68 * #GtkAction:short-label and #GtkAction:stock-id properties are only mirorred
69 * if proxy widget has #GtkActivatable:use-action-appearance property set to
72 * When the proxy is activated, it should activate its action.
77 #include "gtkaction.h"
78 #include "gtkactiongroup.h"
79 #include "gtkaccellabel.h"
80 #include "gtkbutton.h"
81 #include "gtkiconfactory.h"
83 #include "gtkimagemenuitem.h"
86 #include "gtkmarshalers.h"
87 #include "gtkmenuitem.h"
89 #include "deprecated/gtktearoffmenuitem.h"
90 #include "gtktoolbutton.h"
91 #include "gtktoolbar.h"
92 #include "gtkprivate.h"
93 #include "gtkbuildable.h"
94 #include "gtkactivatable.h"
97 struct _GtkActionPrivate
99 const gchar *name; /* interned */
103 gchar *stock_id; /* stock icon */
104 gchar *icon_name; /* themed icon */
109 guint label_set : 1; /* these two used so we can set label */
110 guint short_label_set : 1; /* based on stock id */
111 guint visible_horizontal : 1;
112 guint visible_vertical : 1;
113 guint is_important : 1;
114 guint hide_if_empty : 1;
115 guint visible_overflown : 1;
116 guint always_show_image : 1;
117 guint recursion_guard : 1;
118 guint activate_blocked : 1;
122 GtkAccelGroup *accel_group;
123 GClosure *accel_closure;
126 GtkActionGroup *action_group;
128 /* list of proxy widgets */
148 PROP_VISIBLE_HORIZONTAL,
149 PROP_VISIBLE_VERTICAL,
150 PROP_VISIBLE_OVERFLOWN,
156 PROP_ALWAYS_SHOW_IMAGE
160 static void gtk_action_buildable_init (GtkBuildableIface *iface);
161 static void gtk_action_buildable_set_name (GtkBuildable *buildable,
163 static const gchar* gtk_action_buildable_get_name (GtkBuildable *buildable);
165 G_DEFINE_TYPE_WITH_CODE (GtkAction, gtk_action, G_TYPE_OBJECT,
166 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
167 gtk_action_buildable_init))
169 static void gtk_action_finalize (GObject *object);
170 static void gtk_action_set_property (GObject *object,
174 static void gtk_action_get_property (GObject *object,
178 static void gtk_action_set_action_group (GtkAction *action,
179 GtkActionGroup *action_group);
181 static GtkWidget *create_menu_item (GtkAction *action);
182 static GtkWidget *create_tool_item (GtkAction *action);
183 static void connect_proxy (GtkAction *action,
185 static void disconnect_proxy (GtkAction *action,
188 static void closure_accel_activate (GClosure *closure,
189 GValue *return_value,
190 guint n_param_values,
191 const GValue *param_values,
192 gpointer invocation_hint,
193 gpointer marshal_data);
195 static guint action_signals[LAST_SIGNAL] = { 0 };
199 gtk_action_class_init (GtkActionClass *klass)
201 GObjectClass *gobject_class;
203 gobject_class = G_OBJECT_CLASS (klass);
205 gobject_class->finalize = gtk_action_finalize;
206 gobject_class->set_property = gtk_action_set_property;
207 gobject_class->get_property = gtk_action_get_property;
209 klass->activate = NULL;
211 klass->create_menu_item = create_menu_item;
212 klass->create_tool_item = create_tool_item;
213 klass->create_menu = NULL;
214 klass->menu_item_type = GTK_TYPE_IMAGE_MENU_ITEM;
215 klass->toolbar_item_type = GTK_TYPE_TOOL_BUTTON;
216 klass->connect_proxy = connect_proxy;
217 klass->disconnect_proxy = disconnect_proxy;
219 g_object_class_install_property (gobject_class,
221 g_param_spec_string ("name",
223 P_("A unique name for the action."),
225 GTK_PARAM_READWRITE |
226 G_PARAM_CONSTRUCT_ONLY));
231 * The label used for menu items and buttons that activate
232 * this action. If the label is %NULL, GTK+ uses the stock
233 * label specified via the stock-id property.
235 * This is an appearance property and thus only applies if
236 * #GtkActivatable:use-action-appearance is %TRUE.
238 g_object_class_install_property (gobject_class,
240 g_param_spec_string ("label",
242 P_("The label used for menu items and buttons "
243 "that activate this action."),
245 GTK_PARAM_READWRITE));
248 * GtkAction:short-label:
250 * A shorter label that may be used on toolbar buttons.
252 * This is an appearance property and thus only applies if
253 * #GtkActivatable:use-action-appearance is %TRUE.
255 g_object_class_install_property (gobject_class,
257 g_param_spec_string ("short-label",
259 P_("A shorter label that may be used on toolbar buttons."),
261 GTK_PARAM_READWRITE));
264 g_object_class_install_property (gobject_class,
266 g_param_spec_string ("tooltip",
268 P_("A tooltip for this action."),
270 GTK_PARAM_READWRITE));
273 * GtkAction:stock-id:
275 * The stock icon displayed in widgets representing this action.
277 * This is an appearance property and thus only applies if
278 * #GtkActivatable:use-action-appearance is %TRUE.
280 g_object_class_install_property (gobject_class,
282 g_param_spec_string ("stock-id",
284 P_("The stock icon displayed in widgets representing "
287 GTK_PARAM_READWRITE));
291 * The #GIcon displayed in the #GtkAction.
293 * Note that the stock icon is preferred, if the #GtkAction:stock-id
294 * property holds the id of an existing stock icon.
296 * This is an appearance property and thus only applies if
297 * #GtkActivatable:use-action-appearance is %TRUE.
301 g_object_class_install_property (gobject_class,
303 g_param_spec_object ("gicon",
305 P_("The GIcon being displayed"),
307 GTK_PARAM_READWRITE));
309 * GtkAction:icon-name:
311 * The name of the icon from the icon theme.
313 * Note that the stock icon is preferred, if the #GtkAction:stock-id
314 * property holds the id of an existing stock icon, and the #GIcon is
315 * preferred if the #GtkAction:gicon property is set.
317 * This is an appearance property and thus only applies if
318 * #GtkActivatable:use-action-appearance is %TRUE.
322 g_object_class_install_property (gobject_class,
324 g_param_spec_string ("icon-name",
326 P_("The name of the icon from the icon theme"),
328 GTK_PARAM_READWRITE));
330 g_object_class_install_property (gobject_class,
331 PROP_VISIBLE_HORIZONTAL,
332 g_param_spec_boolean ("visible-horizontal",
333 P_("Visible when horizontal"),
334 P_("Whether the toolbar item is visible when the toolbar "
335 "is in a horizontal orientation."),
337 GTK_PARAM_READWRITE));
339 * GtkAction:visible-overflown:
341 * When %TRUE, toolitem proxies for this action are represented in the
342 * toolbar overflow menu.
346 g_object_class_install_property (gobject_class,
347 PROP_VISIBLE_OVERFLOWN,
348 g_param_spec_boolean ("visible-overflown",
349 P_("Visible when overflown"),
350 P_("When TRUE, toolitem proxies for this action "
351 "are represented in the toolbar overflow menu."),
353 GTK_PARAM_READWRITE));
354 g_object_class_install_property (gobject_class,
355 PROP_VISIBLE_VERTICAL,
356 g_param_spec_boolean ("visible-vertical",
357 P_("Visible when vertical"),
358 P_("Whether the toolbar item is visible when the toolbar "
359 "is in a vertical orientation."),
361 GTK_PARAM_READWRITE));
362 g_object_class_install_property (gobject_class,
364 g_param_spec_boolean ("is-important",
366 P_("Whether the action is considered important. "
367 "When TRUE, toolitem proxies for this action "
368 "show text in GTK_TOOLBAR_BOTH_HORIZ mode."),
370 GTK_PARAM_READWRITE));
371 g_object_class_install_property (gobject_class,
373 g_param_spec_boolean ("hide-if-empty",
375 P_("When TRUE, empty menu proxies for this action are hidden."),
377 GTK_PARAM_READWRITE));
378 g_object_class_install_property (gobject_class,
380 g_param_spec_boolean ("sensitive",
382 P_("Whether the action is enabled."),
384 GTK_PARAM_READWRITE));
385 g_object_class_install_property (gobject_class,
387 g_param_spec_boolean ("visible",
389 P_("Whether the action is visible."),
391 GTK_PARAM_READWRITE));
392 g_object_class_install_property (gobject_class,
394 g_param_spec_object ("action-group",
396 P_("The GtkActionGroup this GtkAction is associated with, or NULL (for internal use)."),
397 GTK_TYPE_ACTION_GROUP,
398 GTK_PARAM_READWRITE));
401 * GtkAction:always-show-image:
403 * If %TRUE, the action's menu item proxies will ignore the #GtkSettings:gtk-menu-images
404 * setting and always show their image, if available.
406 * Use this property if the menu item would be useless or hard to use
407 * without their image.
411 g_object_class_install_property (gobject_class,
412 PROP_ALWAYS_SHOW_IMAGE,
413 g_param_spec_boolean ("always-show-image",
414 P_("Always show image"),
415 P_("Whether the image will always be shown"),
417 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
420 * GtkAction::activate:
421 * @action: the #GtkAction
423 * The "activate" signal is emitted when the action is activated.
427 action_signals[ACTIVATE] =
428 g_signal_new (I_("activate"),
429 G_OBJECT_CLASS_TYPE (klass),
430 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE,
431 G_STRUCT_OFFSET (GtkActionClass, activate), NULL, NULL,
432 g_cclosure_marshal_VOID__VOID,
435 g_type_class_add_private (gobject_class, sizeof (GtkActionPrivate));
440 gtk_action_init (GtkAction *action)
442 action->private_data = G_TYPE_INSTANCE_GET_PRIVATE (action,
446 action->private_data->name = NULL;
447 action->private_data->label = NULL;
448 action->private_data->short_label = NULL;
449 action->private_data->tooltip = NULL;
450 action->private_data->stock_id = NULL;
451 action->private_data->icon_name = NULL;
452 action->private_data->visible_horizontal = TRUE;
453 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;
460 action->private_data->sensitive = TRUE;
461 action->private_data->visible = TRUE;
463 action->private_data->label_set = FALSE;
464 action->private_data->short_label_set = FALSE;
466 action->private_data->accel_count = 0;
467 action->private_data->accel_group = NULL;
468 action->private_data->accel_quark = 0;
469 action->private_data->accel_closure =
470 g_closure_new_object (sizeof (GClosure), G_OBJECT (action));
471 g_closure_set_marshal (action->private_data->accel_closure,
472 closure_accel_activate);
473 g_closure_ref (action->private_data->accel_closure);
474 g_closure_sink (action->private_data->accel_closure);
476 action->private_data->action_group = NULL;
478 action->private_data->proxies = NULL;
479 action->private_data->gicon = NULL;
483 gtk_action_buildable_init (GtkBuildableIface *iface)
485 iface->set_name = gtk_action_buildable_set_name;
486 iface->get_name = gtk_action_buildable_get_name;
490 gtk_action_buildable_set_name (GtkBuildable *buildable,
493 GtkAction *action = GTK_ACTION (buildable);
495 action->private_data->name = g_intern_string (name);
499 gtk_action_buildable_get_name (GtkBuildable *buildable)
501 GtkAction *action = GTK_ACTION (buildable);
503 return action->private_data->name;
508 * @name: A unique name for the action
509 * @label: (allow-none): the label displayed in menu items and on buttons,
511 * @tooltip: (allow-none): a tooltip for the action, or %NULL
512 * @stock_id: (allow-none): the stock icon to display in widgets representing
513 * the action, or %NULL
515 * Creates a new #GtkAction object. To add the action to a
516 * #GtkActionGroup and set the accelerator for the action,
517 * call gtk_action_group_add_action_with_accel().
518 * See <xref linkend="XML-UI"/> for information on allowed action
521 * Return value: a new #GtkAction
526 gtk_action_new (const gchar *name,
528 const gchar *tooltip,
529 const gchar *stock_id)
531 g_return_val_if_fail (name != NULL, NULL);
533 return g_object_new (GTK_TYPE_ACTION,
537 "stock-id", stock_id,
542 gtk_action_finalize (GObject *object)
545 action = GTK_ACTION (object);
547 g_free (action->private_data->label);
548 g_free (action->private_data->short_label);
549 g_free (action->private_data->tooltip);
550 g_free (action->private_data->stock_id);
551 g_free (action->private_data->icon_name);
553 if (action->private_data->gicon)
554 g_object_unref (action->private_data->gicon);
556 g_closure_unref (action->private_data->accel_closure);
557 if (action->private_data->accel_group)
558 g_object_unref (action->private_data->accel_group);
560 G_OBJECT_CLASS (gtk_action_parent_class)->finalize (object);
564 gtk_action_set_property (GObject *object,
571 action = GTK_ACTION (object);
576 action->private_data->name = g_intern_string (g_value_get_string (value));
579 gtk_action_set_label (action, g_value_get_string (value));
581 case PROP_SHORT_LABEL:
582 gtk_action_set_short_label (action, g_value_get_string (value));
585 gtk_action_set_tooltip (action, g_value_get_string (value));
588 gtk_action_set_stock_id (action, g_value_get_string (value));
591 gtk_action_set_gicon (action, g_value_get_object (value));
594 gtk_action_set_icon_name (action, g_value_get_string (value));
596 case PROP_VISIBLE_HORIZONTAL:
597 gtk_action_set_visible_horizontal (action, g_value_get_boolean (value));
599 case PROP_VISIBLE_VERTICAL:
600 gtk_action_set_visible_vertical (action, g_value_get_boolean (value));
602 case PROP_VISIBLE_OVERFLOWN:
603 action->private_data->visible_overflown = g_value_get_boolean (value);
605 case PROP_IS_IMPORTANT:
606 gtk_action_set_is_important (action, g_value_get_boolean (value));
608 case PROP_HIDE_IF_EMPTY:
609 action->private_data->hide_if_empty = g_value_get_boolean (value);
612 gtk_action_set_sensitive (action, g_value_get_boolean (value));
615 gtk_action_set_visible (action, g_value_get_boolean (value));
617 case PROP_ACTION_GROUP:
618 gtk_action_set_action_group (action, g_value_get_object (value));
620 case PROP_ALWAYS_SHOW_IMAGE:
621 gtk_action_set_always_show_image (action, g_value_get_boolean (value));
624 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
630 gtk_action_get_property (GObject *object,
637 action = GTK_ACTION (object);
642 g_value_set_static_string (value, action->private_data->name);
645 g_value_set_string (value, action->private_data->label);
647 case PROP_SHORT_LABEL:
648 g_value_set_string (value, action->private_data->short_label);
651 g_value_set_string (value, action->private_data->tooltip);
654 g_value_set_string (value, action->private_data->stock_id);
657 g_value_set_string (value, action->private_data->icon_name);
660 g_value_set_object (value, action->private_data->gicon);
662 case PROP_VISIBLE_HORIZONTAL:
663 g_value_set_boolean (value, action->private_data->visible_horizontal);
665 case PROP_VISIBLE_VERTICAL:
666 g_value_set_boolean (value, action->private_data->visible_vertical);
668 case PROP_VISIBLE_OVERFLOWN:
669 g_value_set_boolean (value, action->private_data->visible_overflown);
671 case PROP_IS_IMPORTANT:
672 g_value_set_boolean (value, action->private_data->is_important);
674 case PROP_HIDE_IF_EMPTY:
675 g_value_set_boolean (value, action->private_data->hide_if_empty);
678 g_value_set_boolean (value, action->private_data->sensitive);
681 g_value_set_boolean (value, action->private_data->visible);
683 case PROP_ACTION_GROUP:
684 g_value_set_object (value, action->private_data->action_group);
686 case PROP_ALWAYS_SHOW_IMAGE:
687 g_value_set_boolean (value, action->private_data->always_show_image);
690 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
696 create_menu_item (GtkAction *action)
698 GType menu_item_type;
700 menu_item_type = GTK_ACTION_GET_CLASS (action)->menu_item_type;
702 return g_object_new (menu_item_type, NULL);
706 create_tool_item (GtkAction *action)
708 GType toolbar_item_type;
710 toolbar_item_type = GTK_ACTION_GET_CLASS (action)->toolbar_item_type;
712 return g_object_new (toolbar_item_type, NULL);
716 remove_proxy (GtkAction *action,
719 g_object_unref (proxy);
720 action->private_data->proxies = g_slist_remove (action->private_data->proxies, proxy);
724 connect_proxy (GtkAction *action,
727 action->private_data->proxies = g_slist_prepend (action->private_data->proxies, proxy);
729 g_object_ref_sink (proxy);
731 if (action->private_data->action_group)
732 _gtk_action_group_emit_connect_proxy (action->private_data->action_group, action, proxy);
737 disconnect_proxy (GtkAction *action,
740 remove_proxy (action, proxy);
742 if (action->private_data->action_group)
743 _gtk_action_group_emit_disconnect_proxy (action->private_data->action_group, action, proxy);
747 * _gtk_action_sync_menu_visible:
748 * @action: (allow-none): a #GtkAction, or %NULL to determine the action from @proxy
749 * @proxy: a proxy menu item
750 * @empty: whether the submenu attached to @proxy is empty
752 * Updates the visibility of @proxy from the visibility of @action
753 * according to the following rules:
755 * <listitem><para>if @action is invisible, @proxy is too
757 * <listitem><para>if @empty is %TRUE, hide @proxy unless the "hide-if-empty"
758 * property of @action indicates otherwise
762 * This function is used in the implementation of #GtkUIManager.
765 _gtk_action_sync_menu_visible (GtkAction *action,
769 gboolean visible = TRUE;
770 gboolean hide_if_empty = TRUE;
772 g_return_if_fail (GTK_IS_MENU_ITEM (proxy));
773 g_return_if_fail (action == NULL || GTK_IS_ACTION (action));
776 action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (proxy));
780 /* a GtkMenu for a <popup/> doesn't have to have an action */
781 visible = gtk_action_is_visible (action);
782 hide_if_empty = action->private_data->hide_if_empty;
785 if (visible && !(empty && hide_if_empty))
786 gtk_widget_show (proxy);
788 gtk_widget_hide (proxy);
792 _gtk_action_emit_activate (GtkAction *action)
794 GtkActionGroup *group = action->private_data->action_group;
798 g_object_ref (group);
799 _gtk_action_group_emit_pre_activate (group, action);
802 g_signal_emit (action, action_signals[ACTIVATE], 0);
806 _gtk_action_group_emit_post_activate (group, action);
807 g_object_unref (group);
812 * gtk_action_activate:
813 * @action: the action object
815 * Emits the "activate" signal on the specified action, if it isn't
816 * insensitive. This gets called by the proxy widgets when they get
819 * It can also be used to manually activate an action.
824 gtk_action_activate (GtkAction *action)
826 g_return_if_fail (GTK_IS_ACTION (action));
828 if (action->private_data->activate_blocked)
831 if (gtk_action_is_sensitive (action))
832 _gtk_action_emit_activate (action);
836 * gtk_action_block_activate:
837 * @action: a #GtkAction
839 * Disable activation signals from the action
841 * This is needed when updating the state of your proxy
842 * #GtkActivatable widget could result in calling gtk_action_activate(),
843 * this is a convenience function to avoid recursing in those
844 * cases (updating toggle state for instance).
849 gtk_action_block_activate (GtkAction *action)
851 g_return_if_fail (GTK_IS_ACTION (action));
853 action->private_data->activate_blocked = TRUE;
857 * gtk_action_unblock_activate:
858 * @action: a #GtkAction
860 * Reenable activation signals from the action
865 gtk_action_unblock_activate (GtkAction *action)
867 g_return_if_fail (GTK_IS_ACTION (action));
869 action->private_data->activate_blocked = FALSE;
873 * gtk_action_create_icon:
874 * @action: the action object
875 * @icon_size: (type int): the size of the icon that should be created.
877 * This function is intended for use by action implementations to
878 * create icons displayed in the proxy widgets.
880 * Returns: (transfer none): a widget that displays the icon for this action.
885 gtk_action_create_icon (GtkAction *action, GtkIconSize icon_size)
887 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
889 if (action->private_data->stock_id &&
890 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 else if (action->private_data->gicon)
893 return gtk_image_new_from_gicon (action->private_data->gicon, icon_size);
894 else if (action->private_data->icon_name)
895 return gtk_image_new_from_icon_name (action->private_data->icon_name, icon_size);
901 * gtk_action_create_menu_item:
902 * @action: the action object
904 * Creates a menu item widget that proxies for the given action.
906 * Returns: (transfer none): a menu item connected to the action.
911 gtk_action_create_menu_item (GtkAction *action)
913 GtkWidget *menu_item;
915 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
917 menu_item = GTK_ACTION_GET_CLASS (action)->create_menu_item (action);
919 gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (menu_item), TRUE);
920 gtk_activatable_set_related_action (GTK_ACTIVATABLE (menu_item), action);
926 * gtk_action_create_tool_item:
927 * @action: the action object
929 * Creates a toolbar item widget that proxies for the given action.
931 * Returns: (transfer none): a toolbar item connected to the action.
936 gtk_action_create_tool_item (GtkAction *action)
940 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
942 button = GTK_ACTION_GET_CLASS (action)->create_tool_item (action);
944 gtk_activatable_set_use_action_appearance (GTK_ACTIVATABLE (button), TRUE);
945 gtk_activatable_set_related_action (GTK_ACTIVATABLE (button), action);
951 _gtk_action_add_to_proxy_list (GtkAction *action,
954 g_return_if_fail (GTK_IS_ACTION (action));
955 g_return_if_fail (GTK_IS_WIDGET (proxy));
957 GTK_ACTION_GET_CLASS (action)->connect_proxy (action, proxy);
961 _gtk_action_remove_from_proxy_list (GtkAction *action,
964 g_return_if_fail (GTK_IS_ACTION (action));
965 g_return_if_fail (GTK_IS_WIDGET (proxy));
967 GTK_ACTION_GET_CLASS (action)->disconnect_proxy (action, proxy);
971 * gtk_action_get_proxies:
972 * @action: the action object
974 * Returns the proxy widgets for an action.
975 * See also gtk_activatable_get_related_action().
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.
983 gtk_action_get_proxies (GtkAction *action)
985 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
987 return action->private_data->proxies;
991 * gtk_action_get_name:
992 * @action: the action object
994 * Returns the name of the action.
996 * Return value: the name of the action. The string belongs to GTK+ and should not
1002 gtk_action_get_name (GtkAction *action)
1004 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1006 return action->private_data->name;
1010 * gtk_action_is_sensitive:
1011 * @action: the action object
1013 * Returns whether the action is effectively sensitive.
1015 * Return value: %TRUE if the action and its associated action group
1016 * are both sensitive.
1021 gtk_action_is_sensitive (GtkAction *action)
1023 GtkActionPrivate *priv;
1024 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1026 priv = action->private_data;
1027 return priv->sensitive &&
1028 (priv->action_group == NULL ||
1029 gtk_action_group_get_sensitive (priv->action_group));
1033 * gtk_action_get_sensitive:
1034 * @action: the action object
1036 * Returns whether the action itself is sensitive. Note that this doesn't
1037 * necessarily mean effective sensitivity. See gtk_action_is_sensitive()
1040 * Return value: %TRUE if the action itself is sensitive.
1045 gtk_action_get_sensitive (GtkAction *action)
1047 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1049 return action->private_data->sensitive;
1053 * gtk_action_set_sensitive:
1054 * @action: the action object
1055 * @sensitive: %TRUE to make the action sensitive
1057 * Sets the ::sensitive property of the action to @sensitive. Note that
1058 * this doesn't necessarily mean effective sensitivity. See
1059 * gtk_action_is_sensitive()
1065 gtk_action_set_sensitive (GtkAction *action,
1068 g_return_if_fail (GTK_IS_ACTION (action));
1070 sensitive = sensitive != FALSE;
1072 if (action->private_data->sensitive != sensitive)
1074 action->private_data->sensitive = sensitive;
1076 g_object_notify (G_OBJECT (action), "sensitive");
1081 * gtk_action_is_visible:
1082 * @action: the action object
1084 * Returns whether the action is effectively visible.
1086 * Return value: %TRUE if the action and its associated action group
1092 gtk_action_is_visible (GtkAction *action)
1094 GtkActionPrivate *priv;
1095 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1097 priv = action->private_data;
1098 return priv->visible &&
1099 (priv->action_group == NULL ||
1100 gtk_action_group_get_visible (priv->action_group));
1104 * gtk_action_get_visible:
1105 * @action: the action object
1107 * Returns whether the action itself is visible. Note that this doesn't
1108 * necessarily mean effective visibility. See gtk_action_is_sensitive()
1111 * Return value: %TRUE if the action itself is visible.
1116 gtk_action_get_visible (GtkAction *action)
1118 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1120 return action->private_data->visible;
1124 * gtk_action_set_visible:
1125 * @action: the action object
1126 * @visible: %TRUE to make the action visible
1128 * Sets the ::visible property of the action to @visible. Note that
1129 * this doesn't necessarily mean effective visibility. See
1130 * gtk_action_is_visible()
1136 gtk_action_set_visible (GtkAction *action,
1139 g_return_if_fail (GTK_IS_ACTION (action));
1141 visible = visible != FALSE;
1143 if (action->private_data->visible != visible)
1145 action->private_data->visible = visible;
1147 g_object_notify (G_OBJECT (action), "visible");
1151 * gtk_action_set_is_important:
1152 * @action: the action object
1153 * @is_important: %TRUE to make the action important
1155 * Sets whether the action is important, this attribute is used
1156 * primarily by toolbar items to decide whether to show a label
1162 gtk_action_set_is_important (GtkAction *action,
1163 gboolean is_important)
1165 g_return_if_fail (GTK_IS_ACTION (action));
1167 is_important = is_important != FALSE;
1169 if (action->private_data->is_important != is_important)
1171 action->private_data->is_important = is_important;
1173 g_object_notify (G_OBJECT (action), "is-important");
1178 * gtk_action_get_is_important:
1179 * @action: a #GtkAction
1181 * Checks whether @action is important or not
1183 * Returns: whether @action is important
1188 gtk_action_get_is_important (GtkAction *action)
1190 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1192 return action->private_data->is_important;
1196 * gtk_action_set_always_show_image:
1197 * @action: a #GtkAction
1198 * @always_show: %TRUE if menuitem proxies should always show their image
1200 * Sets whether @action<!-- -->'s menu item proxies will ignore the
1201 * #GtkSettings:gtk-menu-images setting and always show their image, if available.
1203 * Use this if the menu item would be useless or hard to use
1204 * without their image.
1209 gtk_action_set_always_show_image (GtkAction *action,
1210 gboolean always_show)
1212 GtkActionPrivate *priv;
1214 g_return_if_fail (GTK_IS_ACTION (action));
1216 priv = action->private_data;
1218 always_show = always_show != FALSE;
1220 if (priv->always_show_image != always_show)
1222 priv->always_show_image = always_show;
1224 g_object_notify (G_OBJECT (action), "always-show-image");
1229 * gtk_action_get_always_show_image:
1230 * @action: a #GtkAction
1232 * Returns whether @action<!-- -->'s menu item proxies will ignore the
1233 * #GtkSettings:gtk-menu-images setting and always show their image,
1236 * Returns: %TRUE if the menu item proxies will always show their image
1241 gtk_action_get_always_show_image (GtkAction *action)
1243 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1245 return action->private_data->always_show_image;
1249 * gtk_action_set_label:
1250 * @action: a #GtkAction
1251 * @label: the label text to set
1253 * Sets the label of @action.
1258 gtk_action_set_label (GtkAction *action,
1263 g_return_if_fail (GTK_IS_ACTION (action));
1265 tmp = action->private_data->label;
1266 action->private_data->label = g_strdup (label);
1268 action->private_data->label_set = (action->private_data->label != NULL);
1269 /* if label is unset, then use the label from the stock item */
1270 if (!action->private_data->label_set && action->private_data->stock_id)
1272 GtkStockItem stock_item;
1274 if (gtk_stock_lookup (action->private_data->stock_id, &stock_item))
1275 action->private_data->label = g_strdup (stock_item.label);
1278 g_object_notify (G_OBJECT (action), "label");
1280 /* if short_label is unset, set short_label=label */
1281 if (!action->private_data->short_label_set)
1283 gtk_action_set_short_label (action, action->private_data->label);
1284 action->private_data->short_label_set = FALSE;
1289 * gtk_action_get_label:
1290 * @action: a #GtkAction
1292 * Gets the label text of @action.
1294 * Returns: the label text
1299 gtk_action_get_label (GtkAction *action)
1301 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1303 return action->private_data->label;
1307 * gtk_action_set_short_label:
1308 * @action: a #GtkAction
1309 * @short_label: the label text to set
1311 * Sets a shorter label text on @action.
1316 gtk_action_set_short_label (GtkAction *action,
1317 const gchar *short_label)
1321 g_return_if_fail (GTK_IS_ACTION (action));
1323 tmp = action->private_data->short_label;
1324 action->private_data->short_label = g_strdup (short_label);
1326 action->private_data->short_label_set = (action->private_data->short_label != NULL);
1327 /* if short_label is unset, then use the value of label */
1328 if (!action->private_data->short_label_set)
1329 action->private_data->short_label = g_strdup (action->private_data->label);
1331 g_object_notify (G_OBJECT (action), "short-label");
1335 * gtk_action_get_short_label:
1336 * @action: a #GtkAction
1338 * Gets the short label text of @action.
1340 * Returns: the short label text.
1345 gtk_action_get_short_label (GtkAction *action)
1347 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1349 return action->private_data->short_label;
1353 * gtk_action_set_visible_horizontal:
1354 * @action: a #GtkAction
1355 * @visible_horizontal: whether the action is visible horizontally
1357 * Sets whether @action is visible when horizontal
1362 gtk_action_set_visible_horizontal (GtkAction *action,
1363 gboolean visible_horizontal)
1365 g_return_if_fail (GTK_IS_ACTION (action));
1367 g_return_if_fail (GTK_IS_ACTION (action));
1369 visible_horizontal = visible_horizontal != FALSE;
1371 if (action->private_data->visible_horizontal != visible_horizontal)
1373 action->private_data->visible_horizontal = visible_horizontal;
1375 g_object_notify (G_OBJECT (action), "visible-horizontal");
1380 * gtk_action_get_visible_horizontal:
1381 * @action: a #GtkAction
1383 * Checks whether @action is visible when horizontal
1385 * Returns: whether @action is visible when horizontal
1390 gtk_action_get_visible_horizontal (GtkAction *action)
1392 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1394 return action->private_data->visible_horizontal;
1398 * gtk_action_set_visible_vertical:
1399 * @action: a #GtkAction
1400 * @visible_vertical: whether the action is visible vertically
1402 * Sets whether @action is visible when vertical
1407 gtk_action_set_visible_vertical (GtkAction *action,
1408 gboolean visible_vertical)
1410 g_return_if_fail (GTK_IS_ACTION (action));
1412 g_return_if_fail (GTK_IS_ACTION (action));
1414 visible_vertical = visible_vertical != FALSE;
1416 if (action->private_data->visible_vertical != visible_vertical)
1418 action->private_data->visible_vertical = visible_vertical;
1420 g_object_notify (G_OBJECT (action), "visible-vertical");
1425 * gtk_action_get_visible_vertical:
1426 * @action: a #GtkAction
1428 * Checks whether @action is visible when horizontal
1430 * Returns: whether @action is visible when horizontal
1435 gtk_action_get_visible_vertical (GtkAction *action)
1437 g_return_val_if_fail (GTK_IS_ACTION (action), FALSE);
1439 return action->private_data->visible_vertical;
1443 * gtk_action_set_tooltip:
1444 * @action: a #GtkAction
1445 * @tooltip: the tooltip text
1447 * Sets the tooltip text on @action
1452 gtk_action_set_tooltip (GtkAction *action,
1453 const gchar *tooltip)
1457 g_return_if_fail (GTK_IS_ACTION (action));
1459 tmp = action->private_data->tooltip;
1460 action->private_data->tooltip = g_strdup (tooltip);
1463 g_object_notify (G_OBJECT (action), "tooltip");
1467 * gtk_action_get_tooltip:
1468 * @action: a #GtkAction
1470 * Gets the tooltip text of @action.
1472 * Returns: the tooltip text
1477 gtk_action_get_tooltip (GtkAction *action)
1479 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1481 return action->private_data->tooltip;
1485 * gtk_action_set_stock_id:
1486 * @action: a #GtkAction
1487 * @stock_id: the stock id
1489 * Sets the stock id on @action
1494 gtk_action_set_stock_id (GtkAction *action,
1495 const gchar *stock_id)
1499 g_return_if_fail (GTK_IS_ACTION (action));
1501 g_return_if_fail (GTK_IS_ACTION (action));
1503 tmp = action->private_data->stock_id;
1504 action->private_data->stock_id = g_strdup (stock_id);
1507 g_object_notify (G_OBJECT (action), "stock-id");
1509 /* update label and short_label if appropriate */
1510 if (!action->private_data->label_set)
1512 GtkStockItem stock_item;
1514 if (action->private_data->stock_id &&
1515 gtk_stock_lookup (action->private_data->stock_id, &stock_item))
1516 gtk_action_set_label (action, stock_item.label);
1518 gtk_action_set_label (action, NULL);
1520 action->private_data->label_set = FALSE;
1525 * gtk_action_get_stock_id:
1526 * @action: a #GtkAction
1528 * Gets the stock id of @action.
1530 * Returns: the stock id
1535 gtk_action_get_stock_id (GtkAction *action)
1537 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1539 return action->private_data->stock_id;
1543 * gtk_action_set_icon_name:
1544 * @action: a #GtkAction
1545 * @icon_name: the icon name to set
1547 * Sets the icon name on @action
1552 gtk_action_set_icon_name (GtkAction *action,
1553 const gchar *icon_name)
1557 g_return_if_fail (GTK_IS_ACTION (action));
1559 tmp = action->private_data->icon_name;
1560 action->private_data->icon_name = g_strdup (icon_name);
1563 g_object_notify (G_OBJECT (action), "icon-name");
1567 * gtk_action_get_icon_name:
1568 * @action: a #GtkAction
1570 * Gets the icon name of @action.
1572 * Returns: the icon name
1577 gtk_action_get_icon_name (GtkAction *action)
1579 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1581 return action->private_data->icon_name;
1585 * gtk_action_set_gicon:
1586 * @action: a #GtkAction
1587 * @icon: the #GIcon to set
1589 * Sets the icon of @action.
1594 gtk_action_set_gicon (GtkAction *action,
1597 g_return_if_fail (GTK_IS_ACTION (action));
1599 if (action->private_data->gicon)
1600 g_object_unref (action->private_data->gicon);
1602 action->private_data->gicon = icon;
1604 if (action->private_data->gicon)
1605 g_object_ref (action->private_data->gicon);
1607 g_object_notify (G_OBJECT (action), "gicon");
1611 * gtk_action_get_gicon:
1612 * @action: a #GtkAction
1614 * Gets the gicon of @action.
1616 * Returns: (transfer none): The action's #GIcon if one is set.
1621 gtk_action_get_gicon (GtkAction *action)
1623 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1625 return action->private_data->gicon;
1629 closure_accel_activate (GClosure *closure,
1630 GValue *return_value,
1631 guint n_param_values,
1632 const GValue *param_values,
1633 gpointer invocation_hint,
1634 gpointer marshal_data)
1636 if (gtk_action_is_sensitive (GTK_ACTION (closure->data)))
1638 _gtk_action_emit_activate (GTK_ACTION (closure->data));
1640 /* we handled the accelerator */
1641 g_value_set_boolean (return_value, TRUE);
1646 gtk_action_set_action_group (GtkAction *action,
1647 GtkActionGroup *action_group)
1649 if (action->private_data->action_group == NULL)
1650 g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));
1652 g_return_if_fail (action_group == NULL);
1654 action->private_data->action_group = action_group;
1658 * gtk_action_set_accel_path:
1659 * @action: the action object
1660 * @accel_path: the accelerator path
1662 * Sets the accel path for this action. All proxy widgets associated
1663 * with the action will have this accel path, so that their
1664 * accelerators are consistent.
1666 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
1667 * pass a static string, you can save some memory by interning it first with
1668 * g_intern_static_string().
1673 gtk_action_set_accel_path (GtkAction *action,
1674 const gchar *accel_path)
1676 g_return_if_fail (GTK_IS_ACTION (action));
1678 action->private_data->accel_quark = g_quark_from_string (accel_path);
1682 * gtk_action_get_accel_path:
1683 * @action: the action object
1685 * Returns the accel path for this action.
1689 * Returns: the accel path for this action, or %NULL
1690 * if none is set. The returned string is owned by GTK+
1691 * and must not be freed or modified.
1694 gtk_action_get_accel_path (GtkAction *action)
1696 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1698 if (action->private_data->accel_quark)
1699 return g_quark_to_string (action->private_data->accel_quark);
1705 * gtk_action_get_accel_closure:
1706 * @action: the action object
1708 * Returns the accel closure for this action.
1712 * Returns: (transfer none): the accel closure for this action. The
1713 * returned closure is owned by GTK+ and must not be unreffed
1717 gtk_action_get_accel_closure (GtkAction *action)
1719 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1721 return action->private_data->accel_closure;
1726 * gtk_action_set_accel_group:
1727 * @action: the action object
1728 * @accel_group: (allow-none): a #GtkAccelGroup or %NULL
1730 * Sets the #GtkAccelGroup in which the accelerator for this action
1731 * will be installed.
1736 gtk_action_set_accel_group (GtkAction *action,
1737 GtkAccelGroup *accel_group)
1739 g_return_if_fail (GTK_IS_ACTION (action));
1740 g_return_if_fail (accel_group == NULL || GTK_IS_ACCEL_GROUP (accel_group));
1743 g_object_ref (accel_group);
1744 if (action->private_data->accel_group)
1745 g_object_unref (action->private_data->accel_group);
1747 action->private_data->accel_group = accel_group;
1751 * gtk_action_connect_accelerator:
1752 * @action: a #GtkAction
1754 * Installs the accelerator for @action if @action has an
1755 * accel path and group. See gtk_action_set_accel_path() and
1756 * gtk_action_set_accel_group()
1758 * Since multiple proxies may independently trigger the installation
1759 * of the accelerator, the @action counts the number of times this
1760 * function has been called and doesn't remove the accelerator until
1761 * gtk_action_disconnect_accelerator() has been called as many times.
1766 gtk_action_connect_accelerator (GtkAction *action)
1768 g_return_if_fail (GTK_IS_ACTION (action));
1770 if (!action->private_data->accel_quark ||
1771 !action->private_data->accel_group)
1774 if (action->private_data->accel_count == 0)
1776 const gchar *accel_path =
1777 g_quark_to_string (action->private_data->accel_quark);
1779 gtk_accel_group_connect_by_path (action->private_data->accel_group,
1781 action->private_data->accel_closure);
1784 action->private_data->accel_count++;
1788 * gtk_action_disconnect_accelerator:
1789 * @action: a #GtkAction
1791 * Undoes the effect of one call to gtk_action_connect_accelerator().
1796 gtk_action_disconnect_accelerator (GtkAction *action)
1798 g_return_if_fail (GTK_IS_ACTION (action));
1800 if (!action->private_data->accel_quark ||
1801 !action->private_data->accel_group)
1804 action->private_data->accel_count--;
1806 if (action->private_data->accel_count == 0)
1807 gtk_accel_group_disconnect (action->private_data->accel_group,
1808 action->private_data->accel_closure);
1812 * gtk_action_create_menu:
1813 * @action: a #GtkAction
1815 * If @action provides a #GtkMenu widget as a submenu for the menu
1816 * item or the toolbar item it creates, this function returns an
1817 * instance of that menu.
1819 * Return value: (transfer none): the menu item provided by the
1825 gtk_action_create_menu (GtkAction *action)
1827 g_return_val_if_fail (GTK_IS_ACTION (action), NULL);
1829 if (GTK_ACTION_GET_CLASS (action)->create_menu)
1830 return GTK_ACTION_GET_CLASS (action)->create_menu (action);