3 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
5 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 #include "gtktoolbutton.h"
25 #include "gtkbutton.h"
27 #include "gtkiconfactory.h"
29 #include "gtkimagemenuitem.h"
34 #include "gtktoolbar.h"
35 #include "gtkactivatable.h"
36 #include "gtkprivate.h"
40 #define MENU_ID "gtk-tool-button-menu-id"
57 static void gtk_tool_button_init (GtkToolButton *button,
58 GtkToolButtonClass *klass);
59 static void gtk_tool_button_class_init (GtkToolButtonClass *klass);
60 static void gtk_tool_button_set_property (GObject *object,
64 static void gtk_tool_button_get_property (GObject *object,
68 static void gtk_tool_button_property_notify (GObject *object,
70 static void gtk_tool_button_finalize (GObject *object);
72 static void gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item);
73 static gboolean gtk_tool_button_create_menu_proxy (GtkToolItem *item);
74 static void button_clicked (GtkWidget *widget,
75 GtkToolButton *button);
76 static void gtk_tool_button_style_set (GtkWidget *widget,
77 GtkStyle *prev_style);
79 static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);
81 static void gtk_tool_button_activatable_interface_init (GtkActivatableIface *iface);
82 static void gtk_tool_button_update (GtkActivatable *activatable,
84 const gchar *property_name);
85 static void gtk_tool_button_sync_action_properties (GtkActivatable *activatable,
89 struct _GtkToolButtonPrivate
96 GtkWidget *label_widget;
97 GtkWidget *icon_widget;
99 GtkSizeGroup *text_size_group;
101 guint use_underline : 1;
102 guint contents_invalid : 1;
105 static GObjectClass *parent_class = NULL;
106 static GtkActivatableIface *parent_activatable_iface;
107 static guint toolbutton_signals[LAST_SIGNAL] = { 0 };
111 gtk_tool_button_get_type (void)
113 static GType type = 0;
117 const GInterfaceInfo activatable_info =
119 (GInterfaceInitFunc) gtk_tool_button_activatable_interface_init,
120 (GInterfaceFinalizeFunc) NULL,
124 type = g_type_register_static_simple (GTK_TYPE_TOOL_ITEM,
126 sizeof (GtkToolButtonClass),
127 (GClassInitFunc) gtk_tool_button_class_init,
128 sizeof (GtkToolButton),
129 (GInstanceInitFunc) gtk_tool_button_init,
132 g_type_add_interface_static (type, GTK_TYPE_ACTIVATABLE,
139 gtk_tool_button_class_init (GtkToolButtonClass *klass)
141 GObjectClass *object_class;
142 GtkWidgetClass *widget_class;
143 GtkToolItemClass *tool_item_class;
145 parent_class = g_type_class_peek_parent (klass);
147 object_class = (GObjectClass *)klass;
148 widget_class = (GtkWidgetClass *)klass;
149 tool_item_class = (GtkToolItemClass *)klass;
151 object_class->set_property = gtk_tool_button_set_property;
152 object_class->get_property = gtk_tool_button_get_property;
153 object_class->notify = gtk_tool_button_property_notify;
154 object_class->finalize = gtk_tool_button_finalize;
156 widget_class->style_set = gtk_tool_button_style_set;
158 tool_item_class->create_menu_proxy = gtk_tool_button_create_menu_proxy;
159 tool_item_class->toolbar_reconfigured = gtk_tool_button_toolbar_reconfigured;
161 klass->button_type = GTK_TYPE_BUTTON;
163 /* Properties are interpreted like this:
165 * - if the tool button has an icon_widget, then that widget
166 * will be used as the icon. Otherwise, if the tool button
167 * has a stock id, the corresponding stock icon will be
168 * used. Otherwise, if the tool button has an icon name,
169 * the corresponding icon from the theme will be used.
170 * Otherwise, the tool button will not have an icon.
172 * - if the tool button has a label_widget then that widget
173 * will be used as the label. Otherwise, if the tool button
174 * has a label text, that text will be used as label. Otherwise,
175 * if the toolbutton has a stock id, the corresponding text
176 * will be used as label. Otherwise, if the tool button has
177 * an icon name, the corresponding icon name from the theme will
178 * be used. Otherwise, the toolbutton will have an empty label.
180 * - The use_underline property only has an effect when the label
181 * on the toolbutton comes from the label property (ie. not from
182 * label_widget or from stock_id).
184 * In that case, if use_underline is set,
186 * - underscores are removed from the label text before
187 * the label is shown on the toolbutton unless the
188 * underscore is followed by another underscore
190 * - an underscore indicates that the next character when
191 * used in the overflow menu should be used as a
194 * In short: use_underline = TRUE means that the label text has
195 * the form "_Open" and the toolbar should take appropriate
199 g_object_class_install_property (object_class,
201 g_param_spec_string ("label",
203 P_("Text to show in the item."),
205 GTK_PARAM_READWRITE));
206 g_object_class_install_property (object_class,
208 g_param_spec_boolean ("use-underline",
210 P_("If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu"),
212 GTK_PARAM_READWRITE));
213 g_object_class_install_property (object_class,
215 g_param_spec_object ("label-widget",
217 P_("Widget to use as the item label"),
219 GTK_PARAM_READWRITE));
220 g_object_class_install_property (object_class,
222 g_param_spec_string ("stock-id",
224 P_("The stock icon displayed on the item"),
226 GTK_PARAM_READWRITE));
229 * GtkToolButton:icon-name:
231 * The name of the themed icon displayed on the item.
232 * This property only has an effect if not overridden by "label",
233 * "icon_widget" or "stock_id" properties.
237 g_object_class_install_property (object_class,
239 g_param_spec_string ("icon-name",
241 P_("The name of the themed icon displayed on the item"),
243 GTK_PARAM_READWRITE));
244 g_object_class_install_property (object_class,
246 g_param_spec_object ("icon-widget",
248 P_("Icon widget to display in the item"),
250 GTK_PARAM_READWRITE));
253 * GtkButton:icon-spacing:
255 * Spacing in pixels between the icon and label.
259 gtk_widget_class_install_style_property (widget_class,
260 g_param_spec_int ("icon-spacing",
262 P_("Spacing in pixels between the icon and label"),
266 GTK_PARAM_READWRITE));
269 * GtkToolButton::clicked:
270 * @toolbutton: the object that emitted the signal
272 * This signal is emitted when the tool button is clicked with the mouse
273 * or activated with the keyboard.
275 toolbutton_signals[CLICKED] =
276 g_signal_new (I_("clicked"),
277 G_OBJECT_CLASS_TYPE (klass),
278 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
279 G_STRUCT_OFFSET (GtkToolButtonClass, clicked),
281 g_cclosure_marshal_VOID__VOID,
284 g_type_class_add_private (object_class, sizeof (GtkToolButtonPrivate));
288 gtk_tool_button_init (GtkToolButton *button,
289 GtkToolButtonClass *klass)
291 GtkToolItem *toolitem = GTK_TOOL_ITEM (button);
293 button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
294 GTK_TYPE_TOOL_BUTTON,
295 GtkToolButtonPrivate);
297 button->priv->contents_invalid = TRUE;
299 gtk_tool_item_set_homogeneous (toolitem, TRUE);
302 button->priv->button = g_object_new (klass->button_type, NULL);
303 gtk_button_set_focus_on_click (GTK_BUTTON (button->priv->button), FALSE);
304 g_signal_connect_object (button->priv->button, "clicked",
305 G_CALLBACK (button_clicked), button, 0);
307 gtk_container_add (GTK_CONTAINER (button), button->priv->button);
308 gtk_widget_show (button->priv->button);
312 gtk_tool_button_construct_contents (GtkToolItem *tool_item)
314 GtkToolButton *button = GTK_TOOL_BUTTON (tool_item);
316 GtkWidget *label = NULL;
317 GtkWidget *icon = NULL;
318 GtkToolbarStyle style;
319 gboolean need_label = FALSE;
320 gboolean need_icon = FALSE;
321 GtkIconSize icon_size;
322 GtkWidget *box = NULL;
324 GtkOrientation text_orientation = GTK_ORIENTATION_HORIZONTAL;
325 GtkSizeGroup *size_group = NULL;
327 button->priv->contents_invalid = FALSE;
329 gtk_widget_style_get (GTK_WIDGET (tool_item),
330 "icon-spacing", &icon_spacing,
333 if (button->priv->icon_widget && button->priv->icon_widget->parent)
335 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
336 button->priv->icon_widget);
339 if (button->priv->label_widget && button->priv->label_widget->parent)
341 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
342 button->priv->label_widget);
345 child = gtk_bin_get_child (GTK_BIN (button->priv->button));
348 /* Note: we are not destroying the label_widget or icon_widget
349 * here because they were removed from their containers above
351 gtk_widget_destroy (child);
354 style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
356 if (style != GTK_TOOLBAR_TEXT)
359 if (style != GTK_TOOLBAR_ICONS && style != GTK_TOOLBAR_BOTH_HORIZ)
362 if (style == GTK_TOOLBAR_BOTH_HORIZ &&
363 (gtk_tool_item_get_is_important (GTK_TOOL_ITEM (button)) ||
364 gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL ||
365 gtk_tool_item_get_text_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL))
370 if (style == GTK_TOOLBAR_ICONS && button->priv->icon_widget == NULL &&
371 button->priv->stock_id == NULL && button->priv->icon_name == NULL)
375 style = GTK_TOOLBAR_TEXT;
378 if (style == GTK_TOOLBAR_TEXT && button->priv->label_widget == NULL &&
379 button->priv->stock_id == NULL && button->priv->label_text == NULL)
383 style = GTK_TOOLBAR_ICONS;
388 if (button->priv->label_widget)
390 label = button->priv->label_widget;
394 GtkStockItem stock_item;
398 if (button->priv->label_text)
400 label_text = button->priv->label_text;
401 elide = button->priv->use_underline;
403 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
405 label_text = stock_item.label;
415 label_text = _gtk_toolbar_elide_underscores (label_text);
417 label_text = g_strdup (label_text);
419 label = gtk_label_new (label_text);
423 gtk_widget_show (label);
426 if (GTK_IS_LABEL (label))
428 gtk_label_set_ellipsize (GTK_LABEL (label),
429 gtk_tool_item_get_ellipsize_mode (GTK_TOOL_ITEM (button)));
430 text_orientation = gtk_tool_item_get_text_orientation (GTK_TOOL_ITEM (button));
431 if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
433 gtk_label_set_angle (GTK_LABEL (label), 0);
434 gtk_misc_set_alignment (GTK_MISC (label),
435 gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)),
440 gtk_label_set_ellipsize (GTK_LABEL (label), PANGO_ELLIPSIZE_NONE);
441 if (gtk_widget_get_direction (GTK_WIDGET (tool_item)) == GTK_TEXT_DIR_RTL)
442 gtk_label_set_angle (GTK_LABEL (label), -90);
444 gtk_label_set_angle (GTK_LABEL (label), 90);
445 gtk_misc_set_alignment (GTK_MISC (label),
447 1 - gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)));
452 icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
455 if (button->priv->icon_widget)
457 icon = button->priv->icon_widget;
459 if (GTK_IS_IMAGE (icon))
461 g_object_set (button->priv->icon_widget,
462 "icon-size", icon_size,
466 else if (button->priv->stock_id &&
467 gtk_icon_factory_lookup_default (button->priv->stock_id))
469 icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
470 gtk_widget_show (icon);
472 else if (button->priv->icon_name)
474 icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
475 gtk_widget_show (icon);
478 if (GTK_IS_MISC (icon) && text_orientation == GTK_ORIENTATION_HORIZONTAL)
479 gtk_misc_set_alignment (GTK_MISC (icon),
480 1.0 - gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)),
482 else if (GTK_IS_MISC (icon))
483 gtk_misc_set_alignment (GTK_MISC (icon),
485 gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)));
489 size_group = gtk_tool_item_get_text_size_group (GTK_TOOL_ITEM (button));
490 if (size_group != NULL)
491 gtk_size_group_add_widget (size_group, icon);
497 case GTK_TOOLBAR_ICONS:
499 gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
502 case GTK_TOOLBAR_BOTH:
503 if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
504 box = gtk_vbox_new (FALSE, icon_spacing);
506 box = gtk_hbox_new (FALSE, icon_spacing);
508 gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
509 gtk_box_pack_end (GTK_BOX (box), label, FALSE, TRUE, 0);
510 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
513 case GTK_TOOLBAR_BOTH_HORIZ:
514 if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
516 box = gtk_hbox_new (FALSE, icon_spacing);
518 gtk_box_pack_start (GTK_BOX (box), icon, label? FALSE : TRUE, TRUE, 0);
520 gtk_box_pack_end (GTK_BOX (box), label, TRUE, TRUE, 0);
524 box = gtk_vbox_new (FALSE, icon_spacing);
526 gtk_box_pack_end (GTK_BOX (box), icon, label ? FALSE : TRUE, TRUE, 0);
528 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
530 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
533 case GTK_TOOLBAR_TEXT:
534 gtk_container_add (GTK_CONTAINER (button->priv->button), label);
539 gtk_widget_show (box);
541 gtk_button_set_relief (GTK_BUTTON (button->priv->button),
542 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
544 gtk_tool_item_rebuild_menu (tool_item);
546 gtk_widget_queue_resize (GTK_WIDGET (button));
550 gtk_tool_button_set_property (GObject *object,
555 GtkToolButton *button = GTK_TOOL_BUTTON (object);
560 gtk_tool_button_set_label (button, g_value_get_string (value));
562 case PROP_USE_UNDERLINE:
563 gtk_tool_button_set_use_underline (button, g_value_get_boolean (value));
565 case PROP_LABEL_WIDGET:
566 gtk_tool_button_set_label_widget (button, g_value_get_object (value));
569 gtk_tool_button_set_stock_id (button, g_value_get_string (value));
572 gtk_tool_button_set_icon_name (button, g_value_get_string (value));
574 case PROP_ICON_WIDGET:
575 gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
578 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
584 gtk_tool_button_property_notify (GObject *object,
587 GtkToolButton *button = GTK_TOOL_BUTTON (object);
589 if (button->priv->contents_invalid ||
590 strcmp ("is-important", pspec->name) == 0)
591 gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
593 if (parent_class->notify)
594 parent_class->notify (object, pspec);
598 gtk_tool_button_get_property (GObject *object,
603 GtkToolButton *button = GTK_TOOL_BUTTON (object);
608 g_value_set_string (value, gtk_tool_button_get_label (button));
610 case PROP_LABEL_WIDGET:
611 g_value_set_object (value, gtk_tool_button_get_label_widget (button));
613 case PROP_USE_UNDERLINE:
614 g_value_set_boolean (value, gtk_tool_button_get_use_underline (button));
617 g_value_set_string (value, button->priv->stock_id);
620 g_value_set_string (value, button->priv->icon_name);
622 case PROP_ICON_WIDGET:
623 g_value_set_object (value, button->priv->icon_widget);
626 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
632 gtk_tool_button_finalize (GObject *object)
634 GtkToolButton *button = GTK_TOOL_BUTTON (object);
636 g_free (button->priv->stock_id);
637 g_free (button->priv->icon_name);
638 g_free (button->priv->label_text);
640 if (button->priv->label_widget)
641 g_object_unref (button->priv->label_widget);
643 if (button->priv->icon_widget)
644 g_object_unref (button->priv->icon_widget);
646 parent_class->finalize (object);
650 clone_image_menu_size (GtkImage *image, GtkSettings *settings)
652 GtkImageType storage_type = gtk_image_get_storage_type (image);
654 if (storage_type == GTK_IMAGE_STOCK)
657 gtk_image_get_stock (image, &stock_id, NULL);
658 return gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
660 else if (storage_type == GTK_IMAGE_ICON_NAME)
662 const gchar *icon_name;
663 gtk_image_get_icon_name (image, &icon_name, NULL);
664 return gtk_image_new_from_icon_name (icon_name, GTK_ICON_SIZE_MENU);
666 else if (storage_type == GTK_IMAGE_ICON_SET)
668 GtkIconSet *icon_set;
669 gtk_image_get_icon_set (image, &icon_set, NULL);
670 return gtk_image_new_from_icon_set (icon_set, GTK_ICON_SIZE_MENU);
672 else if (storage_type == GTK_IMAGE_GICON)
675 gtk_image_get_gicon (image, &icon, NULL);
676 return gtk_image_new_from_gicon (icon, GTK_ICON_SIZE_MENU);
678 else if (storage_type == GTK_IMAGE_PIXBUF)
683 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
686 GdkPixbuf *src_pixbuf, *dest_pixbuf;
687 GtkWidget *cloned_image;
689 src_pixbuf = gtk_image_get_pixbuf (image);
690 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
691 GDK_INTERP_BILINEAR);
693 cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
694 g_object_unref (dest_pixbuf);
704 gtk_tool_button_create_menu_proxy (GtkToolItem *item)
706 GtkToolButton *button = GTK_TOOL_BUTTON (item);
707 GtkWidget *menu_item;
708 GtkWidget *menu_image = NULL;
709 GtkStockItem stock_item;
710 gboolean use_mnemonic = TRUE;
713 if (_gtk_tool_item_create_menu_proxy (item))
716 if (GTK_IS_LABEL (button->priv->label_widget))
718 label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
719 use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
721 else if (button->priv->label_text)
723 label = button->priv->label_text;
724 use_mnemonic = button->priv->use_underline;
726 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
728 label = stock_item.label;
736 menu_item = gtk_image_menu_item_new_with_mnemonic (label);
738 menu_item = gtk_image_menu_item_new_with_label (label);
740 if (GTK_IS_IMAGE (button->priv->icon_widget))
742 menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget),
743 gtk_widget_get_settings (GTK_WIDGET (button)));
745 else if (button->priv->stock_id)
747 menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
751 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item), menu_image);
753 g_signal_connect_closure_by_id (menu_item,
754 g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
755 g_cclosure_new_object_swap (G_CALLBACK (gtk_button_clicked),
756 G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
759 gtk_tool_item_set_proxy_menu_item (GTK_TOOL_ITEM (button), MENU_ID, menu_item);
765 button_clicked (GtkWidget *widget,
766 GtkToolButton *button)
770 action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (button));
773 gtk_action_activate (action);
775 g_signal_emit_by_name (button, "clicked");
779 gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item)
781 gtk_tool_button_construct_contents (tool_item);
785 gtk_tool_button_update_icon_spacing (GtkToolButton *button)
790 box = gtk_bin_get_child (GTK_BIN (button->priv->button));
791 if (GTK_IS_BOX (box))
793 gtk_widget_style_get (GTK_WIDGET (button),
794 "icon-spacing", &spacing,
796 gtk_box_set_spacing (GTK_BOX (box), spacing);
801 gtk_tool_button_style_set (GtkWidget *widget,
802 GtkStyle *prev_style)
804 gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
808 gtk_tool_button_activatable_interface_init (GtkActivatableIface *iface)
810 parent_activatable_iface = g_type_interface_peek_parent (iface);
811 iface->update = gtk_tool_button_update;
812 iface->sync_action_properties = gtk_tool_button_sync_action_properties;
816 gtk_tool_button_update (GtkActivatable *activatable,
818 const gchar *property_name)
820 GtkToolButton *button;
823 parent_activatable_iface->update (activatable, action, property_name);
825 if (!gtk_activatable_get_use_action_appearance (activatable))
828 button = GTK_TOOL_BUTTON (activatable);
830 if (strcmp (property_name, "short-label") == 0)
831 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
832 else if (strcmp (property_name, "stock-id") == 0)
833 gtk_tool_button_set_stock_id (button, gtk_action_get_stock_id (action));
834 else if (strcmp (property_name, "gicon") == 0)
836 const gchar *stock_id = gtk_action_get_stock_id (action);
837 GIcon *icon = gtk_action_get_gicon (action);
838 GtkIconSize icon_size = GTK_ICON_SIZE_BUTTON;
840 if ((stock_id && gtk_icon_factory_lookup_default (stock_id)) || !icon)
844 image = gtk_tool_button_get_icon_widget (button);
845 icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
848 image = gtk_image_new ();
851 gtk_tool_button_set_icon_widget (button, image);
852 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);
855 else if (strcmp (property_name, "icon-name") == 0)
856 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
860 gtk_tool_button_sync_action_properties (GtkActivatable *activatable,
863 GtkToolButton *button;
865 const gchar *stock_id;
867 parent_activatable_iface->sync_action_properties (activatable, action);
872 if (!gtk_activatable_get_use_action_appearance (activatable))
875 button = GTK_TOOL_BUTTON (activatable);
876 stock_id = gtk_action_get_stock_id (action);
878 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
879 gtk_tool_button_set_use_underline (button, TRUE);
880 gtk_tool_button_set_stock_id (button, stock_id);
881 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
883 if (stock_id && gtk_icon_factory_lookup_default (stock_id))
884 gtk_tool_button_set_icon_widget (button, NULL);
885 else if ((icon = gtk_action_get_gicon (action)) != NULL)
887 GtkIconSize icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
888 GtkWidget *image = gtk_tool_button_get_icon_widget (button);
892 image = gtk_image_new ();
893 gtk_widget_show (image);
894 gtk_tool_button_set_icon_widget (button, image);
897 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);
899 else if (gtk_action_get_icon_name (action))
900 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
902 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
906 * gtk_tool_button_new_from_stock:
907 * @stock_id: the name of the stock item
909 * Creates a new #GtkToolButton containing the image and text from a
910 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
911 * and #GTK_STOCK_APPLY.
913 * It is an error if @stock_id is not a name of a stock item.
915 * Return value: A new #GtkToolButton
920 gtk_tool_button_new_from_stock (const gchar *stock_id)
922 GtkToolButton *button;
924 g_return_val_if_fail (stock_id != NULL, NULL);
926 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
927 "stock-id", stock_id,
930 return GTK_TOOL_ITEM (button);
934 * gtk_tool_button_new:
935 * @label: (allow-none): a string that will be used as label, or %NULL
936 * @icon_widget: (allow-none): a #GtkMisc widget that will be used as icon widget, or %NULL
938 * Creates a new %GtkToolButton using @icon_widget as icon and @label as
941 * Return value: A new #GtkToolButton
946 gtk_tool_button_new (GtkWidget *icon_widget,
949 GtkToolButton *button;
951 g_return_val_if_fail (icon_widget == NULL || GTK_IS_MISC (icon_widget), NULL);
953 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
955 "icon-widget", icon_widget,
958 return GTK_TOOL_ITEM (button);
962 * gtk_tool_button_set_label:
963 * @button: a #GtkToolButton
964 * @label: (allow-none): a string that will be used as label, or %NULL.
966 * Sets @label as the label used for the tool button. The "label" property
967 * only has an effect if not overridden by a non-%NULL "label_widget" property.
968 * If both the "label_widget" and "label" properties are %NULL, the label
969 * is determined by the "stock_id" property. If the "stock_id" property is also
970 * %NULL, @button will not have a label.
975 gtk_tool_button_set_label (GtkToolButton *button,
980 AtkObject *accessible;
982 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
984 old_label = button->priv->label_text;
986 button->priv->label_text = g_strdup (label);
987 button->priv->contents_invalid = TRUE;
991 elided_label = _gtk_toolbar_elide_underscores (label);
992 accessible = gtk_widget_get_accessible (GTK_WIDGET (button->priv->button));
993 atk_object_set_name (accessible, elided_label);
994 g_free (elided_label);
999 g_object_notify (G_OBJECT (button), "label");
1003 * gtk_tool_button_get_label:
1004 * @button: a #GtkToolButton
1006 * Returns the label used by the tool button, or %NULL if the tool button
1007 * doesn't have a label. or uses a the label from a stock item. The returned
1008 * string is owned by GTK+, and must not be modified or freed.
1010 * Return value: The label, or %NULL
1014 G_CONST_RETURN gchar *
1015 gtk_tool_button_get_label (GtkToolButton *button)
1017 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1019 return button->priv->label_text;
1023 * gtk_tool_button_set_use_underline:
1024 * @button: a #GtkToolButton
1025 * @use_underline: whether the button label has the form "_Open"
1027 * If set, an underline in the label property indicates that the next character
1028 * should be used for the mnemonic accelerator key in the overflow menu. For
1029 * example, if the label property is "_Open" and @use_underline is %TRUE,
1030 * the label on the tool button will be "Open" and the item on the overflow
1031 * menu will have an underlined 'O'.
1033 * Labels shown on tool buttons never have mnemonics on them; this property
1034 * only affects the menu item on the overflow menu.
1039 gtk_tool_button_set_use_underline (GtkToolButton *button,
1040 gboolean use_underline)
1042 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1044 use_underline = use_underline != FALSE;
1046 if (use_underline != button->priv->use_underline)
1048 button->priv->use_underline = use_underline;
1049 button->priv->contents_invalid = TRUE;
1051 g_object_notify (G_OBJECT (button), "use-underline");
1056 * gtk_tool_button_get_use_underline:
1057 * @button: a #GtkToolButton
1059 * Returns whether underscores in the label property are used as mnemonics
1060 * on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
1062 * Return value: %TRUE if underscores in the label property are used as
1063 * mnemonics on menu items on the overflow menu.
1068 gtk_tool_button_get_use_underline (GtkToolButton *button)
1070 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);
1072 return button->priv->use_underline;
1076 * gtk_tool_button_set_stock_id:
1077 * @button: a #GtkToolButton
1078 * @stock_id: (allow-none): a name of a stock item, or %NULL
1080 * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
1081 * The stock_id property only has an effect if not
1082 * overridden by non-%NULL "label" and "icon_widget" properties.
1087 gtk_tool_button_set_stock_id (GtkToolButton *button,
1088 const gchar *stock_id)
1090 gchar *old_stock_id;
1092 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1094 old_stock_id = button->priv->stock_id;
1096 button->priv->stock_id = g_strdup (stock_id);
1097 button->priv->contents_invalid = TRUE;
1099 g_free (old_stock_id);
1101 g_object_notify (G_OBJECT (button), "stock-id");
1105 * gtk_tool_button_get_stock_id:
1106 * @button: a #GtkToolButton
1108 * Returns the name of the stock item. See gtk_tool_button_set_stock_id().
1109 * The returned string is owned by GTK+ and must not be freed or modifed.
1111 * Return value: the name of the stock item for @button.
1115 G_CONST_RETURN gchar *
1116 gtk_tool_button_get_stock_id (GtkToolButton *button)
1118 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1120 return button->priv->stock_id;
1124 * gtk_tool_button_set_icon_name
1125 * @button: a #GtkToolButton
1126 * @icon_name: (allow-none): the name of the themed icon
1128 * Sets the icon for the tool button from a named themed icon.
1129 * See the docs for #GtkIconTheme for more details.
1130 * The "icon_name" property only has an effect if not
1131 * overridden by non-%NULL "label", "icon_widget" and "stock_id"
1137 gtk_tool_button_set_icon_name (GtkToolButton *button,
1138 const gchar *icon_name)
1140 gchar *old_icon_name;
1142 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1144 old_icon_name = button->priv->icon_name;
1146 button->priv->icon_name = g_strdup (icon_name);
1147 button->priv->contents_invalid = TRUE;
1149 g_free (old_icon_name);
1151 g_object_notify (G_OBJECT (button), "icon-name");
1155 * gtk_tool_button_get_icon_name
1156 * @button: a #GtkToolButton
1158 * Returns the name of the themed icon for the tool button,
1159 * see gtk_tool_button_set_icon_name().
1161 * Returns: the icon name or %NULL if the tool button has
1166 G_CONST_RETURN gchar*
1167 gtk_tool_button_get_icon_name (GtkToolButton *button)
1169 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1171 return button->priv->icon_name;
1175 * gtk_tool_button_set_icon_widget:
1176 * @button: a #GtkToolButton
1177 * @icon_widget: (allow-none): the widget used as icon, or %NULL
1179 * Sets @icon as the widget used as icon on @button. If @icon_widget is
1180 * %NULL the icon is determined by the "stock_id" property. If the
1181 * "stock_id" property is also %NULL, @button will not have an icon.
1186 gtk_tool_button_set_icon_widget (GtkToolButton *button,
1187 GtkWidget *icon_widget)
1189 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1190 g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
1192 if (icon_widget != button->priv->icon_widget)
1194 if (button->priv->icon_widget)
1196 if (button->priv->icon_widget->parent)
1197 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
1198 button->priv->icon_widget);
1200 g_object_unref (button->priv->icon_widget);
1204 g_object_ref_sink (icon_widget);
1206 button->priv->icon_widget = icon_widget;
1207 button->priv->contents_invalid = TRUE;
1209 g_object_notify (G_OBJECT (button), "icon-widget");
1214 * gtk_tool_button_set_label_widget:
1215 * @button: a #GtkToolButton
1216 * @label_widget: (allow-none): the widget used as label, or %NULL
1218 * Sets @label_widget as the widget that will be used as the label
1219 * for @button. If @label_widget is %NULL the "label" property is used
1220 * as label. If "label" is also %NULL, the label in the stock item
1221 * determined by the "stock_id" property is used as label. If
1222 * "stock_id" is also %NULL, @button does not have a label.
1227 gtk_tool_button_set_label_widget (GtkToolButton *button,
1228 GtkWidget *label_widget)
1230 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1231 g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
1233 if (label_widget != button->priv->label_widget)
1235 if (button->priv->label_widget)
1237 if (button->priv->label_widget->parent)
1238 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
1239 button->priv->label_widget);
1241 g_object_unref (button->priv->label_widget);
1245 g_object_ref_sink (label_widget);
1247 button->priv->label_widget = label_widget;
1248 button->priv->contents_invalid = TRUE;
1250 g_object_notify (G_OBJECT (button), "label-widget");
1255 * gtk_tool_button_get_label_widget:
1256 * @button: a #GtkToolButton
1258 * Returns the widget used as label on @button. See
1259 * gtk_tool_button_set_label_widget().
1261 * Return value: The widget used as label on @button, or %NULL.
1266 gtk_tool_button_get_label_widget (GtkToolButton *button)
1268 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1270 return button->priv->label_widget;
1274 * gtk_tool_button_get_icon_widget:
1275 * @button: a #GtkToolButton
1277 * Return the widget used as icon widget on @button. See
1278 * gtk_tool_button_set_icon_widget().
1280 * Return value: The widget used as icon on @button, or %NULL.
1285 gtk_tool_button_get_icon_widget (GtkToolButton *button)
1287 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1289 return button->priv->icon_widget;
1293 _gtk_tool_button_get_button (GtkToolButton *button)
1295 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1297 return button->priv->button;