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