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"
41 #define MENU_ID "gtk-tool-button-menu-id"
58 static void gtk_tool_button_init (GtkToolButton *button,
59 GtkToolButtonClass *klass);
60 static void gtk_tool_button_class_init (GtkToolButtonClass *klass);
61 static void gtk_tool_button_set_property (GObject *object,
65 static void gtk_tool_button_get_property (GObject *object,
69 static void gtk_tool_button_property_notify (GObject *object,
71 static void gtk_tool_button_finalize (GObject *object);
73 static void gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item);
74 static gboolean gtk_tool_button_create_menu_proxy (GtkToolItem *item);
75 static void button_clicked (GtkWidget *widget,
76 GtkToolButton *button);
77 static void gtk_tool_button_style_set (GtkWidget *widget,
78 GtkStyle *prev_style);
80 static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);
82 static void gtk_tool_button_activatable_interface_init (GtkActivatableIface *iface);
83 static void gtk_tool_button_activatable_update (GtkActivatable *activatable,
85 const gchar *property_name);
86 static void gtk_tool_button_activatable_reset (GtkActivatable *activatable,
90 struct _GtkToolButtonPrivate
97 GtkWidget *label_widget;
98 GtkWidget *icon_widget;
100 guint use_underline : 1;
101 guint contents_invalid : 1;
104 static GObjectClass *parent_class = NULL;
105 static GtkActivatableIface *parent_activatable_iface;
106 static guint toolbutton_signals[LAST_SIGNAL] = { 0 };
108 #define GTK_TOOL_BUTTON_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonPrivate))
111 gtk_tool_button_get_type (void)
113 static GType type = 0;
117 static 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 = GTK_TOOL_BUTTON_GET_PRIVATE (button);
295 button->priv->contents_invalid = TRUE;
297 gtk_tool_item_set_homogeneous (toolitem, TRUE);
300 button->priv->button = g_object_new (klass->button_type, NULL);
301 gtk_button_set_focus_on_click (GTK_BUTTON (button->priv->button), FALSE);
302 g_signal_connect_object (button->priv->button, "clicked",
303 G_CALLBACK (button_clicked), button, 0);
305 gtk_container_add (GTK_CONTAINER (button), button->priv->button);
306 gtk_widget_show (button->priv->button);
310 gtk_tool_button_construct_contents (GtkToolItem *tool_item)
312 GtkToolButton *button = GTK_TOOL_BUTTON (tool_item);
313 GtkWidget *label = NULL;
314 GtkWidget *icon = NULL;
315 GtkToolbarStyle style;
316 gboolean need_label = FALSE;
317 gboolean need_icon = FALSE;
318 GtkIconSize icon_size;
319 GtkWidget *box = NULL;
322 button->priv->contents_invalid = FALSE;
324 gtk_widget_style_get (GTK_WIDGET (tool_item),
325 "icon-spacing", &icon_spacing,
328 if (button->priv->icon_widget && button->priv->icon_widget->parent)
330 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
331 button->priv->icon_widget);
334 if (button->priv->label_widget && button->priv->label_widget->parent)
336 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
337 button->priv->label_widget);
340 if (GTK_BIN (button->priv->button)->child)
342 /* Note: we are not destroying the label_widget or icon_widget
343 * here because they were removed from their containers above
345 gtk_widget_destroy (GTK_BIN (button->priv->button)->child);
348 style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
350 if (style != GTK_TOOLBAR_TEXT)
353 if (style != GTK_TOOLBAR_ICONS && style != GTK_TOOLBAR_BOTH_HORIZ)
356 if (style == GTK_TOOLBAR_BOTH_HORIZ &&
357 (gtk_tool_item_get_is_important (GTK_TOOL_ITEM (button)) ||
358 gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL))
363 if (style == GTK_TOOLBAR_ICONS && button->priv->icon_widget == NULL &&
364 button->priv->stock_id == NULL && button->priv->icon_name == NULL)
368 style = GTK_TOOLBAR_TEXT;
371 if (style == GTK_TOOLBAR_TEXT && button->priv->label_widget == NULL &&
372 button->priv->stock_id == NULL && button->priv->label_text == NULL)
376 style = GTK_TOOLBAR_ICONS;
381 if (button->priv->label_widget)
383 label = button->priv->label_widget;
387 GtkStockItem stock_item;
391 if (button->priv->label_text)
393 label_text = button->priv->label_text;
394 elide = button->priv->use_underline;
396 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
398 label_text = stock_item.label;
408 label_text = _gtk_toolbar_elide_underscores (label_text);
410 label_text = g_strdup (label_text);
412 label = gtk_label_new (label_text);
416 gtk_widget_show (label);
420 icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
423 if (button->priv->icon_widget)
425 icon = button->priv->icon_widget;
427 if (GTK_IS_IMAGE (icon))
429 g_object_set (button->priv->icon_widget,
430 "icon-size", icon_size,
434 else if (button->priv->stock_id &&
435 gtk_icon_factory_lookup_default (button->priv->stock_id))
437 icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
438 gtk_widget_show (icon);
440 else if (button->priv->icon_name)
442 icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
443 gtk_widget_show (icon);
449 case GTK_TOOLBAR_ICONS:
451 gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
454 case GTK_TOOLBAR_BOTH:
455 box = gtk_vbox_new (FALSE, icon_spacing);
457 gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
458 gtk_box_pack_end (GTK_BOX (box), label, FALSE, TRUE, 0);
459 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
462 case GTK_TOOLBAR_BOTH_HORIZ:
463 box = gtk_hbox_new (FALSE, icon_spacing);
465 gtk_box_pack_start (GTK_BOX (box), icon, label? FALSE : TRUE, TRUE, 0);
467 gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
468 gtk_container_add (GTK_CONTAINER (button->priv->button), box);
471 case GTK_TOOLBAR_TEXT:
472 gtk_container_add (GTK_CONTAINER (button->priv->button), label);
477 gtk_widget_show (box);
479 gtk_button_set_relief (GTK_BUTTON (button->priv->button),
480 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
482 gtk_tool_item_rebuild_menu (tool_item);
484 gtk_widget_queue_resize (GTK_WIDGET (button));
488 gtk_tool_button_set_property (GObject *object,
493 GtkToolButton *button = GTK_TOOL_BUTTON (object);
498 gtk_tool_button_set_label (button, g_value_get_string (value));
500 case PROP_USE_UNDERLINE:
501 gtk_tool_button_set_use_underline (button, g_value_get_boolean (value));
503 case PROP_LABEL_WIDGET:
504 gtk_tool_button_set_label_widget (button, g_value_get_object (value));
507 gtk_tool_button_set_stock_id (button, g_value_get_string (value));
510 gtk_tool_button_set_icon_name (button, g_value_get_string (value));
512 case PROP_ICON_WIDGET:
513 gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
516 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
522 gtk_tool_button_property_notify (GObject *object,
525 GtkToolButton *button = GTK_TOOL_BUTTON (object);
527 if (button->priv->contents_invalid ||
528 strcmp ("is-important", pspec->name) == 0)
529 gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
531 if (parent_class->notify)
532 parent_class->notify (object, pspec);
536 gtk_tool_button_get_property (GObject *object,
541 GtkToolButton *button = GTK_TOOL_BUTTON (object);
546 g_value_set_string (value, gtk_tool_button_get_label (button));
548 case PROP_LABEL_WIDGET:
549 g_value_set_object (value, gtk_tool_button_get_label_widget (button));
551 case PROP_USE_UNDERLINE:
552 g_value_set_boolean (value, gtk_tool_button_get_use_underline (button));
555 g_value_set_string (value, button->priv->stock_id);
558 g_value_set_string (value, button->priv->icon_name);
560 case PROP_ICON_WIDGET:
561 g_value_set_object (value, button->priv->icon_widget);
564 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
570 gtk_tool_button_finalize (GObject *object)
572 GtkToolButton *button = GTK_TOOL_BUTTON (object);
574 g_free (button->priv->stock_id);
575 g_free (button->priv->icon_name);
576 g_free (button->priv->label_text);
578 if (button->priv->label_widget)
579 g_object_unref (button->priv->label_widget);
581 if (button->priv->icon_widget)
582 g_object_unref (button->priv->icon_widget);
584 parent_class->finalize (object);
588 clone_image_menu_size (GtkImage *image, GtkSettings *settings)
590 GtkImageType storage_type = gtk_image_get_storage_type (image);
592 if (storage_type == GTK_IMAGE_STOCK)
595 gtk_image_get_stock (image, &stock_id, NULL);
596 return gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
598 else if (storage_type == GTK_IMAGE_ICON_SET)
600 GtkIconSet *icon_set;
601 gtk_image_get_icon_set (image, &icon_set, NULL);
602 return gtk_image_new_from_icon_set (icon_set, GTK_ICON_SIZE_MENU);
604 else if (storage_type == GTK_IMAGE_GICON)
607 gtk_image_get_gicon (image, &icon, NULL);
608 return gtk_image_new_from_gicon (icon, GTK_ICON_SIZE_MENU);
610 else if (storage_type == GTK_IMAGE_PIXBUF)
615 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
618 GdkPixbuf *src_pixbuf, *dest_pixbuf;
619 GtkWidget *cloned_image;
621 src_pixbuf = gtk_image_get_pixbuf (image);
622 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
623 GDK_INTERP_BILINEAR);
625 cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
626 g_object_unref (dest_pixbuf);
636 gtk_tool_button_create_menu_proxy (GtkToolItem *item)
638 GtkToolButton *button = GTK_TOOL_BUTTON (item);
639 GtkWidget *menu_item;
640 GtkWidget *menu_image = NULL;
641 GtkStockItem stock_item;
642 gboolean use_mnemonic = TRUE;
645 if (GTK_IS_LABEL (button->priv->label_widget))
647 label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
648 use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
650 else if (button->priv->label_text)
652 label = button->priv->label_text;
653 use_mnemonic = button->priv->use_underline;
655 else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
657 label = stock_item.label;
665 menu_item = gtk_image_menu_item_new_with_mnemonic (label);
667 menu_item = gtk_image_menu_item_new_with_label (label);
669 if (GTK_IS_IMAGE (button->priv->icon_widget))
671 menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget),
672 gtk_widget_get_settings (GTK_WIDGET (button)));
674 else if (button->priv->stock_id)
676 menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
680 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item), menu_image);
682 g_signal_connect_closure_by_id (menu_item,
683 g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
684 g_cclosure_new_object_swap (G_CALLBACK (gtk_button_clicked),
685 G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
688 gtk_tool_item_set_proxy_menu_item (GTK_TOOL_ITEM (button), MENU_ID, menu_item);
694 button_clicked (GtkWidget *widget,
695 GtkToolButton *button)
699 action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (button));
702 gtk_action_activate (action);
704 g_signal_emit_by_name (button, "clicked");
708 gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item)
710 gtk_tool_button_construct_contents (tool_item);
714 gtk_tool_button_update_icon_spacing (GtkToolButton *button)
719 box = GTK_BIN (button->priv->button)->child;
720 if (GTK_IS_BOX (box))
722 gtk_widget_style_get (GTK_WIDGET (button),
723 "icon-spacing", &spacing,
725 gtk_box_set_spacing (GTK_BOX (box), spacing);
730 gtk_tool_button_style_set (GtkWidget *widget,
731 GtkStyle *prev_style)
733 gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
737 gtk_tool_button_activatable_interface_init (GtkActivatableIface *iface)
739 parent_activatable_iface = g_type_interface_peek_parent (iface);
740 iface->update = gtk_tool_button_activatable_update;
741 iface->reset = gtk_tool_button_activatable_reset;
745 gtk_tool_button_activatable_update (GtkActivatable *activatable,
747 const gchar *property_name)
749 GtkToolButton *button;
752 parent_activatable_iface->update (activatable, action, property_name);
754 if (!gtk_activatable_get_use_action_appearance (activatable))
757 button = GTK_TOOL_BUTTON (activatable);
759 if (strcmp (property_name, "short-label") == 0)
761 if (!gtk_action_get_stock_id (action) &&
762 !gtk_action_get_icon_name (action))
764 gtk_tool_button_set_use_underline (button, TRUE);
765 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
768 else if (strcmp (property_name, "stock-id") == 0)
770 if (gtk_action_get_stock_id (action))
772 gtk_tool_button_set_label (button, NULL);
773 gtk_tool_button_set_icon_name (button, NULL);
775 gtk_tool_button_set_icon_widget (button, NULL);
776 gtk_tool_button_set_stock_id (button, gtk_action_get_stock_id (action));
778 else if (strcmp (property_name, "gicon") == 0)
780 const gchar *stock_id = gtk_action_get_stock_id (action);
781 GIcon *icon = gtk_action_get_gicon (action);
782 GtkIconSize icon_size = GTK_ICON_SIZE_BUTTON;
784 if ((stock_id && gtk_icon_factory_lookup_default (stock_id)) || !icon)
788 image = gtk_tool_button_get_icon_widget (button);
789 icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
792 image = gtk_image_new ();
795 gtk_tool_button_set_icon_widget (button, image);
796 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);
799 else if (strcmp (property_name, "icon-name") == 0)
801 if (gtk_action_get_icon_name (action))
803 gtk_tool_button_set_label (button, NULL);
804 gtk_tool_button_set_stock_id (button, NULL);
806 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
811 gtk_tool_button_activatable_reset (GtkActivatable *activatable,
814 GtkToolButton *button;
816 const gchar *stock_id;
818 parent_activatable_iface->reset (activatable, action);
823 if (!gtk_activatable_get_use_action_appearance (activatable))
826 button = GTK_TOOL_BUTTON (activatable);
827 stock_id = gtk_action_get_stock_id (action);
829 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
830 gtk_tool_button_set_use_underline (button, TRUE);
831 gtk_tool_button_set_stock_id (button, stock_id);
832 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
834 if (stock_id && gtk_icon_factory_lookup_default (stock_id))
835 gtk_tool_button_set_icon_widget (button, NULL);
836 else if ((icon = gtk_action_get_gicon (action)) != NULL)
838 GtkIconSize icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
839 GtkWidget *image = gtk_tool_button_get_icon_widget (button);
843 image = gtk_image_new ();
844 gtk_widget_show (image);
845 gtk_tool_button_set_icon_widget (button, image);
848 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);
850 else if (gtk_action_get_icon_name (action))
851 gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
853 gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
857 * gtk_tool_button_new_from_stock:
858 * @stock_id: the name of the stock item
860 * Creates a new #GtkToolButton containing the image and text from a
861 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
862 * and #GTK_STOCK_APPLY.
864 * It is an error if @stock_id is not a name of a stock item.
866 * Return value: A new #GtkToolButton
871 gtk_tool_button_new_from_stock (const gchar *stock_id)
873 GtkToolButton *button;
875 g_return_val_if_fail (stock_id != NULL, NULL);
877 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
878 "stock-id", stock_id,
881 return GTK_TOOL_ITEM (button);
885 * gtk_tool_button_new:
886 * @label: a string that will be used as label, or %NULL
887 * @icon_widget: a widget that will be used as icon widget, or %NULL
889 * Creates a new %GtkToolButton using @icon_widget as icon and @label as
892 * Return value: A new #GtkToolButton
897 gtk_tool_button_new (GtkWidget *icon_widget,
900 GtkToolButton *button;
902 button = g_object_new (GTK_TYPE_TOOL_BUTTON,
904 "icon-widget", icon_widget,
907 return GTK_TOOL_ITEM (button);
911 * gtk_tool_button_set_label:
912 * @button: a #GtkToolButton
913 * @label: a string that will be used as label, or %NULL.
915 * Sets @label as the label used for the tool button. The "label" property
916 * only has an effect if not overridden by a non-%NULL "label_widget" property.
917 * If both the "label_widget" and "label" properties are %NULL, the label
918 * is determined by the "stock_id" property. If the "stock_id" property is also
919 * %NULL, @button will not have a label.
924 gtk_tool_button_set_label (GtkToolButton *button,
929 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
931 old_label = button->priv->label_text;
933 button->priv->label_text = g_strdup (label);
934 button->priv->contents_invalid = TRUE;
938 g_object_notify (G_OBJECT (button), "label");
942 * gtk_tool_button_get_label:
943 * @button: a #GtkToolButton
945 * Returns the label used by the tool button, or %NULL if the tool button
946 * doesn't have a label. or uses a the label from a stock item. The returned
947 * string is owned by GTK+, and must not be modified or freed.
949 * Return value: The label, or %NULL
953 G_CONST_RETURN gchar *
954 gtk_tool_button_get_label (GtkToolButton *button)
956 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
958 return button->priv->label_text;
962 * gtk_tool_button_set_use_underline:
963 * @button: a #GtkToolButton
964 * @use_underline: whether the button label has the form "_Open"
966 * If set, an underline in the label property indicates that the next character
967 * should be used for the mnemonic accelerator key in the overflow menu. For
968 * example, if the label property is "_Open" and @use_underline is %TRUE,
969 * the label on the tool button will be "Open" and the item on the overflow
970 * menu will have an underlined 'O'.
972 * Labels shown on tool buttons never have mnemonics on them; this property
973 * only affects the menu item on the overflow menu.
978 gtk_tool_button_set_use_underline (GtkToolButton *button,
979 gboolean use_underline)
981 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
983 use_underline = use_underline != FALSE;
985 if (use_underline != button->priv->use_underline)
987 button->priv->use_underline = use_underline;
988 button->priv->contents_invalid = TRUE;
990 g_object_notify (G_OBJECT (button), "use-underline");
995 * gtk_tool_button_get_use_underline:
996 * @button: a #GtkToolButton
998 * Returns whether underscores in the label property are used as mnemonics
999 * on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
1001 * Return value: %TRUE if underscores in the label property are used as
1002 * mnemonics on menu items on the overflow menu.
1007 gtk_tool_button_get_use_underline (GtkToolButton *button)
1009 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);
1011 return button->priv->use_underline;
1015 * gtk_tool_button_set_stock_id:
1016 * @button: a #GtkToolButton
1017 * @stock_id: a name of a stock item, or %NULL
1019 * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
1020 * The stock_id property only has an effect if not
1021 * overridden by non-%NULL "label" and "icon_widget" properties.
1026 gtk_tool_button_set_stock_id (GtkToolButton *button,
1027 const gchar *stock_id)
1029 gchar *old_stock_id;
1031 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1033 old_stock_id = button->priv->stock_id;
1035 button->priv->stock_id = g_strdup (stock_id);
1036 button->priv->contents_invalid = TRUE;
1038 g_free (old_stock_id);
1040 g_object_notify (G_OBJECT (button), "stock-id");
1044 * gtk_tool_button_get_stock_id:
1045 * @button: a #GtkToolButton
1047 * Returns the name of the stock item. See gtk_tool_button_set_stock_id().
1048 * The returned string is owned by GTK+ and must not be freed or modifed.
1050 * Return value: the name of the stock item for @button.
1054 G_CONST_RETURN gchar *
1055 gtk_tool_button_get_stock_id (GtkToolButton *button)
1057 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1059 return button->priv->stock_id;
1063 * gtk_tool_button_set_icon_name
1064 * @button: a #GtkToolButton
1065 * @icon_name: the name of the themed icon
1067 * Sets the icon for the tool button from a named themed icon.
1068 * See the docs for #GtkIconTheme for more details.
1069 * The "icon_name" property only has an effect if not
1070 * overridden by non-%NULL "label", "icon_widget" and "stock_id"
1076 gtk_tool_button_set_icon_name (GtkToolButton *button,
1077 const gchar *icon_name)
1079 gchar *old_icon_name;
1081 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1083 old_icon_name = button->priv->icon_name;
1085 button->priv->icon_name = g_strdup (icon_name);
1086 button->priv->contents_invalid = TRUE;
1088 g_free (old_icon_name);
1090 g_object_notify (G_OBJECT (button), "icon-name");
1094 * gtk_tool_button_get_icon_name
1095 * @button: a #GtkToolButton
1097 * Returns the name of the themed icon for the tool button,
1098 * see gtk_tool_button_set_icon_name().
1100 * Returns: the icon name or %NULL if the tool button has
1105 G_CONST_RETURN gchar*
1106 gtk_tool_button_get_icon_name (GtkToolButton *button)
1108 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1110 return button->priv->icon_name;
1114 * gtk_tool_button_set_icon_widget:
1115 * @button: a #GtkToolButton
1116 * @icon_widget: the widget used as icon, or %NULL
1118 * Sets @icon as the widget used as icon on @button. If @icon_widget is
1119 * %NULL the icon is determined by the "stock_id" property. If the
1120 * "stock_id" property is also %NULL, @button will not have an icon.
1125 gtk_tool_button_set_icon_widget (GtkToolButton *button,
1126 GtkWidget *icon_widget)
1128 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1129 g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
1131 if (icon_widget != button->priv->icon_widget)
1133 if (button->priv->icon_widget)
1135 if (button->priv->icon_widget->parent)
1136 gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
1137 button->priv->icon_widget);
1139 g_object_unref (button->priv->icon_widget);
1143 g_object_ref_sink (icon_widget);
1145 button->priv->icon_widget = icon_widget;
1146 button->priv->contents_invalid = TRUE;
1148 g_object_notify (G_OBJECT (button), "icon-widget");
1153 * gtk_tool_button_set_label_widget:
1154 * @button: a #GtkToolButton
1155 * @label_widget: the widget used as label, or %NULL
1157 * Sets @label_widget as the widget that will be used as the label
1158 * for @button. If @label_widget is %NULL the "label" property is used
1159 * as label. If "label" is also %NULL, the label in the stock item
1160 * determined by the "stock_id" property is used as label. If
1161 * "stock_id" is also %NULL, @button does not have a label.
1166 gtk_tool_button_set_label_widget (GtkToolButton *button,
1167 GtkWidget *label_widget)
1169 g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1170 g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
1172 if (label_widget != button->priv->label_widget)
1174 if (button->priv->label_widget)
1176 if (button->priv->label_widget->parent)
1177 gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
1178 button->priv->label_widget);
1180 g_object_unref (button->priv->label_widget);
1184 g_object_ref_sink (label_widget);
1186 button->priv->label_widget = label_widget;
1187 button->priv->contents_invalid = TRUE;
1189 g_object_notify (G_OBJECT (button), "label-widget");
1194 * gtk_tool_button_get_label_widget:
1195 * @button: a #GtkToolButton
1197 * Returns the widget used as label on @button. See
1198 * gtk_tool_button_set_label_widget().
1200 * Return value: The widget used as label on @button, or %NULL.
1205 gtk_tool_button_get_label_widget (GtkToolButton *button)
1207 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1209 return button->priv->label_widget;
1213 * gtk_tool_button_get_icon_widget:
1214 * @button: a #GtkToolButton
1216 * Return the widget used as icon widget on @button. See
1217 * gtk_tool_button_set_icon_widget().
1219 * Return value: The widget used as icon on @button, or %NULL.
1224 gtk_tool_button_get_icon_widget (GtkToolButton *button)
1226 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1228 return button->priv->icon_widget;
1232 _gtk_tool_button_get_button (GtkToolButton *button)
1234 g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1236 return button->priv->button;
1240 #define __GTK_TOOL_BUTTON_C__
1241 #include "gtkaliasdef.c"