gtktoolbutton.c 43.5 KB
Newer Older
1 2
/* gtktoolbutton.c
 *
3
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 5 6 7 8 9 10 11 12 13 14 15 16 17
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 20
 */

21
#include "config.h"
22 23 24
#include "gtktoolbutton.h"
#include "gtkbutton.h"
#include "gtkimage.h"
25
#include "deprecated/gtkimagemenuitem.h"
26
#include "gtklabel.h"
27
#include "deprecated/gtkstock.h"
Matthias Clasen's avatar
Matthias Clasen committed
28
#include "gtkbox.h"
29
#include "gtkintl.h"
30
#include "gtktoolbarprivate.h"
31
#include "deprecated/gtkactivatable.h"
32
#include "gtkactionable.h"
33
#include "gtkprivate.h"
34 35 36

#include <string.h>

37 38 39 40 41 42 43 44

/**
 * SECTION:gtktoolbutton
 * @Short_description: A GtkToolItem subclass that displays buttons
 * @Title: GtkToolButton
 * @See_also: #GtkToolbar, #GtkMenuToolButton, #GtkToggleToolButton,
 *   #GtkRadioToolButton, #GtkSeparatorToolItem
 *
45
 * #GtkToolButtons are #GtkToolItems containing buttons.
46
 *
47
 * Use gtk_tool_button_new() to create a new #GtkToolButton.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
 *
 * The label of a #GtkToolButton is determined by the properties
 * #GtkToolButton:label-widget, #GtkToolButton:label, and
 * #GtkToolButton:stock-id. If #GtkToolButton:label-widget is
 * non-%NULL, then that widget is used as the label. Otherwise, if
 * #GtkToolButton:label is non-%NULL, that string is used as the label.
 * Otherwise, if #GtkToolButton:stock-id is non-%NULL, the label is
 * determined by the stock item. Otherwise, the button does not have a label.
 *
 * The icon of a #GtkToolButton is determined by the properties
 * #GtkToolButton:icon-widget and #GtkToolButton:stock-id. If
 * #GtkToolButton:icon-widget is non-%NULL, then
 * that widget is used as the icon. Otherwise, if #GtkToolButton:stock-id is
 * non-%NULL, the icon is determined by the stock item. Otherwise,
 * the button does not have a icon.
 */


66 67 68 69 70 71 72 73 74 75 76 77 78
#define MENU_ID "gtk-tool-button-menu-id"

enum {
  CLICKED,
  LAST_SIGNAL
};

enum {
  PROP_0,
  PROP_LABEL,
  PROP_USE_UNDERLINE,
  PROP_LABEL_WIDGET,
  PROP_STOCK_ID,
79
  PROP_ICON_NAME,
80 81 82
  PROP_ICON_WIDGET,
  PROP_ACTION_NAME,
  PROP_ACTION_TARGET
83 84
};

85 86 87
static void gtk_tool_button_init          (GtkToolButton      *button,
					   GtkToolButtonClass *klass);
static void gtk_tool_button_class_init    (GtkToolButtonClass *klass);
88 89 90 91 92 93 94 95
static void gtk_tool_button_set_property  (GObject            *object,
					   guint               prop_id,
					   const GValue       *value,
					   GParamSpec         *pspec);
static void gtk_tool_button_get_property  (GObject            *object,
					   guint               prop_id,
					   GValue             *value,
					   GParamSpec         *pspec);
96 97
static void gtk_tool_button_property_notify (GObject          *object,
					     GParamSpec       *pspec);
98 99 100 101 102 103
static void gtk_tool_button_finalize      (GObject            *object);

static void gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item);
static gboolean   gtk_tool_button_create_menu_proxy (GtkToolItem     *item);
static void       button_clicked                    (GtkWidget       *widget,
						     GtkToolButton   *button);
104
static void gtk_tool_button_style_updated  (GtkWidget          *widget);
105 106 107

static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);

108
static void gtk_tool_button_actionable_iface_init      (GtkActionableInterface *iface);
109
static void gtk_tool_button_activatable_interface_init (GtkActivatableIface  *iface);
110
static void gtk_tool_button_update                     (GtkActivatable       *activatable,
111 112
							GtkAction            *action,
							const gchar          *property_name);
113
static void gtk_tool_button_sync_action_properties     (GtkActivatable       *activatable,
114 115
							GtkAction            *action);

Matthias Clasen's avatar
Matthias Clasen committed
116

117 118 119 120 121
struct _GtkToolButtonPrivate
{
  GtkWidget *button;

  gchar *stock_id;
122
  gchar *icon_name;
123 124 125
  gchar *label_text;
  GtkWidget *label_widget;
  GtkWidget *icon_widget;
126 127 128

  GtkSizeGroup *text_size_group;

129
  guint use_underline : 1;
130
  guint contents_invalid : 1;
131 132
};

133
static GObjectClass        *parent_class = NULL;
134 135 136
static GtkActivatableIface *parent_activatable_iface;
static guint                toolbutton_signals[LAST_SIGNAL] = { 0 };

137 138 139 140
GType
gtk_tool_button_get_type (void)
{
  static GType g_define_type_id = 0;
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
  if (!g_define_type_id)
    {
      const GInterfaceInfo actionable_info =
      {
        (GInterfaceInitFunc) gtk_tool_button_actionable_iface_init,
        (GInterfaceFinalizeFunc) NULL,
        NULL
      };
      const GInterfaceInfo activatable_info =
      {
        (GInterfaceInitFunc) gtk_tool_button_activatable_interface_init,
        (GInterfaceFinalizeFunc) NULL,
        NULL
      };

      g_define_type_id = g_type_register_static_simple (GTK_TYPE_TOOL_ITEM,
                                                        I_("GtkToolButton"),
                                                        sizeof (GtkToolButtonClass),
                                                        (GClassInitFunc) gtk_tool_button_class_init,
                                                        sizeof (GtkToolButton),
                                                        (GInstanceInitFunc) gtk_tool_button_init,
                                                        0);
164

165 166 167 168 169 170 171 172 173
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
      g_type_add_interface_static (g_define_type_id,
                                   GTK_TYPE_ACTIONABLE, &actionable_info);
      g_type_add_interface_static (g_define_type_id,
                                   GTK_TYPE_ACTIVATABLE, &activatable_info);
      G_GNUC_END_IGNORE_DEPRECATIONS;
    }
  return g_define_type_id;
}
174 175 176 177 178

