]> Pileus Git - ~andy/gtk/blob - gtk/gtktoolbutton.c
Use G_OBJECT_WARN_INVALID_PROPERTY_ID consistently. Fixes #5075
[~andy/gtk] / gtk / gtktoolbutton.c
1 /* gtktoolbutton.c
2  *
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>
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 #include <config.h>
24 #include "gtktoolbutton.h"
25 #include "gtkbutton.h"
26 #include "gtkhbox.h"
27 #include "gtkiconfactory.h"
28 #include "gtkimage.h"
29 #include "gtkimagemenuitem.h"
30 #include "gtklabel.h"
31 #include "gtkstock.h"
32 #include "gtkvbox.h"
33 #include "gtkintl.h"
34 #include "gtktoolbar.h"
35 #include "gtkprivate.h"
36 #include "gtkalias.h"
37
38 #include <string.h>
39
40 #define MENU_ID "gtk-tool-button-menu-id"
41
42 enum {
43   CLICKED,
44   LAST_SIGNAL
45 };
46
47 enum {
48   PROP_0,
49   PROP_LABEL,
50   PROP_USE_UNDERLINE,
51   PROP_LABEL_WIDGET,
52   PROP_STOCK_ID,
53   PROP_ICON_NAME,
54   PROP_ICON_WIDGET
55 };
56
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,
61                                            guint               prop_id,
62                                            const GValue       *value,
63                                            GParamSpec         *pspec);
64 static void gtk_tool_button_get_property  (GObject            *object,
65                                            guint               prop_id,
66                                            GValue             *value,
67                                            GParamSpec         *pspec);
68 static void gtk_tool_button_property_notify (GObject          *object,
69                                              GParamSpec       *pspec);
70 static void gtk_tool_button_finalize      (GObject            *object);
71
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);
78
79 static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);
80       
81 static GObjectClass *parent_class = NULL;
82 static guint         toolbutton_signals[LAST_SIGNAL] = { 0 };
83
84 #define GTK_TOOL_BUTTON_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonPrivate))
85
86 struct _GtkToolButtonPrivate
87 {
88   GtkWidget *button;
89
90   gchar *stock_id;
91   gchar *icon_name;
92   gchar *label_text;
93   GtkWidget *label_widget;
94   GtkWidget *icon_widget;
95   
96   guint use_underline : 1;
97   guint contents_invalid : 1;
98 };
99
100 GType
101 gtk_tool_button_get_type (void)
102 {
103   static GtkType type = 0;
104
105   if (!type)
106     type = g_type_register_static_simple (GTK_TYPE_TOOL_ITEM,
107                                           I_("GtkToolButton"),
108                                           sizeof (GtkToolButtonClass),
109                                           (GClassInitFunc) gtk_tool_button_class_init,
110                                           sizeof (GtkToolButton),
111                                           (GInstanceInitFunc) gtk_tool_button_init,
112                                           0);
113   return type;
114 }
115
116 static void
117 gtk_tool_button_class_init (GtkToolButtonClass *klass)
118 {
119   GObjectClass *object_class;
120   GtkWidgetClass *widget_class;
121   GtkToolItemClass *tool_item_class;
122   
123   parent_class = g_type_class_peek_parent (klass);
124   
125   object_class = (GObjectClass *)klass;
126   widget_class = (GtkWidgetClass *)klass;
127   tool_item_class = (GtkToolItemClass *)klass;
128   
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;
133
134   widget_class->style_set = gtk_tool_button_style_set;
135
136   tool_item_class->create_menu_proxy = gtk_tool_button_create_menu_proxy;
137   tool_item_class->toolbar_reconfigured = gtk_tool_button_toolbar_reconfigured;
138   
139   klass->button_type = GTK_TYPE_BUTTON;
140
141   /* Properties are interpreted like this:
142    *
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.
149    *
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.
157    *
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).
161    *
162    *            In that case, if use_underline is set,
163    *
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
167    *
168    *                    - an underscore indicates that the next character when
169    *                      used in the overflow menu should be used as a
170    *                      mnemonic.
171    *
172    *            In short: use_underline = TRUE means that the label text has
173    *            the form "_Open" and the toolbar should take appropriate
174    *            action.
175    */
176
177   g_object_class_install_property (object_class,
178                                    PROP_LABEL,
179                                    g_param_spec_string ("label",
180                                                         P_("Label"),
181                                                         P_("Text to show in the item."),
182                                                         NULL,
183                                                         GTK_PARAM_READWRITE));
184   g_object_class_install_property (object_class,
185                                    PROP_USE_UNDERLINE,
186                                    g_param_spec_boolean ("use-underline",
187                                                          P_("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"),
189                                                          FALSE,
190                                                          GTK_PARAM_READWRITE));
191   g_object_class_install_property (object_class,
192                                    PROP_LABEL_WIDGET,
193                                    g_param_spec_object ("label-widget",
194                                                         P_("Label widget"),
195                                                         P_("Widget to use as the item label"),
196                                                         GTK_TYPE_WIDGET,
197                                                         GTK_PARAM_READWRITE));
198   g_object_class_install_property (object_class,
199                                    PROP_STOCK_ID,
200                                    g_param_spec_string ("stock-id",
201                                                         P_("Stock Id"),
202                                                         P_("The stock icon displayed on the item"),
203                                                         NULL,
204                                                         GTK_PARAM_READWRITE));
205
206   /**
207    * GtkToolButton:icon-name:
208    * 
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.
212    *
213    * Since: 2.8 
214    */
215   g_object_class_install_property (object_class,
216                                    PROP_ICON_NAME,
217                                    g_param_spec_string ("icon-name",
218                                                         P_("Icon name"),
219                                                         P_("The name of the themed icon displayed on the item"),
220                                                         NULL,
221                                                         GTK_PARAM_READWRITE));
222   g_object_class_install_property (object_class,
223                                    PROP_ICON_WIDGET,
224                                    g_param_spec_object ("icon-widget",
225                                                         P_("Icon widget"),
226                                                         P_("Icon widget to display in the item"),
227                                                         GTK_TYPE_WIDGET,
228                                                         GTK_PARAM_READWRITE));
229
230   /**
231    * GtkButton:icon-spacing:
232    * 
233    * Spacing in pixels between the icon and label.
234    * 
235    * Since: 2.10
236    */
237   gtk_widget_class_install_style_property (widget_class,
238                                            g_param_spec_int ("icon-spacing",
239                                                              P_("Icon spacing"),
240                                                              P_("Spacing in pixels between the icon and label"),
241                                                              0,
242                                                              G_MAXINT,
243                                                              0,
244                                                              GTK_PARAM_READWRITE));
245
246 /**
247  * GtkToolButton::clicked:
248  * @toolbutton: the object that emitted the signal
249  *
250  * This signal is emitted when the tool button is clicked with the mouse
251  * or activated with the keyboard.
252  **/
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),
258                   NULL, NULL,
259                   g_cclosure_marshal_VOID__VOID,
260                   G_TYPE_NONE, 0);
261   
262   g_type_class_add_private (object_class, sizeof (GtkToolButtonPrivate));
263 }
264
265 static void
266 gtk_tool_button_init (GtkToolButton      *button,
267                       GtkToolButtonClass *klass)
268 {
269   GtkToolItem *toolitem = GTK_TOOL_ITEM (button);
270   
271   button->priv = GTK_TOOL_BUTTON_GET_PRIVATE (button);
272
273   button->priv->contents_invalid = TRUE;
274
275   gtk_tool_item_set_homogeneous (toolitem, TRUE);
276
277   /* create button */
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);
282
283   gtk_container_add (GTK_CONTAINER (button), button->priv->button);
284   gtk_widget_show (button->priv->button);
285 }
286
287 static void
288 gtk_tool_button_construct_contents (GtkToolItem *tool_item)
289 {
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;
298   guint icon_spacing;
299
300   button->priv->contents_invalid = FALSE;
301
302   gtk_widget_style_get (GTK_WIDGET (tool_item), 
303                         "icon-spacing", &icon_spacing,
304                         NULL);
305
306   if (button->priv->icon_widget && button->priv->icon_widget->parent)
307     {
308       gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
309                             button->priv->icon_widget);
310     }
311
312   if (button->priv->label_widget && button->priv->label_widget->parent)
313     {
314       gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
315                             button->priv->label_widget);
316     }
317
318   if (GTK_BIN (button->priv->button)->child)
319     {
320       /* Note: we are not destroying the label_widget or icon_widget
321        * here because they were removed from their containers above
322        */
323       gtk_widget_destroy (GTK_BIN (button->priv->button)->child);
324     }
325
326   style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
327   
328   if (style != GTK_TOOLBAR_TEXT)
329     need_icon = TRUE;
330
331   if (style != GTK_TOOLBAR_ICONS && style != GTK_TOOLBAR_BOTH_HORIZ)
332     need_label = TRUE;
333
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))
337     {
338       need_label = TRUE;
339     }
340   
341   if (style == GTK_TOOLBAR_ICONS && button->priv->icon_widget == NULL &&
342       button->priv->stock_id == NULL && button->priv->icon_name == NULL)
343     {
344       need_label = TRUE;
345       need_icon = FALSE;
346       style = GTK_TOOLBAR_TEXT;
347     }
348
349   if (style == GTK_TOOLBAR_TEXT && button->priv->label_widget == NULL &&
350       button->priv->stock_id == NULL && button->priv->label_text == NULL)
351     {
352       need_label = FALSE;
353       need_icon = TRUE;
354       style = GTK_TOOLBAR_ICONS;
355     }
356
357   if (need_label)
358     {
359       if (button->priv->label_widget)
360         {
361           label = button->priv->label_widget;
362         }
363       else
364         {
365           GtkStockItem stock_item;
366           gboolean elide;
367           gchar *label_text;
368
369           if (button->priv->label_text)
370             {
371               label_text = button->priv->label_text;
372               elide = button->priv->use_underline;
373             }
374           else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
375             {
376               label_text = stock_item.label;
377               elide = TRUE;
378             }
379           else
380             {
381               label_text = "";
382               elide = FALSE;
383             }
384
385           if (elide)
386             label_text = _gtk_toolbar_elide_underscores (label_text);
387           else
388             label_text = g_strdup (label_text);
389
390           label = gtk_label_new (label_text);
391
392           g_free (label_text);
393           
394           gtk_widget_show (label);
395         }
396     }
397
398   icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
399   if (need_icon)
400     {
401       if (button->priv->icon_widget)
402         {
403           icon = button->priv->icon_widget;
404           
405           if (GTK_IS_IMAGE (icon))
406             {
407               g_object_set (button->priv->icon_widget,
408                             "icon-size", icon_size,
409                             NULL);
410             }
411         }
412       else if (button->priv->stock_id && 
413                gtk_icon_factory_lookup_default (button->priv->stock_id))
414         {
415           icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
416           gtk_widget_show (icon);
417         }
418       else if (button->priv->icon_name)
419         {
420           icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
421           gtk_widget_show (icon);
422         }
423     }
424
425   switch (style)
426     {
427     case GTK_TOOLBAR_ICONS:
428       if (icon)
429         gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
430       break;
431
432     case GTK_TOOLBAR_BOTH:
433       box = gtk_vbox_new (FALSE, icon_spacing);
434       if (icon)
435         gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
436       gtk_box_pack_start (GTK_BOX (box), label, FALSE, TRUE, 0);
437       gtk_container_add (GTK_CONTAINER (button->priv->button), box);
438       break;
439
440     case GTK_TOOLBAR_BOTH_HORIZ:
441       box = gtk_hbox_new (FALSE, icon_spacing);
442       if (icon)
443         gtk_box_pack_start (GTK_BOX (box), icon, label? FALSE : TRUE, TRUE, 0);
444       if (label)
445         gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
446       gtk_container_add (GTK_CONTAINER (button->priv->button), box);
447       break;
448
449     case GTK_TOOLBAR_TEXT:
450       gtk_container_add (GTK_CONTAINER (button->priv->button), label);
451       break;
452     }
453
454   if (box)
455     gtk_widget_show (box);
456
457   gtk_button_set_relief (GTK_BUTTON (button->priv->button),
458                          gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
459
460   gtk_tool_item_rebuild_menu (tool_item);
461   
462   gtk_widget_queue_resize (GTK_WIDGET (button));
463 }
464
465 static void
466 gtk_tool_button_set_property (GObject         *object,
467                               guint            prop_id,
468                               const GValue    *value,
469                               GParamSpec      *pspec)
470 {
471   GtkToolButton *button = GTK_TOOL_BUTTON (object);
472   
473   switch (prop_id)
474     {
475     case PROP_LABEL:
476       gtk_tool_button_set_label (button, g_value_get_string (value));
477       break;
478     case PROP_USE_UNDERLINE:
479       gtk_tool_button_set_use_underline (button, g_value_get_boolean (value));
480       break;
481     case PROP_LABEL_WIDGET:
482       gtk_tool_button_set_label_widget (button, g_value_get_object (value));
483       break;
484     case PROP_STOCK_ID:
485       gtk_tool_button_set_stock_id (button, g_value_get_string (value));
486       break;
487     case PROP_ICON_NAME:
488       gtk_tool_button_set_icon_name (button, g_value_get_string (value));
489       break;
490     case PROP_ICON_WIDGET:
491       gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
492       break;
493     default:
494       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
495       break;
496     }
497 }
498
499 static void
500 gtk_tool_button_property_notify (GObject          *object,
501                                  GParamSpec       *pspec)
502 {
503   GtkToolButton *button = GTK_TOOL_BUTTON (object);
504
505   if (button->priv->contents_invalid ||
506       strcmp ("is-important", pspec->name) == 0)
507     gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
508
509   if (parent_class->notify)
510     parent_class->notify (object, pspec);
511 }
512
513 static void
514 gtk_tool_button_get_property (GObject         *object,
515                               guint            prop_id,
516                               GValue          *value,
517                               GParamSpec      *pspec)
518 {
519   GtkToolButton *button = GTK_TOOL_BUTTON (object);
520
521   switch (prop_id)
522     {
523     case PROP_LABEL:
524       g_value_set_string (value, gtk_tool_button_get_label (button));
525       break;
526     case PROP_LABEL_WIDGET:
527       g_value_set_object (value, gtk_tool_button_get_label_widget (button));
528       break;
529     case PROP_USE_UNDERLINE:
530       g_value_set_boolean (value, gtk_tool_button_get_use_underline (button));
531       break;
532     case PROP_STOCK_ID:
533       g_value_set_string (value, button->priv->stock_id);
534       break;
535     case PROP_ICON_NAME:
536       g_value_set_string (value, button->priv->icon_name);
537       break;
538     case PROP_ICON_WIDGET:
539       g_value_set_object (value, button->priv->icon_widget);
540       break;
541     default:
542       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
543       break;
544     }
545 }
546
547 static void
548 gtk_tool_button_finalize (GObject *object)
549 {
550   GtkToolButton *button = GTK_TOOL_BUTTON (object);
551
552   g_free (button->priv->stock_id);
553   g_free (button->priv->icon_name);
554   g_free (button->priv->label_text);
555
556   if (button->priv->label_widget)
557     g_object_unref (button->priv->label_widget);
558
559   if (button->priv->icon_widget)
560     g_object_unref (button->priv->icon_widget);
561   
562   parent_class->finalize (object);
563 }
564
565 static GtkWidget *
566 clone_image_menu_size (GtkImage *image, GtkSettings *settings)
567 {
568   GtkImageType storage_type = gtk_image_get_storage_type (image);
569
570   if (storage_type == GTK_IMAGE_STOCK)
571     {
572       gchar *stock_id;
573       gtk_image_get_stock (image, &stock_id, NULL);
574       return gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
575     }
576   else if (storage_type == GTK_IMAGE_ICON_SET)
577     {
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);
581     }
582   else if (storage_type == GTK_IMAGE_PIXBUF)
583     {
584       gint width, height;
585       
586       if (settings &&
587           gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
588                                              &width, &height))
589         {
590           GdkPixbuf *src_pixbuf, *dest_pixbuf;
591           GtkWidget *cloned_image;
592
593           src_pixbuf = gtk_image_get_pixbuf (image);
594           dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
595                                                  GDK_INTERP_BILINEAR);
596
597           cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
598           g_object_unref (dest_pixbuf);
599
600           return cloned_image;
601         }
602     }
603
604   return NULL;
605 }
606       
607 static gboolean
608 gtk_tool_button_create_menu_proxy (GtkToolItem *item)
609 {
610   GtkToolButton *button = GTK_TOOL_BUTTON (item);
611   GtkWidget *menu_item;
612   GtkWidget *menu_image = NULL;
613   GtkStockItem stock_item;
614   gboolean use_mnemonic = TRUE;
615   const char *label;
616
617   if (button->priv->label_widget && GTK_IS_LABEL (button->priv->label_widget))
618     {
619       label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
620       use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
621     }
622   else if (button->priv->label_text)
623     {
624       label = button->priv->label_text;
625       use_mnemonic = button->priv->use_underline;
626     }
627   else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
628     {
629       label = stock_item.label;
630     }
631   else
632     {
633       label = "";
634     }
635   
636   if (use_mnemonic)
637     menu_item = gtk_image_menu_item_new_with_mnemonic (label);
638   else
639     menu_item = gtk_image_menu_item_new_with_label (label);
640
641   if (button->priv->icon_widget && GTK_IS_IMAGE (button->priv->icon_widget))
642     {
643       menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget),
644                                           gtk_widget_get_settings (GTK_WIDGET (button)));
645     }
646   else if (button->priv->stock_id)
647     {
648       menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
649     }
650
651   if (menu_image)
652     gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item), menu_image);
653
654   g_signal_connect_closure_by_id (menu_item,
655                                   g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
656                                   g_cclosure_new_object_swap (G_CALLBACK (gtk_button_clicked),
657                                                               G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
658                                   FALSE);
659
660   gtk_tool_item_set_proxy_menu_item (GTK_TOOL_ITEM (button), MENU_ID, menu_item);
661   
662   return TRUE;
663 }
664
665 static void
666 button_clicked (GtkWidget     *widget,
667                 GtkToolButton *button)
668 {
669   g_signal_emit_by_name (button, "clicked");
670 }
671
672 static void
673 gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item)
674 {
675   gtk_tool_button_construct_contents (tool_item);
676 }
677
678 static void 
679 gtk_tool_button_update_icon_spacing (GtkToolButton *button)
680 {
681   GtkWidget *box;
682   guint spacing;
683
684   box = GTK_BIN (button->priv->button)->child;
685   if (GTK_IS_BOX (box))
686     {
687       gtk_widget_style_get (GTK_WIDGET (button), 
688                             "icon-spacing", &spacing,
689                             NULL);
690       gtk_box_set_spacing (GTK_BOX (box), spacing);      
691     }
692 }
693
694 static void
695 gtk_tool_button_style_set (GtkWidget *widget,
696                            GtkStyle  *prev_style)
697 {
698   gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
699 }
700
701 /**
702  * gtk_tool_button_new_from_stock:
703  * @stock_id: the name of the stock item 
704  *
705  * Creates a new #GtkToolButton containing the image and text from a
706  * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
707  * and #GTK_STOCK_APPLY.
708  *
709  * It is an error if @stock_id is not a name of a stock item.
710  * 
711  * Return value: A new #GtkToolButton
712  * 
713  * Since: 2.4
714  **/
715 GtkToolItem *
716 gtk_tool_button_new_from_stock (const gchar *stock_id)
717 {
718   GtkToolButton *button;
719
720   g_return_val_if_fail (stock_id != NULL, NULL);
721     
722   button = g_object_new (GTK_TYPE_TOOL_BUTTON,
723                          "stock-id", stock_id,
724                          NULL);
725
726   return GTK_TOOL_ITEM (button);
727 }
728
729 /**
730  * gtk_tool_button_new:
731  * @label: a string that will be used as label, or %NULL
732  * @icon_widget: a widget that will be used as icon widget, or %NULL
733  * 
734  * Creates a new %GtkToolButton using @icon_widget as icon and @label as
735  * label.
736  * 
737  * Return value: A new #GtkToolButton
738  * 
739  * Since: 2.4
740  **/
741 GtkToolItem *
742 gtk_tool_button_new (GtkWidget   *icon_widget,
743                      const gchar *label)
744 {
745   GtkToolButton *button;
746
747   button = g_object_new (GTK_TYPE_TOOL_BUTTON,
748                          "label", label,
749                          "icon-widget", icon_widget,
750                          NULL);
751
752   return GTK_TOOL_ITEM (button);  
753 }
754
755 /**
756  * gtk_tool_button_set_label:
757  * @button: a #GtkToolButton
758  * @label: a string that will be used as label, or %NULL.
759  * 
760  * Sets @label as the label used for the tool button. The "label" property
761  * only has an effect if not overridden by a non-%NULL "label_widget" property.
762  * If both the "label_widget" and "label" properties are %NULL, the label
763  * is determined by the "stock_id" property. If the "stock_id" property is also
764  * %NULL, @button will not have a label.
765  * 
766  * Since: 2.4
767  **/
768 void
769 gtk_tool_button_set_label (GtkToolButton *button,
770                            const gchar   *label)
771 {
772   gchar *old_label;
773   
774   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
775
776   old_label = button->priv->label_text;
777
778   button->priv->label_text = g_strdup (label);
779   button->priv->contents_invalid = TRUE;     
780
781   g_free (old_label);
782  
783   g_object_notify (G_OBJECT (button), "label");
784 }
785
786 /**
787  * gtk_tool_button_get_label:
788  * @button: a #GtkToolButton
789  * 
790  * Returns the label used by the tool button, or %NULL if the tool button
791  * doesn't have a label. or uses a the label from a stock item. The returned
792  * string is owned by GTK+, and must not be modified or freed.
793  * 
794  * Return value: The label, or %NULL
795  * 
796  * Since: 2.4
797  **/
798 G_CONST_RETURN gchar *
799 gtk_tool_button_get_label (GtkToolButton *button)
800 {
801   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
802
803   return button->priv->label_text;
804 }
805
806 /**
807  * gtk_tool_button_set_use_underline:
808  * @button: a #GtkToolButton
809  * @use_underline: whether the button label has the form "_Open"
810  *
811  * If set, an underline in the label property indicates that the next character
812  * should be used for the mnemonic accelerator key in the overflow menu. For
813  * example, if the label property is "_Open" and @use_underline is %TRUE,
814  * the label on the tool button will be "Open" and the item on the overflow
815  * menu will have an underlined 'O'.
816  * 
817  * Labels shown on tool buttons never have mnemonics on them; this property
818  * only affects the menu item on the overflow menu.
819  * 
820  * Since: 2.4
821  **/
822 void
823 gtk_tool_button_set_use_underline (GtkToolButton *button,
824                                    gboolean       use_underline)
825 {
826   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
827
828   use_underline = use_underline != FALSE;
829
830   if (use_underline != button->priv->use_underline)
831     {
832       button->priv->use_underline = use_underline;
833       button->priv->contents_invalid = TRUE;
834
835       g_object_notify (G_OBJECT (button), "use-underline");
836     }
837 }
838
839 /**
840  * gtk_tool_button_get_use_underline:
841  * @button: a #GtkToolButton
842  * 
843  * Returns whether underscores in the label property are used as mnemonics
844  * on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
845  * 
846  * Return value: %TRUE if underscores in the label property are used as
847  * mnemonics on menu items on the overflow menu.
848  * 
849  * Since: 2.4
850  **/
851 gboolean
852 gtk_tool_button_get_use_underline (GtkToolButton *button)
853 {
854   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);
855
856   return button->priv->use_underline;
857 }
858
859 /**
860  * gtk_tool_button_set_stock_id:
861  * @button: a #GtkToolButton
862  * @stock_id: a name of a stock item, or %NULL
863  * 
864  * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
865  * The stock_id property only has an effect if not
866  * overridden by non-%NULL "label" and "icon_widget" properties.
867  * 
868  * Since: 2.4
869  **/
870 void
871 gtk_tool_button_set_stock_id (GtkToolButton *button,
872                               const gchar   *stock_id)
873 {
874   gchar *old_stock_id;
875   
876   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
877
878   old_stock_id = button->priv->stock_id;
879
880   button->priv->stock_id = g_strdup (stock_id);
881   button->priv->contents_invalid = TRUE;
882
883   g_free (old_stock_id);
884   
885   g_object_notify (G_OBJECT (button), "stock-id");
886 }
887
888 /**
889  * gtk_tool_button_get_stock_id:
890  * @button: a #GtkToolButton
891  * 
892  * Returns the name of the stock item. See gtk_tool_button_set_stock_id().
893  * The returned string is owned by GTK+ and must not be freed or modifed.
894  * 
895  * Return value: the name of the stock item for @button.
896  * 
897  * Since: 2.4
898  **/
899 G_CONST_RETURN gchar *
900 gtk_tool_button_get_stock_id (GtkToolButton *button)
901 {
902   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
903
904   return button->priv->stock_id;
905 }
906
907 /**
908  * gtk_tool_button_set_icon_name
909  * @button: a #GtkToolButton
910  * @icon_name: the name of the themed icon
911  * 
912  * Sets the icon for the tool button from a named themed icon.
913  * See the docs for #GtkIconTheme for more details.
914  * The "icon_name" property only has an effect if not
915  * overridden by non-%NULL "label", "icon_widget" and "stock_id"
916  * properties.
917  * 
918  * Since: 2.8
919  **/
920 void
921 gtk_tool_button_set_icon_name (GtkToolButton *button,
922                                const gchar   *icon_name)
923 {
924   gchar *old_icon_name;
925
926   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
927
928   old_icon_name = button->priv->icon_name;
929
930   button->priv->icon_name = g_strdup (icon_name);
931   button->priv->contents_invalid = TRUE; 
932
933   g_free (old_icon_name);
934
935   g_object_notify (G_OBJECT (button), "icon-name");
936 }
937
938 /**
939  * gtk_tool_button_get_icon_name
940  * @button: a #GtkToolButton
941  * 
942  * Returns the name of the themed icon for the tool button,
943  * see gtk_tool_button_set_icon_name().
944  *
945  * Returns: the icon name or %NULL if the tool button has
946  * no themed icon
947  * 
948  * Since: 2.8
949  **/
950 G_CONST_RETURN gchar*
951 gtk_tool_button_get_icon_name (GtkToolButton *button)
952 {
953   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
954
955   return button->priv->icon_name;
956 }
957
958 /**
959  * gtk_tool_button_set_icon_widget:
960  * @button: a #GtkToolButton
961  * @icon_widget: the widget used as icon, or %NULL
962  * 
963  * Sets @icon as the widget used as icon on @button. If @icon_widget is
964  * %NULL the icon is determined by the "stock_id" property. If the
965  * "stock_id" property is also %NULL, @button will not have an icon.
966  * 
967  * Since: 2.4
968  **/
969 void
970 gtk_tool_button_set_icon_widget (GtkToolButton *button,
971                                  GtkWidget     *icon_widget)
972 {
973   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
974   g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
975
976   if (icon_widget != button->priv->icon_widget)
977     {
978       if (button->priv->icon_widget)
979         {
980           if (button->priv->icon_widget->parent)
981             gtk_container_remove (GTK_CONTAINER (button->priv->icon_widget->parent),
982                                     button->priv->icon_widget);
983
984           g_object_unref (button->priv->icon_widget);
985         }
986       
987       if (icon_widget)
988         g_object_ref_sink (icon_widget);
989
990       button->priv->icon_widget = icon_widget;
991       button->priv->contents_invalid = TRUE;
992       
993       g_object_notify (G_OBJECT (button), "icon-widget");
994     }
995 }
996
997 /**
998  * gtk_tool_button_set_label_widget:
999  * @button: a #GtkToolButton
1000  * @label_widget: the widget used as label, or %NULL
1001  * 
1002  * Sets @label_widget as the widget that will be used as the label
1003  * for @button. If @label_widget is %NULL the "label" property is used
1004  * as label. If "label" is also %NULL, the label in the stock item
1005  * determined by the "stock_id" property is used as label. If
1006  * "stock_id" is also %NULL, @button does not have a label.
1007  * 
1008  * Since: 2.4
1009  **/
1010 void
1011 gtk_tool_button_set_label_widget (GtkToolButton *button,
1012                                   GtkWidget     *label_widget)
1013 {
1014   g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1015   g_return_if_fail (label_widget == NULL || GTK_IS_WIDGET (label_widget));
1016
1017   if (label_widget != button->priv->label_widget)
1018     {
1019       if (button->priv->label_widget)
1020         {
1021           if (button->priv->label_widget->parent)
1022             gtk_container_remove (GTK_CONTAINER (button->priv->label_widget->parent),
1023                                   button->priv->label_widget);
1024           
1025           g_object_unref (button->priv->label_widget);
1026         }
1027       
1028       if (label_widget)
1029         g_object_ref_sink (label_widget);
1030
1031       button->priv->label_widget = label_widget;
1032       button->priv->contents_invalid = TRUE;
1033       
1034       g_object_notify (G_OBJECT (button), "label-widget");
1035     }
1036 }
1037
1038 /**
1039  * gtk_tool_button_get_label_widget:
1040  * @button: a #GtkToolButton
1041  * 
1042  * Returns the widget used as label on @button. See
1043  * gtk_tool_button_set_label_widget().
1044  * 
1045  * Return value: The widget used as label on @button, or %NULL.
1046  * 
1047  * Since: 2.4
1048  **/
1049 GtkWidget *
1050 gtk_tool_button_get_label_widget (GtkToolButton *button)
1051 {
1052   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1053
1054   return button->priv->label_widget;
1055 }
1056
1057 /**
1058  * gtk_tool_button_get_icon_widget:
1059  * @button: a #GtkToolButton
1060  * 
1061  * Return the widget used as icon widget on @button. See
1062  * gtk_tool_button_set_icon_widget().
1063  * 
1064  * Return value: The widget used as icon on @button, or %NULL.
1065  * 
1066  * Since: 2.4
1067  **/
1068 GtkWidget *
1069 gtk_tool_button_get_icon_widget (GtkToolButton *button)
1070 {
1071   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1072
1073   return button->priv->icon_widget;
1074 }
1075
1076 GtkWidget *
1077 _gtk_tool_button_get_button (GtkToolButton *button)
1078 {
1079   g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);
1080
1081   return button->priv->button;
1082 }
1083
1084
1085 #define __GTK_TOOL_BUTTON_C__
1086 #include "gtkaliasdef.c"