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