static void
gtk_tool_button_class_init (GtkToolButtonClass *klass)
{
  GObjectClass *object_class;
179
  GtkWidgetClass *widget_class;
180 181
  GtkToolItemClass *tool_item_class;
  
182 183
  parent_class = g_type_class_peek_parent (klass);
  
184
  object_class = (GObjectClass *)klass;
185
  widget_class = (GtkWidgetClass *)klass;
186 187 188 189
  tool_item_class = (GtkToolItemClass *)klass;
  
  object_class->set_property = gtk_tool_button_set_property;
  object_class->get_property = gtk_tool_button_get_property;
190
  object_class->notify = gtk_tool_button_property_notify;
191 192
  object_class->finalize = gtk_tool_button_finalize;

193
  widget_class->style_updated = gtk_tool_button_style_updated;
194

195 196 197 198 199
  tool_item_class->create_menu_proxy = gtk_tool_button_create_menu_proxy;
  tool_item_class->toolbar_reconfigured = gtk_tool_button_toolbar_reconfigured;
  
  klass->button_type = GTK_TYPE_BUTTON;

200 201 202 203 204
  /* Properties are interpreted like this:
   *
   *          - if the tool button has an icon_widget, then that widget
   *            will be used as the icon. Otherwise, if the tool button
   *            has a stock id, the corresponding stock icon will be
205 206 207
   *            used. Otherwise, if the tool button has an icon name,
   *            the corresponding icon from the theme will be used.
   *            Otherwise, the tool button will not have an icon.
208 209 210 211 212
   *
   *          - if the tool button has a label_widget then that widget
   *            will be used as the label. Otherwise, if the tool button
   *            has a label text, that text will be used as label. Otherwise,
   *            if the toolbutton has a stock id, the corresponding text
213 214 215
   *            will be used as label. Otherwise, if the tool button has
   *            an icon name, the corresponding icon name from the theme will
   *            be used. Otherwise, the toolbutton will have an empty label.
216 217 218 219 220 221 222 223 224 225 226 227
   *
   *	      - The use_underline property only has an effect when the label
   *            on the toolbutton comes from the label property (ie. not from
   *            label_widget or from stock_id).
   *
   *            In that case, if use_underline is set,
   *
   *			- underscores are removed from the label text before
   *                      the label is shown on the toolbutton unless the
   *                      underscore is followed by another underscore
   *
   *			- an underscore indicates that the next character when
228 229
   *                      used in the overflow menu should be used as a
   *                      mnemonic.
230 231
   *
   *		In short: use_underline = TRUE means that the label text has
232 233
   *            the form "_Open" and the toolbar should take appropriate
   *            action.
234 235
   */

236 237 238
  g_object_class_install_property (object_class,
				   PROP_LABEL,
				   g_param_spec_string ("label",
239 240
							P_("Label"),
							P_("Text to show in the item."),
241
							NULL,
242
							GTK_PARAM_READWRITE));
243 244
  g_object_class_install_property (object_class,
				   PROP_USE_UNDERLINE,
245
				   g_param_spec_boolean ("use-underline",
246 247
							 P_("Use underline"),
							 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"),
248
							 FALSE,
249
							 GTK_PARAM_READWRITE));
250 251
  g_object_class_install_property (object_class,
				   PROP_LABEL_WIDGET,
252
				   g_param_spec_object ("label-widget",
253 254
							P_("Label widget"),
							P_("Widget to use as the item label"),
255
							GTK_TYPE_WIDGET,
256
							GTK_PARAM_READWRITE));
257 258 259 260 261
  /**
   * GtkToolButton:stock-id:
   *
   * Deprecated: 3.10: Use #GtkToolButton:icon-name instead.
   */
262 263
  g_object_class_install_property (object_class,
				   PROP_STOCK_ID,
264
				   g_param_spec_string ("stock-id",
265 266
							P_("Stock Id"),
							P_("The stock icon displayed on the item"),
267
							NULL,
268
							GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285

  /**
   * GtkToolButton:icon-name:
   * 
   * The name of the themed icon displayed on the item.
   * This property only has an effect if not overridden by "label", 
   * "icon_widget" or "stock_id" properties.
   *
   * Since: 2.8 
   */
  g_object_class_install_property (object_class,
				   PROP_ICON_NAME,
				   g_param_spec_string ("icon-name",
							P_("Icon name"),
							P_("The name of the themed icon displayed on the item"),
							NULL,
							GTK_PARAM_READWRITE));
286 287
  g_object_class_install_property (object_class,
				   PROP_ICON_WIDGET,
288
				   g_param_spec_object ("icon-widget",
289 290
							P_("Icon widget"),
							P_("Icon widget to display in the item"),
291
							GTK_TYPE_WIDGET,
292
							GTK_PARAM_READWRITE));
293

294 295 296
  g_object_class_override_property (object_class, PROP_ACTION_NAME, "action-name");
  g_object_class_override_property (object_class, PROP_ACTION_TARGET, "action-target");

297
  /**
298
   * GtkButton:icon-spacing:
299 300 301 302 303 304 305 306 307 308 309
   * 
   * Spacing in pixels between the icon and label.
   * 
   * Since: 2.10
   */
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("icon-spacing",
							     P_("Icon spacing"),
							     P_("Spacing in pixels between the icon and label"),
							     0,
							     G_MAXINT,
310
							     3,
311 312
							     GTK_PARAM_READWRITE));

313 314 315 316 317 318 319
/**
 * GtkToolButton::clicked:
 * @toolbutton: the object that emitted the signal
 *
 * This signal is emitted when the tool button is clicked with the mouse
 * or activated with the keyboard.
 **/
320
  toolbutton_signals[CLICKED] =
321
    g_signal_new (I_("clicked"),
322
		  G_OBJECT_CLASS_TYPE (klass),
323
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
324 325 326 327
		  G_STRUCT_OFFSET (GtkToolButtonClass, clicked),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
328 329
  
  g_type_class_add_private (object_class, sizeof (GtkToolButtonPrivate));
330 331 332
}

static void
333 334
gtk_tool_button_init (GtkToolButton      *button,
		      GtkToolButtonClass *klass)
335 336
{
  GtkToolItem *toolitem = GTK_TOOL_ITEM (button);
337

338 339 340
  button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
                                              GTK_TYPE_TOOL_BUTTON,
                                              GtkToolButtonPrivate);
341

342 343
  button->priv->contents_invalid = TRUE;

344
  gtk_tool_item_set_homogeneous (toolitem, TRUE);
345 346

  /* create button */
347
  button->priv->button = g_object_new (klass->button_type, NULL);
348 349
  gtk_button_set_focus_on_click (GTK_BUTTON (button->priv->button), FALSE);
  g_signal_connect_object (button->priv->button, "clicked",
350 351
			   G_CALLBACK (button_clicked), button, 0);

352 353
  gtk_container_add (GTK_CONTAINER (button), button->priv->button);
  gtk_widget_show (button->priv->button);
354 355 356 357 358 359
}

static void
gtk_tool_button_construct_contents (GtkToolItem *tool_item)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (tool_item);
Javier Jardón's avatar
Javier Jardón committed
360
  GtkWidget *child;
361 362 363 364 365 366 367
  GtkWidget *label = NULL;
  GtkWidget *icon = NULL;
  GtkToolbarStyle style;
  gboolean need_label = FALSE;
  gboolean need_icon = FALSE;
  GtkIconSize icon_size;
  GtkWidget *box = NULL;
368
  guint icon_spacing;
369 370
  GtkOrientation text_orientation = GTK_ORIENTATION_HORIZONTAL;
  GtkSizeGroup *size_group = NULL;
371
  GtkWidget *parent;
372

373 374
  button->priv->contents_invalid = FALSE;

375 376 377
  gtk_widget_style_get (GTK_WIDGET (tool_item), 
			"icon-spacing", &icon_spacing,
			NULL);
378

379
  if (button->priv->icon_widget)
380
    {
381 382 383 384 385 386
      parent = gtk_widget_get_parent (button->priv->icon_widget);
      if (parent)
        {
          gtk_container_remove (GTK_CONTAINER (parent),
                                button->priv->icon_widget);
        }
387 388
    }

389
  if (button->priv->label_widget)
390
    {
391 392 393 394 395 396
      parent = gtk_widget_get_parent (button->priv->label_widget);
      if (parent)
        {
          gtk_container_remove (GTK_CONTAINER (parent),
                                button->priv->label_widget);
        }
397 398
    }

Javier Jardón's avatar
Javier Jardón committed
399 400
  child = gtk_bin_get_child (GTK_BIN (button->priv->button));
  if (child)
401
    {
402 403 404
      /* Note: we are not destroying the label_widget or icon_widget
       * here because they were removed from their containers above
       */
Javier Jardón's avatar
Javier Jardón committed
405
      gtk_widget_destroy (child);
406 407 408 409 410 411
    }

  style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
  
  if (style != GTK_TOOLBAR_TEXT)
    need_icon = TRUE;
412 413 414 415 416 417

  if (style != GTK_TOOLBAR_ICONS && style != GTK_TOOLBAR_BOTH_HORIZ)
    need_label = TRUE;

  if (style == GTK_TOOLBAR_BOTH_HORIZ &&
      (gtk_tool_item_get_is_important (GTK_TOOL_ITEM (button)) ||
418 419
       gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL ||
       gtk_tool_item_get_text_orientation (GTK_TOOL_ITEM (button)) == GTK_ORIENTATION_VERTICAL))
420 421 422
    {
      need_label = TRUE;
    }
423
  
424
  if (style != GTK_TOOLBAR_TEXT && button->priv->icon_widget == NULL &&
425 426 427 428 429 430 431 432 433 434 435 436 437 438
      button->priv->stock_id == NULL && button->priv->icon_name == NULL)
    {
      need_label = TRUE;
      need_icon = FALSE;
      style = GTK_TOOLBAR_TEXT;
    }

  if (style == GTK_TOOLBAR_TEXT && button->priv->label_widget == NULL &&
      button->priv->stock_id == NULL && button->priv->label_text == NULL)
    {
      need_label = FALSE;
      need_icon = TRUE;
      style = GTK_TOOLBAR_ICONS;
    }
439

440 441
  if (need_label)
    {
442
      if (button->priv->label_widget)
443
	{
444
	  label = button->priv->label_widget;
445 446 447 448
	}
      else
	{
	  GtkStockItem stock_item;
449
	  gboolean elide;
450 451
	  gchar *label_text;

452 453
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

454
	  if (button->priv->label_text)
455
	    {
456 457
	      label_text = button->priv->label_text;
	      elide = button->priv->use_underline;
458
	    }
459
	  else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
460 461 462 463
	    {
	      label_text = stock_item.label;
	      elide = TRUE;
	    }
464
	  else
465 466 467 468
	    {
	      label_text = "";
	      elide = FALSE;
	    }
469

470 471
          G_GNUC_END_IGNORE_DEPRECATIONS;

472
	  if (elide)
473
	    label_text = _gtk_toolbar_elide_underscores (label_text);
474 475 476 477 478 479 480 481 482
	  else
	    label_text = g_strdup (label_text);

	  label = gtk_label_new (label_text);

	  g_free (label_text);
	  
	  gtk_widget_show (label);
	}
483

484
      if (GTK_IS_LABEL (label))
485
        {
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
          gtk_label_set_ellipsize (GTK_LABEL (label),
			           gtk_tool_item_get_ellipsize_mode (GTK_TOOL_ITEM (button)));
          text_orientation = gtk_tool_item_get_text_orientation (GTK_TOOL_ITEM (button));
          if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
	    {
              gtk_label_set_angle (GTK_LABEL (label), 0);
              gtk_misc_set_alignment (GTK_MISC (label),
                                      gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)),
                                      0.5);
            }
          else
            {
              gtk_label_set_ellipsize (GTK_LABEL (label), PANGO_ELLIPSIZE_NONE);
	      if (gtk_widget_get_direction (GTK_WIDGET (tool_item)) == GTK_TEXT_DIR_RTL)
	        gtk_label_set_angle (GTK_LABEL (label), -90);
	      else
	        gtk_label_set_angle (GTK_LABEL (label), 90);
              gtk_misc_set_alignment (GTK_MISC (label),
                                      0.5,
                                      1 - gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)));
            }
