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 "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 GObjectClass *parent_class = NULL;
82 static guint toolbutton_signals[LAST_SIGNAL] = { 0 };
84 #define GTK_TOOL_BUTTON_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonPrivate))
86 struct _GtkToolButtonPrivate
93 GtkWidget *label_widget;
94 GtkWidget *icon_widget;
96 guint use_underline : 1;
97 guint contents_invalid : 1;
101 gtk_tool_button_get_type (void)
103 static GType type = 0;
106 type = g_type_register_static_simple (GTK_TYPE_TOOL_ITEM,
108 sizeof (GtkToolButtonClass),
109 (GClassInitFunc) gtk_tool_button_class_init,
110 sizeof (GtkToolButton),
111 (GInstanceInitFunc) gtk_tool_button_init,
117 gtk_tool_button_class_init (GtkToolButtonClass *klass)
119 GObjectClass *object_class;
120 GtkWidgetClass *widget_class;
121 GtkToolItemClass *tool_item_class;
123 parent_class = g_type_class_peek_parent (klass);
125 object_class = (GObjectClass *)klass;
126 widget_class = (GtkWidgetClass *)klass;
127 tool_item_class = (GtkToolItemClass *)klass;
129 object_class->set_property = gtk_tool_button_set_property;
130 object_class->get_property = gtk_tool_button_get_property;
131 object_class->notify = gtk_tool_button_property_notify;
132 object_class->finalize = gtk_tool_button_finalize;
134 widget_class->style_set = gtk_tool_button_style_set;
136 tool_item_class->create_menu_proxy = gtk_tool_button_create_menu_proxy;
137 tool_item_class->toolbar_reconfigured = gtk_tool_button_toolbar_reconfigured;
139 klass->button_type = GTK_TYPE_BUTTON;
141 /* Properties are interpreted like this:
143 * - if the tool button has an icon_widget, then that widget
144 * will be used as the icon. Otherwise, if the tool button
145 * has a stock id, the corresponding stock icon will be
146 * used. Otherwise, if the tool button has an icon name,
147 * the corresponding icon from the theme will be used.
148 * Otherwise, the tool button will not have an icon.
150 * - if the tool button has a label_widget then that widget
151 * will be used as the label. Otherwise, if the tool button
152 * has a label text, that text will be used as label. Otherwise,
153 * if the toolbutton has a stock id, the corresponding text
154 * will be used as label. Otherwise, if the tool button has
155 * an icon name, the corresponding icon name from the theme will
156 * be used. Otherwise, the toolbutton will have an empty label.
158 * - The use_underline property only has an effect when the label
159 * on the toolbutton comes from the label property (ie. not from
160 * label_widget or from stock_id).
162 * In that case, if use_underline is set,
164 * - underscores are removed from the label text before
165 * the label is shown on the toolbutton unless the
166 * underscore is followed by another underscore
168 * - an underscore indicates that the next character when
169 * used in the overflow menu should be used as a
172 * In short: use_underline = TRUE means that the label text has
173 * the form "_Open" and the toolbar should take appropriate
177 g_object_class_install_property (object_class,
179 g_param_spec_string ("label",
181 P_("Text to show in the item."),
183 GTK_PARAM_READWRITE));
184 g_object_class_install_property (object_class,
186 g_param_spec_boolean ("use-underline",
188 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"),
190 GTK_PARAM_READWRITE));
191 g_object_class_install_property (object_class,
193 g_param_spec_object ("label-widget",
195 P_("Widget to use as the item label"),
197 GTK_PARAM_READWRITE));
198 g_object_class_install_property (object_class,
200 g_param_spec_string ("stock-id",
202 P_("The stock icon displayed on the item"),
204 GTK_PARAM_READWRITE));
207 * GtkToolButton:icon-name:
209 * The name of the themed icon displayed on the item.
210 * This property only has an effect if not overridden by "label",
211 * "icon_widget" or "stock_id" properties.
215 g_object_class_install_property (object_class,
217 g_param_spec_string ("icon-name",
219 P_("The name of the themed icon displayed on the item"),
221 GTK_PARAM_READWRITE));
222 g_object_class_install_property (object_class,
224 g_param_spec_object ("icon-widget",
226 P_("Icon widget to display in the item"),
228 GTK_PARAM_READWRITE));
231 * GtkButton:icon-spacing:
233 * Spacing in pixels between the icon and label.
237 gtk_widget_class_install_style_property (widget_class,
238 g_param_spec_int ("icon-spacing",
240 P_("Spacing in pixels between the icon and label"),
244 GTK_PARAM_READWRITE));
247 * GtkToolButton::clicked:
248 * @toolbutton: the object that emitted the signal
250 * This signal is emitted when the tool button is clicked with the mouse
251 * or activated with the keyboard.
253 toolbutton_signals[CLICKED] =
254 g_signal_new (I_("clicked"),
255 G_OBJECT_CLASS_TYPE (klass),
256 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
257 G_STRUCT_OFFSET (GtkToolButtonClass, clicked),
259 g_cclosure_marshal_VOID__VOID,
262 g_type_class_add_private (object_class, sizeof (GtkToolButtonPrivate));
266 gtk_tool_button_init (GtkToolButton *button,
267 GtkToolButtonClass *klass)
269 GtkToolItem *toolitem = GTK_TOOL_ITEM (button);
271 button->priv = GTK_TOOL_BUTTON_GET_PRIVATE (button);
273 button->priv->contents_invalid = TRUE;
275 gtk_tool_item_set_homogeneous (toolitem, TRUE);
278 button->priv->button = g_object_new (klass->button_type, NULL);
279 gtk_button_set_focus_on_click (GTK_BUTTON (button->priv->button), FALSE);
280 g_signal_connect_object (button->priv->button, "clicked",
281 G_CALLBACK (button_clicked), button, 0);
283 gtk_container_add (GTK_CONTAINER (button), button->priv->button);
284 gtk_widget_show (button->priv->button);
288 gtk_tool_button_construct_contents (GtkToolItem *tool_item)
290 GtkToolButton *button = GTK_TOOL_BUTTON (tool_item);
291 GtkWidget *label = NULL;
292 GtkWidget *icon = NULL;
293 GtkToolbarStyle style;
294 gboolean need_label = FALSE;
295 gboolean need_icon = FALSE;
296 GtkIconSize icon_size;
297 GtkWidget *box = NULL;
300 button->priv->contents_invalid = FALSE;
302 gtk_widget_style_get (GTK_WIDGET (tool_item),
303 "icon-spacing", &icon_spacing,
306 if (button->priv->icon_widget && button->priv->icon_widget->parent)
308 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
309 button->priv->icon_widget);
312 if (button->priv->label_widget && button->priv->label_widget->parent)
314 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
315 button->priv->label_widget);
318 if (GTK_BIN (button->priv->button)->child)
320 /* Note: we are not destroying the label_widget or icon_widget
321 * here because they were removed from their containers above
323 gtk_widget_destroy (GTK_BIN (button->priv->button)->child);
326 style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
328 if (style != GTK_TOOLBAR_TEXT)
331 if (style != GTK_TOOLBAR_ICONS && style != GTK_TOOLBAR_BOTH_HORIZ)
334 if (style == GTK_TOOLBAR_BOTH_HORIZ &&
335 (gtk_tool_item_get_is_important (GTK_TOOL_ITEM (button)) ||
336 gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL))
341 if (style == GTK_TOOLBAR_ICONS && button->priv->icon_widget == NULL &&
342 button->priv->stock_id == NULL && button->priv->icon_name == NULL)
346 style = GTK_TOOLBAR_TEXT;
349 if (style == GTK_TOOLBAR_TEXT && button->priv->label_widget == NULL &&
350 button->priv->stock_id == NULL && button->priv->label_text == NULL)
354 style = GTK_TOOLBAR_ICONS;
359 if (button->priv->label_widget)
361 label = button->priv->label_widget;
365 GtkStockItem stock_item;
369 if (button->priv->label_text)
371 label_text = button->priv->label_text;
372 elide = button->priv->use_underline;
374 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
376 label_text = stock_item.label;
386 label_text = _gtk_toolbar_elide_underscores (label_text);
388 label_text = g_strdup (label_text);
390 label = gtk_label_new (label_text);
394 gtk_widget_show (label);
398 icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
401 if (button->priv->icon_widget)
403 icon = button->priv->icon_widget;
405 if (GTK_IS_IMAGE (icon))
407 g_object_set (button->priv->icon_widget,
408 "icon-size", icon_size,
412 else if (button->priv->stock_id &&
413 gtk_icon_factory_lookup_default (button->priv->stock_id))
415 icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
416 gtk_widget_show (icon);
418 else if (button->priv->icon_name)
420 icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
421 gtk_widget_show (icon);
427 case GTK_TOOLBAR_ICONS:
429 gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
432 case GTK_TOOLBAR_BOTH:
433 box = gtk_vbox_new (FALSE, icon_spacing);
435 gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
436 gtk_box_pack_end (GTK_BOX (box), label, FALSE, TRUE, 0);
437 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
440 case GTK_TOOLBAR_BOTH_HORIZ:
441 box = gtk_hbox_new (FALSE, icon_spacing);
443 gtk_box_pack_start (GTK_BOX (box), icon, label? FALSE : TRUE, TRUE, 0);
445 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
446 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
449 case GTK_TOOLBAR_TEXT:
450 gtk_container_add (GTK_CONTAINER (button->priv->button), label);
455 gtk_widget_show (box);
457 gtk_button_set_relief (GTK_BUTTON (button->priv->button),
458 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
460 gtk_tool_item_rebuild_menu (tool_item);
462 gtk_widget_queue_resize (GTK_WIDGET (button));
466 gtk_tool_button_set_property (GObject *object,
471 GtkToolButton *button = GTK_TOOL_BUTTON (object);
476 gtk_tool_button_set_label (button, g_value_get_string (value));
478 case PROP_USE_UNDERLINE:
479 gtk_tool_button_set_use_underline (button, g_value_get_boolean (value));
481 case PROP_LABEL_WIDGET:
482 gtk_tool_button_set_label_widget (button, g_value_get_object (value));
485 gtk_tool_button_set_stock_id (button, g_value_get_string (value));
488 gtk_tool_button_set_icon_name (button, g_value_get_string (value));
490 case PROP_ICON_WIDGET:
491 gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
494 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
500 gtk_tool_button_property_notify (GObject *object,
503 GtkToolButton *button = GTK_TOOL_BUTTON (object);
505 if (button->priv->contents_invalid ||
506 strcmp ("is-important", pspec->name) == 0)
507 gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
509 if (parent_class->notify)
510 parent_class->notify (object, pspec);
514 gtk_tool_button_get_property (GObject *object,
519 GtkToolButton *button = GTK_TOOL_BUTTON (object);
524 g_value_set_string (value, gtk_tool_button_get_label (button));
526 case PROP_LABEL_WIDGET:
527 g_value_set_object (value, gtk_tool_button_get_label_widget (button));
529 case PROP_USE_UNDERLINE:
530 g_value_set_boolean (value, gtk_tool_button_get_use_underline (button));
533 g_value_set_string (value, button->priv->stock_id);
536 g_value_set_string (value, button->priv->icon_name);
538 case PROP_ICON_WIDGET:
539 g_value_set_object (value, button->priv->icon_widget);
542 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
548 gtk_tool_button_finalize (GObject *object)
550 GtkToolButton *button = GTK_TOOL_BUTTON (object);
552 g_free (button->priv->stock_id);
553 g_free (button->priv->icon_name);
554 g_free (button->priv->label_text);
556 if (button->priv->label_widget)
557 g_object_unref (button->priv->label_widget);
559 if (button->priv->icon_widget)
560 g_object_unref (button->priv->icon_widget);
562 parent_class->finalize (object);
566 clone_image_menu_size (GtkImage *image, GtkSettings *settings)
568 GtkImageType storage_type = gtk_image_get_storage_type (image);
570 if (storage_type == GTK_IMAGE_STOCK)
573 gtk_image_get_stock (image, &stock_id, NULL);
574 return gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
576 else if (storage_type == GTK_IMAGE_ICON_SET)
578 GtkIconSet *icon_set;
579 gtk_image_get_icon_set (image, &icon_set, NULL);
580 return gtk_image_new_from_icon_set (icon_set, GTK_ICON_SIZE_MENU);
582 else if (storage_type == GTK_IMAGE_GICON)
585 gtk_image_get_gicon (image, &icon, NULL);
586 return gtk_image_new_from_gicon (icon, GTK_ICON_SIZE_MENU);
588 else if (storage_type == GTK_IMAGE_PIXBUF)
593 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
596 GdkPixbuf *src_pixbuf, *dest_pixbuf;
597 GtkWidget *cloned_image;
599 src_pixbuf = gtk_image_get_pixbuf (image);
600 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
601 GDK_INTERP_BILINEAR);
603 cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
604 g_object_unref (dest_pixbuf);
614 gtk_tool_button_create_menu_proxy (GtkToolItem *item)
616 GtkToolButton *button = GTK_TOOL_BUTTON (item);
617 GtkWidget *menu_item;
618 GtkWidget *menu_image = NULL;
619 GtkStockItem stock_item;
620 gboolean use_mnemonic = TRUE;
623 if (GTK_IS_LABEL (button->priv->label_widget))
625 label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
626 use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
628 else if (button->priv->label_text)
630 label = button->priv->label_text;
631 use_mnemonic = button->priv->use_underline;
633 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
635 label = stock_item.label;
643 menu_item = gtk_image_menu_item_new_with_mnemonic (label);
645 menu_item = gtk_image_menu_item_new_with_label (label);
647 if (GTK_IS_IMAGE (button->priv->icon_widget))
649 menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget),
650 gtk_widget_get_settings (GTK_WIDGET (button)));
652 else if (button->priv->stock_id)
654 menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
658 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item), menu_image);
660 g_signal_connect_closure_by_id (menu_item,
661 g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
662 g_cclosure_new_object_swap (G_CALLBACK (gtk_button_clicked),
663 G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
666 gtk_tool_item_set_proxy_menu_item (GTK_TOOL_ITEM (button), MENU_ID, menu_item);
672 button_clicked (GtkWidget *widget,
673 GtkToolButton *button)
675 g_signal_emit_by_name (button, "clicked");
679 gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item)
681 gtk_tool_button_construct_contents (tool_item);
685 gtk_tool_button_update_icon_spacing (GtkToolButton *button)
690 box = GTK_BIN (button->priv->button)->child;
691 if (GTK_IS_BOX (box))
693 gtk_widget_style_get (GTK_WIDGET (button),
694 "icon-spacing", &spacing,
696 gtk_box_set_spacing (GTK_BOX (box), spacing);
701 gtk_tool_button_style_set (GtkWidget *widget,
702 GtkStyle *prev_style)
704 gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
708 * gtk_tool_button_new_from_stock:
709 * @stock_id: the name of the stock item
711 * Creates a new #GtkToolButton containing the image and text from a
712 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
713 * and #GTK_STOCK_APPLY.
715 * It is an error if @stock_id is not a name of a stock item.
717 * Return value: A new #GtkToolButton
722 gtk_tool_button_new_from_stock (const gchar *stock_id)
724 GtkToolButton *button;
726 g_return_val_if_fail (stock_id != NULL, NULL);
728 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
729 "stock-id", stock_id,
732 return GTK_TOOL_ITEM (button);
736 * gtk_tool_button_new:
737 * @label: a string that will be used as label, or %NULL
738 * @icon_widget: a widget that will be used as icon widget, or %NULL
740 * Creates a new %GtkToolButton using @icon_widget as icon and @label as
743 * Return value: A new #GtkToolButton
748 gtk_tool_button_new (GtkWidget *icon_widget,
751 GtkToolButton *button;
753 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
755 "icon-widget", icon_widget,
758 return GTK_TOOL_ITEM (button);
762 * gtk_tool_button_set_label:
763 * @button: a #GtkToolButton
764 * @label: a string that will be used as label, or %NULL.
766 * Sets @label as the label used for the tool button. The "label" property
767 * only has an effect if not overridden by a non-%NULL "label_widget" property.
768 * If both the "label_widget" and "label" properties are %NULL, the label
769 * is determined by the "stock_id" property. If the "stock_id" property is also
770 * %NULL, @button will not have a label.
775 gtk_tool_button_set_label (GtkToolButton *button,
780 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
782 old_label = button->priv->label_text;
784 button->priv->label_text = g_strdup (label);
785 button->priv->contents_invalid = TRUE;
789 g_object_notify (G_OBJECT (button), "label");
793 * gtk_tool_button_get_label:
794 * @button: a #GtkToolButton
796 * Returns the label used by the tool button, or %NULL if the tool button
797 * doesn't have a label. or uses a the label from a stock item. The returned
798 * string is owned by GTK+, and must not be modified or freed.
800 * Return value: The label, or %NULL
804 G_CONST_RETURN gchar *
805 gtk_tool_button_get_label (GtkToolButton *button)
807 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
809 return button->priv->label_text;
813 * gtk_tool_button_set_use_underline:
814 * @button: a #GtkToolButton
815 * @use_underline: whether the button label has the form "_Open"
817 * If set, an underline in the label property indicates that the next character
818 * should be used for the mnemonic accelerator key in the overflow menu. For
819 * example, if the label property is "_Open" and @use_underline is %TRUE,
820 * the label on the tool button will be "Open" and the item on the overflow
821 * menu will have an underlined 'O'.
823 * Labels shown on tool buttons never have mnemonics on them; this property
824 * only affects the menu item on the overflow menu.
829 gtk_tool_button_set_use_underline (GtkToolButton *button,
830 gboolean use_underline)
832 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
834 use_underline = use_underline != FALSE;
836 if (use_underline != button->priv->use_underline)
838 button->priv->use_underline = use_underline;
839 button->priv->contents_invalid = TRUE;
841 g_object_notify (G_OBJECT (button), "use-underline");
846 * gtk_tool_button_get_use_underline:
847 * @button: a #GtkToolButton
849 * Returns whether underscores in the label property are used as mnemonics
850 * on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
852 * Return value: %TRUE if underscores in the label property are used as
853 * mnemonics on menu items on the overflow menu.
858 gtk_tool_button_get_use_underline (GtkToolButton *button)
860 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);
862 return button->priv->use_underline;
866 * gtk_tool_button_set_stock_id:
867 * @button: a #GtkToolButton
868 * @stock_id: a name of a stock item, or %NULL
870 * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
871 * The stock_id property only has an effect if not
872 * overridden by non-%NULL "label" and "icon_widget" properties.
877 gtk_tool_button_set_stock_id (GtkToolButton *button,
878 const gchar *stock_id)
882 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
884 old_stock_id = button->priv->stock_id;
886 button->priv->stock_id = g_strdup (stock_id);
887 button->priv->contents_invalid = TRUE;
889 g_free (old_stock_id);
891 g_object_notify (G_OBJECT (button), "stock-id");
895 * gtk_tool_button_get_stock_id:
896 * @button: a #GtkToolButton
898 * Returns the name of the stock item. See gtk_tool_button_set_stock_id().
899 * The returned string is owned by GTK+ and must not be freed or modifed.
901 * Return value: the name of the stock item for @button.
905 G_CONST_RETURN gchar *
906 gtk_tool_button_get_stock_id (GtkToolButton *button)
908 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
910 return button->priv->stock_id;
914 * gtk_tool_button_set_icon_name
915 * @button: a #GtkToolButton
916 * @icon_name: the name of the themed icon
918 * Sets the icon for the tool button from a named themed icon.
919 * See the docs for #GtkIconTheme for more details.
920 * The "icon_name" property only has an effect if not
921 * overridden by non-%NULL "label", "icon_widget" and "stock_id"
927 gtk_tool_button_set_icon_name (GtkToolButton *button,
928 const gchar *icon_name)
930 gchar *old_icon_name;
932 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
934 old_icon_name = button->priv->icon_name;
936 button->priv->icon_name = g_strdup (icon_name);
937 button->priv->contents_invalid = TRUE;
939 g_free (old_icon_name);
941 g_object_notify (G_OBJECT (button), "icon-name");
945 * gtk_tool_button_get_icon_name
946 * @button: a #GtkToolButton
948 * Returns the name of the themed icon for the tool button,
949 * see gtk_tool_button_set_icon_name().
951 * Returns: the icon name or %NULL if the tool button has
956 G_CONST_RETURN gchar*
957 gtk_tool_button_get_icon_name (GtkToolButton *button)
959 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
961 return button->priv->icon_name;
965 * gtk_tool_button_set_icon_widget:
966 * @button: a #GtkToolButton
967 * @icon_widget: the widget used as icon, or %NULL
969 * Sets @icon as the widget used as icon on @button. If @icon_widget is
970 * %NULL the icon is determined by the "stock_id" property. If the
971 * "stock_id" property is also %NULL, @button will not have an icon.
976 gtk_tool_button_set_icon_widget (GtkToolButton *button,
977 GtkWidget *icon_widget)
979 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
980 g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
982 if (icon_widget != button->priv->icon_widget)
984 if (button->priv->icon_widget)
986 if (button->priv->icon_widget->parent)
987 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
988 button->priv->icon_widget);
990 g_object_unref (button->priv->icon_widget);
994 g_object_ref_sink (icon_widget);
996 button->priv->icon_widget = icon_widget;
997 button->priv->contents_invalid = TRUE;
999 g_object_notify (G_OBJECT (button), "icon-widget");
1004 * gtk_tool_button_set_label_widget:
1005 * @button: a #GtkToolButton
1006 * @label_widget: the widget used as label, or %NULL
1008 * Sets @label_widget as the widget that will be used as the label
1009 * for @button. If @label_widget is %NULL the "label" property is used
1010 * as label. If "label" is also %NULL, the label in the stock item
1011 * determined by the "stock_id" property is used as label. If
1012 * "stock_id" is also %NULL, @button does not have a label.
1017 gtk_tool_button_set_label_widget (GtkToolButton *button,
1018 GtkWidget *label_widget)
1020 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1021 g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
1023 if (label_widget != button->priv->label_widget)
1025 if (button->priv->label_widget)
1027 if (button->priv->label_widget->parent)
1028 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
1029 button->priv->label_widget);
1031 g_object_unref (button->priv->label_widget);
1035 g_object_ref_sink (label_widget);
1037 button->priv->label_widget = label_widget;
1038 button->priv->contents_invalid = TRUE;
1040 g_object_notify (G_OBJECT (button), "label-widget");
1045 * gtk_tool_button_get_label_widget:
1046 * @button: a #GtkToolButton
1048 * Returns the widget used as label on @button. See
1049 * gtk_tool_button_set_label_widget().
1051 * Return value: The widget used as label on @button, or %NULL.
1056 gtk_tool_button_get_label_widget (GtkToolButton *button)
1058 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1060 return button->priv->label_widget;
1064 * gtk_tool_button_get_icon_widget:
1065 * @button: a #GtkToolButton
1067 * Return the widget used as icon widget on @button. See
1068 * gtk_tool_button_set_icon_widget().
1070 * Return value: The widget used as icon on @button, or %NULL.
1075 gtk_tool_button_get_icon_widget (GtkToolButton *button)
1077 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1079 return button->priv->icon_widget;
1083 _gtk_tool_button_get_button (GtkToolButton *button)
1085 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1087 return button->priv->button;
1091 #define __GTK_TOOL_BUTTON_C__
1092 #include "gtkaliasdef.c"