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