507
        }
508 509 510 511 512
    }

  icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
  if (need_icon)
    {
513 514 515 516 517 518 519 520 521
      GtkIconSet *icon_set = NULL;

      if (button->priv->stock_id)
        {
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
          icon_set = gtk_icon_factory_lookup_default (button->priv->stock_id);
          G_GNUC_END_IGNORE_DEPRECATIONS;
        }

522
      if (button->priv->icon_widget)
523
	{
524
	  icon = button->priv->icon_widget;
525 526 527
	  
	  if (GTK_IS_IMAGE (icon))
	    {
528
	      g_object_set (button->priv->icon_widget,
529 530
			    "icon-size", icon_size,
			    NULL);
531 532
	    }
	}
533
      else if (icon_set != NULL)
534
	{
535
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
536
	  icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
537
          G_GNUC_END_IGNORE_DEPRECATIONS;
538 539
	  gtk_widget_show (icon);
	}
540 541 542 543 544
      else if (button->priv->icon_name)
	{
	  icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
	  gtk_widget_show (icon);
	}
545

546
      if (GTK_IS_MISC (icon) && text_orientation == GTK_ORIENTATION_HORIZONTAL)
547 548 549
	gtk_misc_set_alignment (GTK_MISC (icon),
				1.0 - gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)),
				0.5);
