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