550
      else if (GTK_IS_MISC (icon))
551 552 553 554 555 556 557 558 559 560
	gtk_misc_set_alignment (GTK_MISC (icon),
				0.5,
				gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button)));

      if (icon)
	{
	  size_group = gtk_tool_item_get_text_size_group (GTK_TOOL_ITEM (button));
	  if (size_group != NULL)
	    gtk_size_group_add_widget (size_group, icon);
	}
561 562 563 564 565 566
    }

  switch (style)
    {
    case GTK_TOOLBAR_ICONS:
      if (icon)
567
	gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
568 569 570
      break;

    case GTK_TOOLBAR_BOTH:
571
      if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
572
	box = gtk_box_new (GTK_ORIENTATION_VERTICAL, icon_spacing);
573
      else
574
	box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, icon_spacing);
575 576
      if (icon)
	gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
577
      gtk_box_pack_end (GTK_BOX (box), label, FALSE, TRUE, 0);
578
      gtk_container_add (GTK_CONTAINER (button->priv->button), box);
579 580 581
      break;

    case GTK_TOOLBAR_BOTH_HORIZ:
582 583
      if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
	{
584
	  box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, icon_spacing);
585 586 587 588 589 590 591
	  if (icon)
	    gtk_box_pack_start (GTK_BOX (box), icon, label? FALSE : TRUE, TRUE, 0);
	  if (label)
	    gtk_box_pack_end (GTK_BOX (box), label, TRUE, TRUE, 0);
	}
      else
	{
592
	  box = gtk_box_new (GTK_ORIENTATION_VERTICAL, icon_spacing);
593 594 595 596 597
	  if (icon)
	    gtk_box_pack_end (GTK_BOX (box), icon, label ? FALSE : TRUE, TRUE, 0);
	  if (label)
	    gtk_box_pack_start (GTK_BOX (box), label, TRUE, TRUE, 0);
	}
598
      gtk_container_add (GTK_CONTAINER (button->priv->button), box);
599 600 601
      break;

    case GTK_TOOLBAR_TEXT:
602
      gtk_container_add (GTK_CONTAINER (button->priv->button), label);
603 604 605 606 607 608
      break;
    }

  if (box)
    gtk_widget_show (box);

609
  gtk_button_set_relief (GTK_BUTTON (button->priv->button),
610 611
			 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));

612 613
  gtk_tool_item_rebuild_menu (tool_item);
  
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  gtk_widget_queue_resize (GTK_WIDGET (button));
}

static void
gtk_tool_button_set_property (GObject         *object,
			      guint            prop_id,
			      const GValue    *value,
			      GParamSpec      *pspec)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (object);
  
  switch (prop_id)
    {
    case PROP_LABEL:
      gtk_tool_button_set_label (button, g_value_get_string (value));
      break;
    case PROP_USE_UNDERLINE:
      gtk_tool_button_set_use_underline (button, g_value_get_boolean (value));
      break;
    case PROP_LABEL_WIDGET:
      gtk_tool_button_set_label_widget (button, g_value_get_object (value));
      break;
    case PROP_STOCK_ID:
637
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
638
      gtk_tool_button_set_stock_id (button, g_value_get_string (value));
639
      G_GNUC_END_IGNORE_DEPRECATIONS;
640
      break;
641 642 643
    case PROP_ICON_NAME:
      gtk_tool_button_set_icon_name (button, g_value_get_string (value));
      break;
644 645 646
    case PROP_ICON_WIDGET:
      gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
      break;
647 648 649 650 651 652
    case PROP_ACTION_NAME:
      g_object_set_property (G_OBJECT (button->priv->button), "action-name", value);
      break;
    case PROP_ACTION_TARGET:
      g_object_set_property (G_OBJECT (button->priv->button), "action-target", value);
      break;
653 654
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
655
      break;
656 657 658
    }
}

659 660 661 662
static void
gtk_tool_button_property_notify (GObject          *object,
				 GParamSpec       *pspec)
{
663 664
  GtkToolButton *button = GTK_TOOL_BUTTON (object);

665 666
  if (button->priv->contents_invalid ||
      strcmp ("is-important", pspec->name) == 0)
667
    gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
668

669 670
  if (parent_class->notify)
    parent_class->notify (object, pspec);
671 672
}

673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
static void
gtk_tool_button_get_property (GObject         *object,
			      guint            prop_id,
			      GValue          *value,
			      GParamSpec      *pspec)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (object);

  switch (prop_id)
    {
    case PROP_LABEL:
      g_value_set_string (value, gtk_tool_button_get_label (button));
      break;
    case PROP_LABEL_WIDGET:
      g_value_set_object (value, gtk_tool_button_get_label_widget (button));
      break;
    case PROP_USE_UNDERLINE:
      g_value_set_boolean (value, gtk_tool_button_get_use_underline (button));
      break;
    case PROP_STOCK_ID:
693
      g_value_set_string (value, button->priv->stock_id);
694
      break;
695 696 697
    case PROP_ICON_NAME:
      g_value_set_string (value, button->priv->icon_name);
      break;
698
    case PROP_ICON_WIDGET:
699
      g_value_set_object (value, button->priv->icon_widget);
700
      break;
701 702 703 704 705 706
    case PROP_ACTION_NAME:
      g_object_get_property (G_OBJECT (button->priv->button), "action-name", value);
      break;
    case PROP_ACTION_TARGET:
      g_object_get_property (G_OBJECT (button->priv->button), "action-target", value);
      break;
707 708
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
709
      break;
710 711 712
    }
}

713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
static const gchar *
gtk_tool_button_get_action_name (GtkActionable *actionable)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (actionable);

  return gtk_actionable_get_action_name (GTK_ACTIONABLE (button->priv->button));
}

static void
gtk_tool_button_set_action_name (GtkActionable *actionable,
                                 const gchar   *action_name)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (actionable);

  gtk_actionable_set_action_name (GTK_ACTIONABLE (button->priv->button), action_name);
}

static GVariant *
gtk_tool_button_get_action_target_value (GtkActionable *actionable)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (actionable);

  return gtk_actionable_get_action_target_value (GTK_ACTIONABLE (button->priv->button));
}

static void
gtk_tool_button_set_action_target_value (GtkActionable *actionable,
                                         GVariant      *action_target)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (actionable);

  gtk_actionable_set_action_target_value (GTK_ACTIONABLE (button->priv->button), action_target);
}

static void
gtk_tool_button_actionable_iface_init (GtkActionableInterface *iface)
{
  iface->get_action_name = gtk_tool_button_get_action_name;
  iface->set_action_name = gtk_tool_button_set_action_name;
  iface->get_action_target_value = gtk_tool_button_get_action_target_value;
  iface->set_action_target_value = gtk_tool_button_set_action_target_value;
}

756 757 758 759 760
static void
gtk_tool_button_finalize (GObject *object)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (object);

761 762 763
  g_free (button->priv->stock_id);
  g_free (button->priv->icon_name);
  g_free (button->priv->label_text);
764 765

  if (button->priv->label_widget)
766
    g_object_unref (button->priv->label_widget);
767 768

  if (button->priv->icon_widget)
769
    g_object_unref (button->priv->icon_widget);
770
  
771
  parent_class->finalize (object);
772 773
}

774
static GtkWidget *
775
clone_image_menu_size (GtkImage *image)
776 777 778 779 780 781
{
  GtkImageType storage_type = gtk_image_get_storage_type (image);

  if (storage_type == GTK_IMAGE_STOCK)
    {
      gchar *stock_id;
782 783
      GtkWidget *widget;
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
784
      gtk_image_get_stock (image, &stock_id, NULL);
785 786 787
      widget = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
      G_GNUC_END_IGNORE_DEPRECATIONS;
      return widget;
788
    }
789 790 791 792 793 794
  else if (storage_type == GTK_IMAGE_ICON_NAME)
    {
      const gchar *icon_name;
      gtk_image_get_icon_name (image, &icon_name, NULL);
      return gtk_image_new_from_icon_name (icon_name, GTK_ICON_SIZE_MENU);
    }
795 796
  else if (storage_type == GTK_IMAGE_ICON_SET)
    {
797
      GtkWidget *widget;
798
      GtkIconSet *icon_set;
799
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
800
      gtk_image_get_icon_set (image, &icon_set, NULL);
801 802 803
      widget = gtk_image_new_from_icon_set (icon_set, GTK_ICON_SIZE_MENU);
      G_GNUC_END_IGNORE_DEPRECATIONS;
      return widget;
804
    }
805 806 807 808 809 810
  else if (storage_type == GTK_IMAGE_GICON)
    {
      GIcon *icon;
      gtk_image_get_gicon (image, &icon, NULL);
      return gtk_image_new_from_gicon (icon, GTK_ICON_SIZE_MENU);
    }
811 812 813 814
  else if (storage_type == GTK_IMAGE_PIXBUF)
    {
      gint width, height;
      
815
      if (gtk_icon_size_lookup (GTK_ICON_SIZE_MENU, &width, &height))
816 817
	{
	  GdkPixbuf *src_pixbuf, *dest_pixbuf;
818
	  GtkWidget *cloned_image;
819 820 821 822 823

	  src_pixbuf = gtk_image_get_pixbuf (image);
	  dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
						 GDK_INTERP_BILINEAR);

824
	  cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
Matthias Clasen's avatar
Matthias Clasen committed
825 826
	  g_object_unref (dest_pixbuf);

827
	  return cloned_image;
828 829 830 831 832 833
	}
    }

  return NULL;
}
      
834 835 836 837 838 839 840 841
static gboolean
gtk_tool_button_create_menu_proxy (GtkToolItem *item)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (item);
  GtkWidget *menu_item;
  GtkWidget *menu_image = NULL;
  GtkStockItem stock_item;
  gboolean use_mnemonic = TRUE;
842
  const char *label;
843

844 845
  if (_gtk_tool_item_create_menu_proxy (item))
    return TRUE;
846 847 848

  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

849
  if (GTK_IS_LABEL (button->priv->label_widget))
850
    {
851 852
      label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
      use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
853
    }
854
  else if (button->priv->label_text)
855
    {
856 857
      label = button->priv->label_text;
      use_mnemonic = button->priv->use_underline;
858
    }
859
  else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
860 861 862 863 864 865 866
    {
      label = stock_item.label;
    }
  else
    {
      label = "";
    }
867

868 869 870 871 872
  if (use_mnemonic)
    menu_item = gtk_image_menu_item_new_with_mnemonic (label);
  else
    menu_item = gtk_image_menu_item_new_with_label (label);

873
  if (GTK_IS_IMAGE (button->priv->icon_widget))
874
    {
875
      menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget));
876
    }
877
  else if (button->priv->stock_id)
878
    {
879
      menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
880 881 882 883 884
    }

  if (menu_image)
    gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menu_item), menu_image);

885 886
  G_GNUC_END_IGNORE_DEPRECATIONS;

887 888 889
  g_signal_connect_closure_by_id (menu_item,
				  g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
				  g_cclosure_new_object_swap (G_CALLBACK (gtk_button_clicked),
890
							      G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
891 892 893 894 895 896 897 898 899 900 901
				  FALSE);

  gtk_tool_item_set_proxy_menu_item (GTK_TOOL_ITEM (button), MENU_ID, menu_item);
  
  return TRUE;
}

static void
button_clicked (GtkWidget     *widget,
		GtkToolButton *button)
{
902 903
  GtkAction *action;

904 905
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

906 907 908 909 910
  action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (button));
  
  if (action)
    gtk_action_activate (action);

911 912
  G_GNUC_END_IGNORE_DEPRECATIONS;

913 914 915 916 917 918 919 920 921
  g_signal_emit_by_name (button, "clicked");
}

static void
gtk_tool_button_toolbar_reconfigured (GtkToolItem *tool_item)
{
  gtk_tool_button_construct_contents (tool_item);
}

922 923 924 925 926 927
static void 
gtk_tool_button_update_icon_spacing (GtkToolButton *button)
{
  GtkWidget *box;
  guint spacing;

Javier Jardón's avatar
Javier Jardón committed
928
  box = gtk_bin_get_child (GTK_BIN (button->priv->button));
929 930 931 932 933 934 935 936 937
  if (GTK_IS_BOX (box))
    {
      gtk_widget_style_get (GTK_WIDGET (button), 
			    "icon-spacing", &spacing,
			    NULL);
      gtk_box_set_spacing (GTK_BOX (box), spacing);      
    }
}

938
static void
939
gtk_tool_button_style_updated (GtkWidget *widget)
940
{
941
  GTK_WIDGET_CLASS (parent_class)->style_updated (widget);
942

943
  gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
944 945
}

946 947 948 949
static void 
gtk_tool_button_activatable_interface_init (GtkActivatableIface  *iface)
{
  parent_activatable_iface = g_type_interface_peek_parent (iface);
950 951
  iface->update = gtk_tool_button_update;
  iface->sync_action_properties = gtk_tool_button_sync_action_properties;
952 953 954
}

static void
955 956 957
gtk_tool_button_update (GtkActivatable *activatable,
			GtkAction      *action,
			const gchar    *property_name)
958 959 960
{
  GtkToolButton *button;
  GtkWidget *image;
961
  gboolean use_action_appearance;
962 963 964

  parent_activatable_iface->update (activatable, action, property_name);

965 966 967 968 969
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
  use_action_appearance = gtk_activatable_get_use_action_appearance (activatable);
  G_GNUC_END_IGNORE_DEPRECATIONS;

  if (!use_action_appearance)
970 971 972 973
    return;

  button = GTK_TOOL_BUTTON (activatable);
  
974 975
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

976
  if (strcmp (property_name, "short-label") == 0)
977
    gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
978
  else if (strcmp (property_name, "stock-id") == 0)
979
    gtk_tool_button_set_stock_id (button, gtk_action_get_stock_id (action));
980 981 982 983 984
  else if (strcmp (property_name, "gicon") == 0)
    {
      const gchar *stock_id = gtk_action_get_stock_id (action);
      GIcon *icon = gtk_action_get_gicon (action);
      GtkIconSize icon_size = GTK_ICON_SIZE_BUTTON;
985
      GtkIconSet *icon_set = NULL;
986

987 988 989 990 991 992
      if (stock_id)
        {
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
          icon_set = gtk_icon_factory_lookup_default (stock_id);
          G_GNUC_END_IGNORE_DEPRECATIONS;
        }
993
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
994 995

      if (icon_set != NULL || !icon)
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
	image = NULL;
      else 
	{   
	  image = gtk_tool_button_get_icon_widget (button);
	  icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));

	  if (!image)
	    image = gtk_image_new ();
	}

      gtk_tool_button_set_icon_widget (button, image);
      gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);

    }
  else if (strcmp (property_name, "icon-name") == 0)
1011
    gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
1012 1013

  G_GNUC_END_IGNORE_DEPRECATIONS;
1014 1015 1016
}

static void
1017 1018
gtk_tool_button_sync_action_properties (GtkActivatable *activatable,
				        GtkAction      *action)
1019 1020 1021
{
  GtkToolButton *button;
  GIcon         *icon;
1022
  const gchar   *stock_id;
1023
  GtkIconSet    *icon_set = NULL;
1024

1025
  parent_activatable_iface->sync_action_properties (activatable, action);
1026 1027 1028 1029 1030 1031 1032 1033

  if (!action)
    return;

  if (!gtk_activatable_get_use_action_appearance (activatable))
    return;

  button = GTK_TOOL_BUTTON (activatable);
1034
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
1035
  stock_id = gtk_action_get_stock_id (action);
1036
  G_GNUC_END_IGNORE_DEPRECATIONS;
1037 1038

  gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
1039
  gtk_tool_button_set_use_underline (button, TRUE);
1040
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
1041
  gtk_tool_button_set_stock_id (button, stock_id);
1042
  G_GNUC_END_IGNORE_DEPRECATIONS;
1043 1044
  gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));

1045 1046 1047 1048 1049 1050 1051 1052
  if (stock_id)
    {
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
      icon_set = gtk_icon_factory_lookup_default (stock_id);
      G_GNUC_END_IGNORE_DEPRECATIONS;
    }

  if (icon_set != NULL)
1053
      gtk_tool_button_set_icon_widget (button, NULL);
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
  else if ((icon = gtk_action_get_gicon (action)) != NULL)
    {
      GtkIconSize icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
      GtkWidget  *image = gtk_tool_button_get_icon_widget (button);
      
      if (!image)
	{
	  image = gtk_image_new ();
	  gtk_widget_show (image);
	  gtk_tool_button_set_icon_widget (button, image);
	}

      gtk_image_set_from_gicon (GTK_IMAGE (image), icon, icon_size);
    }
  else if (gtk_action_get_icon_name (action))
    gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
  else
    gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
}

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
/**
 * gtk_tool_button_new_from_stock:
 * @stock_id: the name of the stock item 
 *
 * Creates a new #GtkToolButton containing the image and text from a
 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
 * and #GTK_STOCK_APPLY.
 *
 * It is an error if @stock_id is not a name of a stock item.
 * 
1084
 * Returns: A new #GtkToolButton
1085 1086
 * 
 * Since: 2.4
1087 1088
 *
 * Deprecated: 3.10: Use gtk_tool_button_new() instead.
1089
 **/
1090 1091 1092 1093 1094 1095 1096 1097
GtkToolItem *
gtk_tool_button_new_from_stock (const gchar *stock_id)
{
  GtkToolButton *button;

  g_return_val_if_fail (stock_id != NULL, NULL);
    
  button = g_object_new (GTK_TYPE_TOOL_BUTTON,
1098
			 "stock-id", stock_id,
1099 1100 1101 1102 1103
			 NULL);

  return GTK_TOOL_ITEM (button);
}

1104 1105
/**
 * gtk_tool_button_new:
1106
 * @label: (allow-none): a string that will be used as label, or %NULL
1107
 * @icon_widget: (allow-none): a widget that will be used as the button contents, or %NULL
1108
 *
1109
 * Creates a new %GtkToolButton using @icon_widget as contents and @label as
1110
 * label.
1111
 *
1112
 * Returns: A new #GtkToolButton
1113 1114 1115
 * 
 * Since: 2.4
 **/
1116
GtkToolItem *
1117 1118
gtk_tool_button_new (GtkWidget	 *icon_widget,
		     const gchar *label)
1119 1120
{
  GtkToolButton *button;
1121

1122
  g_return_val_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget), NULL);
1123

1124
  button = g_object_new (GTK_TYPE_TOOL_BUTTON,
1125 1126
                         "label", label,
                         "icon-widget", icon_widget,
1127 1128 1129 1130 1131
			 NULL);

  return GTK_TOOL_ITEM (button);  
}

1132 1133 1134
/**
 * gtk_tool_button_set_label:
 * @button: a #GtkToolButton
1135 1136
 * @label: (allow-none): a string that will be used as label, or %NULL.
 *
1137 1138 1139 1140
 * Sets @label as the label used for the tool button. The “label” property
 * only has an effect if not overridden by a non-%NULL “label_widget” property.
 * If both the “label_widget” and “label” properties are %NULL, the label
 * is determined by the “stock_id” property. If the “stock_id” property is also
1141 1142 1143 1144
 * %NULL, @button will not have a label.
 * 
 * Since: 2.4
 **/
1145 1146 1147 1148 1149
void
gtk_tool_button_set_label (GtkToolButton *button,
			   const gchar   *label)
{
  gchar *old_label;
1150 1151
  gchar *elided_label;
  AtkObject *accessible;
1152 1153 1154
  
  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));

1155
  old_label = button->priv->label_text;
1156

1157
  button->priv->label_text = g_strdup (label);
1158
  button->priv->contents_invalid = TRUE;     
1159

1160 1161 1162 1163 1164 1165 1166
  if (label)
    {
      elided_label = _gtk_toolbar_elide_underscores (label);
      accessible = gtk_widget_get_accessible (GTK_WIDGET (button->priv->button));
      atk_object_set_name (accessible, elided_label);
      g_free (elided_label);
    }
1167

1168 1169 1170
  g_free (old_label);
 
  g_object_notify (G_OBJECT (button), "label");
1171 1172
}

1173 1174 1175 1176 1177
/**
 * gtk_tool_button_get_label:
 * @button: a #GtkToolButton
 * 
 * Returns the label used by the tool button, or %NULL if the tool button
1178
 * doesn’t have a label. or uses a the label from a stock item. The returned
1179 1180
 * string is owned by GTK+, and must not be modified or freed.
 * 
1181
 * Returns: The label, or %NULL
1182 1183 1184
 * 
 * Since: 2.4
 **/
1185
const gchar *
1186 1187 1188 1189
gtk_tool_button_get_label (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);

1190
  return button->priv->label_text;
1191 1192
}

1193 1194 1195
/**
 * gtk_tool_button_set_use_underline:
 * @button: a #GtkToolButton
1196
 * @use_underline: whether the button label has the form “_Open”
1197 1198 1199
 *
 * 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. For
1200 1201
 * example, if the label property is “_Open” and @use_underline is %TRUE,
 * the label on the tool button will be “Open” and the item on the overflow
1202
 * menu will have an underlined “O”.
1203 1204 1205 1206 1207 1208
 * 
 * Labels shown on tool buttons never have mnemonics on them; this property
 * only affects the menu item on the overflow menu.
 * 
 * Since: 2.4
 **/
1209 1210 1211 1212 1213 1214 1215 1216
void
gtk_tool_button_set_use_underline (GtkToolButton *button,
				   gboolean       use_underline)
{
  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));

  use_underline = use_underline != FALSE;

1217
  if (use_underline != button->priv->use_underline)
1218
    {
1219
      button->priv->use_underline = use_underline;
1220
      button->priv->contents_invalid = TRUE;
1221

1222
      g_object_notify (G_OBJECT (button), "use-underline");
1223 1224 1225
    }
}

1226 1227 1228 1229 1230 1231 1232
/**
 * gtk_tool_button_get_use_underline:
 * @button: a #GtkToolButton
 * 
 * Returns whether underscores in the label property are used as mnemonics
 * on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
 * 
1233
 * Returns: %TRUE if underscores in the label property are used as
1234 1235 1236 1237
 * mnemonics on menu items on the overflow menu.
 * 
 * Since: 2.4
 **/
1238 1239 1240 1241 1242
gboolean
gtk_tool_button_get_use_underline (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);

1243
  return button->priv->use_underline;
1244 1245
}

1246 1247 1248
/**
 * gtk_tool_button_set_stock_id:
 * @button: a #GtkToolButton
1249 1250
 * @stock_id: (allow-none): a name of a stock item, or %NULL
 *
1251 1252
 * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
 * The stock_id property only has an effect if not
1253
 * overridden by non-%NULL “label” and “icon_widget” properties.
1254 1255
 * 
 * Since: 2.4
1256 1257
 *
 * Deprecated: 3.10: Use gtk_tool_button_set_icon_name() instead.
1258
 **/
1259 1260 1261 1262 1263 1264 1265 1266
void
gtk_tool_button_set_stock_id (GtkToolButton *button,
			      const gchar   *stock_id)
{
  gchar *old_stock_id;
  
  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));

1267
  old_stock_id = button->priv->stock_id;
1268

1269
  button->priv->stock_id = g_strdup (stock_id);
1270
  button->priv->contents_invalid = TRUE;
1271 1272

  g_free (old_stock_id);
1273 1274
  
  g_object_notify (G_OBJECT (button), "stock-id");
1275 1276
}

1277 1278 1279 1280 1281 1282 1283
/**
 * gtk_tool_button_get_stock_id:
 * @button: a #GtkToolButton
 * 
 * Returns the name of the stock item. See gtk_tool_button_set_stock_id().
 * The returned string is owned by GTK+ and must not be freed or modifed.
 * 
1284
 * Returns: the name of the stock item for @button.
1285 1286
 * 
 * Since: 2.4
1287 1288
 *
 * Deprecated: 3.10: Use gtk_tool_button_get_icon_name() instead.
1289
 **/
1290
const gchar *
1291 1292 1293 1294
gtk_tool_button_get_stock_id (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);

1295
  return button->priv->stock_id;
1296 1297
}

1298
/**
1299
 * gtk_tool_button_set_icon_name:
1300
 * @button: a #GtkToolButton
1301 1302
 * @icon_name: (allow-none): the name of the themed icon
 *
1303 1304
 * Sets the icon for the tool button from a named themed icon.
 * See the docs for #GtkIconTheme for more details.
1305 1306
 * The “icon_name” property only has an effect if not
 * overridden by non-%NULL “label”, “icon_widget” and “stock_id”
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
 * properties.
 * 
 * Since: 2.8
 **/
void
gtk_tool_button_set_icon_name (GtkToolButton *button,
			       const gchar   *icon_name)
{
  gchar *old_icon_name;

  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));

  old_icon_name = button->priv->icon_name;

  button->priv->icon_name = g_strdup (icon_name);
1322
  button->priv->contents_invalid = TRUE; 
1323 1324

  g_free (old_icon_name);
1325 1326

  g_object_notify (G_OBJECT (button), "icon-name");
1327 1328 1329
}

/**
1330
 * gtk_tool_button_get_icon_name:
1331
 * @button: a #GtkToolButton
1332
 *
1333 1334 1335 1336 1337
 * Returns the name of the themed icon for the tool button,
 * see gtk_tool_button_set_icon_name().
 *
 * Returns: the icon name or %NULL if the tool button has
 * no themed icon
1338
 *
1339 1340
 * Since: 2.8
 **/
1341
const gchar*
1342 1343 1344 1345 1346 1347 1348
gtk_tool_button_get_icon_name (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);

  return button->priv->icon_name;
}

1349 1350 1351
/**
 * gtk_tool_button_set_icon_widget:
 * @button: a #GtkToolButton
1352 1353
 * @icon_widget: (allow-none): the widget used as icon, or %NULL
 *
1354
 * Sets @icon as the widget used as icon on @button. If @icon_widget is
1355 1356
 * %NULL the icon is determined by the “stock_id” property. If the
 * “stock_id” property is also %NULL, @button will not have an icon.
1357 1358 1359
 * 
 * Since: 2.4
 **/
1360 1361
void
gtk_tool_button_set_icon_widget (GtkToolButton *button,
1362
				 GtkWidget     *icon_widget)
1363 1364
{
  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1365
  g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
1366

1367
  if (icon_widget != button->priv->icon_widget)
1368
    {
1369
      if (button->priv->icon_widget)
1370
	{
1371 1372 1373 1374 1375 1376
          GtkWidget *parent;

          parent = gtk_widget_get_parent (button->priv->icon_widget);
	  if (parent)
            gtk_container_remove (GTK_CONTAINER (parent),
                                  button->priv->icon_widget);
1377

1378
	  g_object_unref (button->priv->icon_widget);
1379 1380
	}
      
1381
      if (icon_widget)
1382
	g_object_ref_sink (icon_widget);
1383

1384
      button->priv->icon_widget = icon_widget;
1385
      button->priv->contents_invalid = TRUE;
1386
      
1387
      g_object_notify (G_OBJECT (button), "icon-widget");
1388 1389 1390