gtktoolbutton.c 43.7 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 88 89 90 91 92
};

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);
93 94
static void gtk_tool_button_property_notify (GObject          *object,
					     GParamSpec       *pspec);
95 96 97 98 99 100
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);
101
static void gtk_tool_button_style_updated  (GtkWidget          *widget);
102 103 104

static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);

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

Matthias Clasen's avatar
Matthias Clasen committed
113

114 115 116 117 118
struct _GtkToolButtonPrivate
{
  GtkWidget *button;

  gchar *stock_id;
119
  gchar *icon_name;
120 121 122
  gchar *label_text;
  GtkWidget *label_widget;
  GtkWidget *icon_widget;
123 124 125

  GtkSizeGroup *text_size_group;

126
  guint use_underline : 1;
127
  guint contents_invalid : 1;
128 129
};

130 131 132
static GtkActivatableIface *parent_activatable_iface;
static guint                toolbutton_signals[LAST_SIGNAL] = { 0 };

133 134 135 136 137
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
G_DEFINE_TYPE_WITH_CODE (GtkToolButton, gtk_tool_button, GTK_TYPE_TOOL_ITEM,
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIONABLE, gtk_tool_button_actionable_iface_init)
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE, gtk_tool_button_activatable_interface_init))
G_GNUC_END_IGNORE_DEPRECATIONS
138 139 140 141 142

static void
gtk_tool_button_class_init (GtkToolButtonClass *klass)
{
  GObjectClass *object_class;
143
  GtkWidgetClass *widget_class;
144
  GtkToolItemClass *tool_item_class;
145

146
  object_class = (GObjectClass *)klass;
147
  widget_class = (GtkWidgetClass *)klass;
148
  tool_item_class = (GtkToolItemClass *)klass;
149

150 151
  object_class->set_property = gtk_tool_button_set_property;
  object_class->get_property = gtk_tool_button_get_property;
152
  object_class->notify = gtk_tool_button_property_notify;
153 154
  object_class->finalize = gtk_tool_button_finalize;

155
  widget_class->style_updated = gtk_tool_button_style_updated;
156

157 158
  tool_item_class->create_menu_proxy = gtk_tool_button_create_menu_proxy;
  tool_item_class->toolbar_reconfigured = gtk_tool_button_toolbar_reconfigured;
159

160 161
  klass->button_type = GTK_TYPE_BUTTON;

162 163 164 165 166
  /* 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
167 168 169
   *            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.
170 171 172 173 174
   *
   *          - 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
175 176 177
   *            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.
178 179 180 181 182 183 184 185 186 187 188 189
   *
   *	      - 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
190 191
   *                      used in the overflow menu should be used as a
   *                      mnemonic.
192 193
   *
   *		In short: use_underline = TRUE means that the label text has
194 195
   *            the form "_Open" and the toolbar should take appropriate
   *            action.
196 197
   */

198 199 200
  g_object_class_install_property (object_class,
				   PROP_LABEL,
				   g_param_spec_string ("label",
201 202
							P_("Label"),
							P_("Text to show in the item."),
203
							NULL,
204
							GTK_PARAM_READWRITE));
205 206
  g_object_class_install_property (object_class,
				   PROP_USE_UNDERLINE,
207
				   g_param_spec_boolean ("use-underline",
208 209
							 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"),
210
							 FALSE,
211
							 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
212 213
  g_object_class_install_property (object_class,
				   PROP_LABEL_WIDGET,
214
				   g_param_spec_object ("label-widget",
215 216
							P_("Label widget"),
							P_("Widget to use as the item label"),
217
							GTK_TYPE_WIDGET,
218
							GTK_PARAM_READWRITE));
219 220 221 222 223
  /**
   * GtkToolButton:stock-id:
   *
   * Deprecated: 3.10: Use #GtkToolButton:icon-name instead.
   */
224 225
  g_object_class_install_property (object_class,
				   PROP_STOCK_ID,
226
				   g_param_spec_string ("stock-id",
227 228
							P_("Stock Id"),
							P_("The stock icon displayed on the item"),
229
							NULL,
230
							GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
231 232 233 234 235

  /**
   * GtkToolButton:icon-name:
   * 
   * The name of the themed icon displayed on the item.
236 237 238
   * This property only has an effect if not overridden by
   * #GtkToolButton:label-widget, #GtkToolButton:icon-widget or
   * #GtkToolButton:stock-id properties.
239 240 241 242 243 244 245 246 247 248
   *
   * 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));
249 250
  g_object_class_install_property (object_class,
				   PROP_ICON_WIDGET,
251
				   g_param_spec_object ("icon-widget",
252 253
							P_("Icon widget"),
							P_("Icon widget to display in the item"),
254
							GTK_TYPE_WIDGET,
255
							GTK_PARAM_READWRITE));
256

257 258 259
  g_object_class_override_property (object_class, PROP_ACTION_NAME, "action-name");
  g_object_class_override_property (object_class, PROP_ACTION_TARGET, "action-target");

260
  /**
261
   * GtkButton:icon-spacing:
262 263 264 265 266 267 268 269 270 271 272
   * 
   * 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,
273
							     3,
274
							     GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
275

276 277 278 279 280 281 282
/**
 * 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.
 **/
283
  toolbutton_signals[CLICKED] =
284
    g_signal_new (I_("clicked"),
285
		  G_OBJECT_CLASS_TYPE (klass),
286
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
287 288 289 290
		  G_STRUCT_OFFSET (GtkToolButtonClass, clicked),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
291 292
  
  g_type_class_add_private (object_class, sizeof (GtkToolButtonPrivate));
293 294 295
}

static void
296
gtk_tool_button_init (GtkToolButton *button)
297 298
{
  GtkToolItem *toolitem = GTK_TOOL_ITEM (button);
299

300 301 302
  button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
                                              GTK_TYPE_TOOL_BUTTON,
                                              GtkToolButtonPrivate);
303

304 305
  button->priv->contents_invalid = TRUE;

306
  gtk_tool_item_set_homogeneous (toolitem, TRUE);
307 308

  /* create button */
309
  button->priv->button = g_object_new (GTK_TOOL_BUTTON_GET_CLASS (button)->button_type, NULL);
310 311
  gtk_button_set_focus_on_click (GTK_BUTTON (button->priv->button), FALSE);
  g_signal_connect_object (button->priv->button, "clicked",
312 313
			   G_CALLBACK (button_clicked), button, 0);

314 315
  gtk_container_add (GTK_CONTAINER (button), button->priv->button);
  gtk_widget_show (button->priv->button);
316 317 318 319 320 321
}

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
322
  GtkWidget *child;
323 324 325 326 327 328 329
  GtkWidget *label = NULL;
  GtkWidget *icon = NULL;
  GtkToolbarStyle style;
  gboolean need_label = FALSE;
  gboolean need_icon = FALSE;
  GtkIconSize icon_size;
  GtkWidget *box = NULL;
330
  guint icon_spacing;
331 332
  GtkOrientation text_orientation = GTK_ORIENTATION_HORIZONTAL;
  GtkSizeGroup *size_group = NULL;
333
  GtkWidget *parent;
334

335 336
  button->priv->contents_invalid = FALSE;

337 338 339
  gtk_widget_style_get (GTK_WIDGET (tool_item), 
			"icon-spacing", &icon_spacing,
			NULL);
340

341
  if (button->priv->icon_widget)
342
    {
343 344 345 346 347 348
      parent = gtk_widget_get_parent (button->priv->icon_widget);
      if (parent)
        {
          gtk_container_remove (GTK_CONTAINER (parent),
                                button->priv->icon_widget);
        }
349 350
    }

351
  if (button->priv->label_widget)
352
    {
353 354 355 356 357 358
      parent = gtk_widget_get_parent (button->priv->label_widget);
      if (parent)
        {
          gtk_container_remove (GTK_CONTAINER (parent),
                                button->priv->label_widget);
        }
359 360
    }

Javier Jardón's avatar
Javier Jardón committed
361 362
  child = gtk_bin_get_child (GTK_BIN (button->priv->button));
  if (child)
363
    {
364 365 366
      /* 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
367
      gtk_widget_destroy (child);
368 369 370 371 372 373
    }

  style = gtk_tool_item_get_toolbar_style (GTK_TOOL_ITEM (button));
  
  if (style != GTK_TOOLBAR_TEXT)
    need_icon = TRUE;
374 375 376 377 378 379

  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)) ||
380 381
       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))
382 383 384
    {
      need_label = TRUE;
    }
385
  
386
  if (style != GTK_TOOLBAR_TEXT && button->priv->icon_widget == NULL &&
387 388 389 390 391 392 393 394 395 396 397 398 399 400
      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;
    }
401

402 403
  if (need_label)
    {
404
      if (button->priv->label_widget)
405
	{
406
	  label = button->priv->label_widget;
407 408 409 410
	}
      else
	{
	  GtkStockItem stock_item;
411
	  gboolean elide;
412 413
	  gchar *label_text;

414 415
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

416
	  if (button->priv->label_text)
417
	    {
418 419
	      label_text = button->priv->label_text;
	      elide = button->priv->use_underline;
420
	    }
421
	  else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
422 423 424 425
	    {
	      label_text = stock_item.label;
	      elide = TRUE;
	    }
426
	  else
427 428 429 430
	    {
	      label_text = "";
	      elide = FALSE;
	    }
431

432 433
          G_GNUC_END_IGNORE_DEPRECATIONS;

434
	  if (elide)
435
	    label_text = _gtk_toolbar_elide_underscores (label_text);
436 437 438 439 440 441 442 443 444
	  else
	    label_text = g_strdup (label_text);

	  label = gtk_label_new (label_text);

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

446
      if (GTK_IS_LABEL (label))
447
        {
448 449 450 451 452
          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)
	    {
453 454
              gfloat align;

455
              gtk_label_set_angle (GTK_LABEL (label), 0);
456 457 458 459 460 461 462
              align = gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button));
              if (align < 0.4)
                gtk_widget_set_halign (label, GTK_ALIGN_START);
              else if (align > 0.6)
                gtk_widget_set_halign (label, GTK_ALIGN_END);
              else
                gtk_widget_set_halign (label, GTK_ALIGN_CENTER);
463 464 465
            }
          else
            {
466 467
              gfloat align;

468 469 470 471 472
              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);
473 474 475 476 477 478 479
              align = gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button));
              if (align < 0.4)
                gtk_widget_set_valign (label, GTK_ALIGN_END);
              else if (align > 0.6)
                gtk_widget_set_valign (label, GTK_ALIGN_START);
              else
                gtk_widget_set_valign (label, GTK_ALIGN_CENTER);
480
            }
481
        }
482 483 484 485 486
    }

  icon_size = gtk_tool_item_get_icon_size (GTK_TOOL_ITEM (button));
  if (need_icon)
    {
487 488 489 490 491 492 493 494 495
      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;
        }

496
      if (button->priv->icon_widget)
497
	{
498
	  icon = button->priv->icon_widget;
499 500 501
	  
	  if (GTK_IS_IMAGE (icon))
	    {
502
	      g_object_set (button->priv->icon_widget,
503 504
			    "icon-size", icon_size,
			    NULL);
505 506
	    }
	}
507
      else if (icon_set != NULL)
508
	{
509
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
510
	  icon = gtk_image_new_from_stock (button->priv->stock_id, icon_size);
511
          G_GNUC_END_IGNORE_DEPRECATIONS;
512 513
	  gtk_widget_show (icon);
	}
514 515 516 517 518
      else if (button->priv->icon_name)
	{
	  icon = gtk_image_new_from_icon_name (button->priv->icon_name, icon_size);
	  gtk_widget_show (icon);
	}
519 520 521

      if (icon)
	{
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
          if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
            {
              gfloat align;

              align = gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button));
              if (align > 0.6) 
                gtk_widget_set_halign (icon, GTK_ALIGN_START);
              else if (align < 0.4)
                gtk_widget_set_halign (icon, GTK_ALIGN_END);
              else
                gtk_widget_set_halign (icon, GTK_ALIGN_CENTER);
            }
          else
            {
              gfloat align;

              align = gtk_tool_item_get_text_alignment (GTK_TOOL_ITEM (button));
              if (align > 0.6) 
                gtk_widget_set_valign (icon, GTK_ALIGN_END);
              else if (align < 0.4)
                gtk_widget_set_valign (icon, GTK_ALIGN_START);
              else
               gtk_widget_set_valign (icon, GTK_ALIGN_CENTER);
            }

547 548 549 550
	  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);
	}
551 552 553 554 555 556
    }

  switch (style)
    {
    case GTK_TOOLBAR_ICONS:
      if (icon)
557 558
        gtk_container_add (GTK_CONTAINER (button->priv->button), icon);
      gtk_style_context_add_class (gtk_widget_get_style_context (button->priv->button), "image-button");
559 560 561
      break;

    case GTK_TOOLBAR_BOTH:
562
      if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
563
	box = gtk_box_new (GTK_ORIENTATION_VERTICAL, icon_spacing);
564
      else
565
	box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, icon_spacing);
566 567
      if (icon)
	gtk_box_pack_start (GTK_BOX (box), icon, TRUE, TRUE, 0);
568
      gtk_box_pack_end (GTK_BOX (box), label, FALSE, TRUE, 0);
569
      gtk_container_add (GTK_CONTAINER (button->priv->button), box);
570 571 572
      break;

    case GTK_TOOLBAR_BOTH_HORIZ:
573 574
      if (text_orientation == GTK_ORIENTATION_HORIZONTAL)
	{
575
	  box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, icon_spacing);
576 577 578 579 580 581 582
	  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
	{
583
	  box = gtk_box_new (GTK_ORIENTATION_VERTICAL, icon_spacing);
584 585 586 587 588
	  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);
	}
589
      gtk_container_add (GTK_CONTAINER (button->priv->button), box);
590 591 592
      break;

    case GTK_TOOLBAR_TEXT:
593
      gtk_container_add (GTK_CONTAINER (button->priv->button), label);
594
      gtk_style_context_add_class (gtk_widget_get_style_context (button->priv->button), "text-button");
595 596 597 598 599 600
      break;
    }

  if (box)
    gtk_widget_show (box);

601
  gtk_button_set_relief (GTK_BUTTON (button->priv->button),
602 603
			 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));

604 605
  gtk_tool_item_rebuild_menu (tool_item);
  
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
  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:
629
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
630
      gtk_tool_button_set_stock_id (button, g_value_get_string (value));
631
      G_GNUC_END_IGNORE_DEPRECATIONS;
632
      break;
633 634 635
    case PROP_ICON_NAME:
      gtk_tool_button_set_icon_name (button, g_value_get_string (value));
      break;
636 637 638
    case PROP_ICON_WIDGET:
      gtk_tool_button_set_icon_widget (button, g_value_get_object (value));
      break;
639 640 641 642 643 644
    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;
645 646
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
647
      break;
648 649 650
    }
}

651 652 653 654
static void
gtk_tool_button_property_notify (GObject          *object,
				 GParamSpec       *pspec)
{
655 656
  GtkToolButton *button = GTK_TOOL_BUTTON (object);

657 658
  if (button->priv->contents_invalid ||
      strcmp ("is-important", pspec->name) == 0)
659
    gtk_tool_button_construct_contents (GTK_TOOL_ITEM (object));
660

661 662
  if (G_OBJECT_CLASS (gtk_tool_button_parent_class)->notify)
    G_OBJECT_CLASS (gtk_tool_button_parent_class)->notify (object, pspec);
663 664
}

665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
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:
685
      g_value_set_string (value, button->priv->stock_id);
686
      break;
687 688 689
    case PROP_ICON_NAME:
      g_value_set_string (value, button->priv->icon_name);
      break;
690
    case PROP_ICON_WIDGET:
691
      g_value_set_object (value, button->priv->icon_widget);
692
      break;
693 694 695 696 697 698
    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;
699 700
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
701
      break;
702 703 704
    }
}

705 706 707 708 709 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
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;
}

748 749 750 751 752
static void
gtk_tool_button_finalize (GObject *object)
{
  GtkToolButton *button = GTK_TOOL_BUTTON (object);

753 754 755
  g_free (button->priv->stock_id);
  g_free (button->priv->icon_name);
  g_free (button->priv->label_text);
756 757

  if (button->priv->label_widget)
758
    g_object_unref (button->priv->label_widget);
759 760

  if (button->priv->icon_widget)
761
    g_object_unref (button->priv->icon_widget);
762 763

  G_OBJECT_CLASS (gtk_tool_button_parent_class)->finalize (object);
764 765
}

766
static GtkWidget *
767
clone_image_menu_size (GtkImage *image)
768 769 770 771 772 773
{
  GtkImageType storage_type = gtk_image_get_storage_type (image);

  if (storage_type == GTK_IMAGE_STOCK)
    {
      gchar *stock_id;
774 775
      GtkWidget *widget;
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
776
      gtk_image_get_stock (image, &stock_id, NULL);
777 778 779
      widget = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
      G_GNUC_END_IGNORE_DEPRECATIONS;
      return widget;
780
    }
781 782 783 784 785 786
  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);
    }
787 788
  else if (storage_type == GTK_IMAGE_ICON_SET)
    {
789
      GtkWidget *widget;
790
      GtkIconSet *icon_set;
791
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
792
      gtk_image_get_icon_set (image, &icon_set, NULL);
793 794 795
      widget = gtk_image_new_from_icon_set (icon_set, GTK_ICON_SIZE_MENU);
      G_GNUC_END_IGNORE_DEPRECATIONS;
      return widget;
796
    }
797 798 799 800 801 802
  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);
    }
803 804 805 806
  else if (storage_type == GTK_IMAGE_PIXBUF)
    {
      gint width, height;
      
807
      if (gtk_icon_size_lookup (GTK_ICON_SIZE_MENU, &width, &height))
808 809
	{
	  GdkPixbuf *src_pixbuf, *dest_pixbuf;
810
	  GtkWidget *cloned_image;
811 812 813 814 815

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

816
	  cloned_image = gtk_image_new_from_pixbuf (dest_pixbuf);
Matthias Clasen's avatar
Matthias Clasen committed
817 818
	  g_object_unref (dest_pixbuf);

819
	  return cloned_image;
820 821 822 823 824 825
	}
    }

  return NULL;
}
      
826 827 828 829 830 831 832 833
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;
834
  const char *label;
835

836 837
  if (_gtk_tool_item_create_menu_proxy (item))
    return TRUE;
838 839 840

  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

841
  if (GTK_IS_LABEL (button->priv->label_widget))
842
    {
843 844
      label = gtk_label_get_label (GTK_LABEL (button->priv->label_widget));
      use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (button->priv->label_widget));
845
    }
846
  else if (button->priv->label_text)
847
    {
848 849
      label = button->priv->label_text;
      use_mnemonic = button->priv->use_underline;
850
    }
851
  else if (button->priv->stock_id && gtk_stock_lookup (button->priv->stock_id, &stock_item))
852 853 854 855 856 857 858
    {
      label = stock_item.label;
    }
  else
    {
      label = "";
    }
859

860 861 862 863 864
  if (use_mnemonic)
    menu_item = gtk_image_menu_item_new_with_mnemonic (label);
  else
    menu_item = gtk_image_menu_item_new_with_label (label);

865
  if (GTK_IS_IMAGE (button->priv->icon_widget))
866
    {
867
      menu_image = clone_image_menu_size (GTK_IMAGE (button->priv->icon_widget));
868
    }
869
  else if (button->priv->stock_id)
870
    {
871
      menu_image = gtk_image_new_from_stock (button->priv->stock_id, GTK_ICON_SIZE_MENU);
872 873 874 875 876
    }

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

877 878
  G_GNUC_END_IGNORE_DEPRECATIONS;

879 880 881
  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),
882
							      G_OBJECT (GTK_TOOL_BUTTON (button)->priv->button)),
883 884 885 886 887 888 889 890 891 892 893
				  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)
{
894 895
  GtkAction *action;

896 897
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

898 899 900 901 902
  action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (button));
  
  if (action)
    gtk_action_activate (action);

903 904
  G_GNUC_END_IGNORE_DEPRECATIONS;

905 906 907 908 909 910 911 912 913
  g_signal_emit_by_name (button, "clicked");
}

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

914 915 916 917 918 919
static void 
gtk_tool_button_update_icon_spacing (GtkToolButton *button)
{
  GtkWidget *box;
  guint spacing;

Javier Jardón's avatar
Javier Jardón committed
920
  box = gtk_bin_get_child (GTK_BIN (button->priv->button));
921 922 923 924 925 926 927 928 929
  if (GTK_IS_BOX (box))
    {
      gtk_widget_style_get (GTK_WIDGET (button), 
			    "icon-spacing", &spacing,
			    NULL);
      gtk_box_set_spacing (GTK_BOX (box), spacing);      
    }
}

930
static void
931
gtk_tool_button_style_updated (GtkWidget *widget)
932
{
933
  GTK_WIDGET_CLASS (gtk_tool_button_parent_class)->style_updated (widget);
934

935
  gtk_tool_button_update_icon_spacing (GTK_TOOL_BUTTON (widget));
936 937
}

938 939 940 941
static void 
gtk_tool_button_activatable_interface_init (GtkActivatableIface  *iface)
{
  parent_activatable_iface = g_type_interface_peek_parent (iface);
942 943
  iface->update = gtk_tool_button_update;
  iface->sync_action_properties = gtk_tool_button_sync_action_properties;
944 945 946
}

static void
947 948 949
gtk_tool_button_update (GtkActivatable *activatable,
			GtkAction      *action,
			const gchar    *property_name)
950 951 952
{
  GtkToolButton *button;
  GtkWidget *image;
953
  gboolean use_action_appearance;
954 955 956

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

957 958 959 960 961
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
  use_action_appearance = gtk_activatable_get_use_action_appearance (activatable);
  G_GNUC_END_IGNORE_DEPRECATIONS;

  if (!use_action_appearance)
962 963 964 965
    return;

  button = GTK_TOOL_BUTTON (activatable);
  
966 967
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;

968
  if (strcmp (property_name, "short-label") == 0)
969
    gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
970
  else if (strcmp (property_name, "stock-id") == 0)
971
    gtk_tool_button_set_stock_id (button, gtk_action_get_stock_id (action));
972 973 974 975 976
  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;
977
      GtkIconSet *icon_set = NULL;
978

979 980 981 982 983 984
      if (stock_id)
        {
          G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
          icon_set = gtk_icon_factory_lookup_default (stock_id);
          G_GNUC_END_IGNORE_DEPRECATIONS;
        }
985
      G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
986 987

      if (icon_set != NULL || !icon)
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
	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)
1003
    gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));
1004 1005

  G_GNUC_END_IGNORE_DEPRECATIONS;
1006 1007 1008
}

static void
1009 1010
gtk_tool_button_sync_action_properties (GtkActivatable *activatable,
				        GtkAction      *action)
1011 1012 1013
{
  GtkToolButton *button;
  GIcon         *icon;
1014
  const gchar   *stock_id;
1015
  GtkIconSet    *icon_set = NULL;
1016

1017
  parent_activatable_iface->sync_action_properties (activatable, action);
1018 1019 1020 1021 1022 1023 1024 1025

  if (!action)
    return;

  if (!gtk_activatable_get_use_action_appearance (activatable))
    return;

  button = GTK_TOOL_BUTTON (activatable);
1026
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
1027
  stock_id = gtk_action_get_stock_id (action);
1028
  G_GNUC_END_IGNORE_DEPRECATIONS;
1029 1030

  gtk_tool_button_set_label (button, gtk_action_get_short_label (action));
1031
  gtk_tool_button_set_use_underline (button, TRUE);
1032
  G_GNUC_BEGIN_IGNORE_DEPRECATIONS;
1033
  gtk_tool_button_set_stock_id (button, stock_id);
1034
  G_GNUC_END_IGNORE_DEPRECATIONS;
1035 1036
  gtk_tool_button_set_icon_name (button, gtk_action_get_icon_name (action));

1037 1038 1039 1040 1041 1042 1043 1044
  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)
1045
      gtk_tool_button_set_icon_widget (button, NULL);
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
  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));
}

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
/**
 * 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.
 * 
1076
 * Returns: A new #GtkToolButton
1077 1078
 * 
 * Since: 2.4
1079
 *
1080 1081
 * Deprecated: 3.10: Use gtk_tool_button_new() together with
 * gtk_image_new_from_icon_name() instead.
1082
 **/
1083 1084 1085 1086 1087 1088 1089 1090
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,
1091
			 "stock-id", stock_id,
1092 1093 1094 1095 1096
			 NULL);

  return GTK_TOOL_ITEM (button);
}

1097 1098
/**
 * gtk_tool_button_new:
1099
 * @label: (allow-none): a string that will be used as label, or %NULL
1100
 * @icon_widget: (allow-none): a widget that will be used as the button contents, or %NULL
1101
 *
1102
 * Creates a new #GtkToolButton using @icon_widget as contents and @label as
1103
 * label.
1104
 *
1105
 * Returns: A new #GtkToolButton
1106 1107 1108
 * 
 * Since: 2.4
 **/
1109
GtkToolItem *
1110 1111
gtk_tool_button_new (GtkWidget	 *icon_widget,
		     const gchar *label)
1112 1113
{
  GtkToolButton *button;
1114

1115
  g_return_val_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget), NULL);
1116

1117
  button = g_object_new (GTK_TYPE_TOOL_BUTTON,
1118 1119
                         "label", label,
                         "icon-widget", icon_widget,
1120 1121 1122 1123 1124
			 NULL);

  return GTK_TOOL_ITEM (button);  
}

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

1149
  old_label = button->priv->label_text;
1150

1151
  button->priv->label_text = g_strdup (label);
1152
  button->priv->contents_invalid = TRUE;     
1153

1154 1155 1156 1157 1158 1159 1160
  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);
    }
1161

1162 1163 1164
  g_free (old_label);
 
  g_object_notify (G_OBJECT (button), "label");
1165 1166
}

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

1184
  return button->priv->label_text;
1185 1186
}

1187 1188 1189
/**
 * gtk_tool_button_set_use_underline:
 * @button: a #GtkToolButton
1190
 * @use_underline: whether the button label has the form “_Open”
1191 1192 1193
 *
 * 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
1194 1195
 * 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
1196
 * menu will have an underlined “O”.
1197 1198 1199 1200 1201 1202
 * 
 * Labels shown on tool buttons never have mnemonics on them; this property
 * only affects the menu item on the overflow menu.
 * 
 * Since: 2.4
 **/
1203 1204 1205 1206 1207 1208 1209 1210
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;

1211
  if (use_underline != button->priv->use_underline)
1212
    {
1213
      button->priv->use_underline = use_underline;
1214
      button->priv->contents_invalid = TRUE;
1215

1216
      g_object_notify (G_OBJECT (button), "use-underline");
1217 1218 1219
    }
}

1220 1221 1222 1223 1224 1225 1226
/**
 * 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().
 * 
1227
 * Returns: %TRUE if underscores in the label property are used as
1228 1229 1230 1231
 * mnemonics on menu items on the overflow menu.
 * 
 * Since: 2.4
 **/
1232 1233 1234 1235 1236
gboolean
gtk_tool_button_get_use_underline (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), FALSE);

1237
  return button->priv->use_underline;
1238 1239
}

1240 1241 1242
/**
 * gtk_tool_button_set_stock_id:
 * @button: a #GtkToolButton
1243 1244
 * @stock_id: (allow-none): a name of a stock item, or %NULL
 *
1245
 * Sets the name of the stock item. See gtk_tool_button_new_from_stock().
1246 1247
 * The stock_id property only has an effect if not overridden by non-%NULL 
 * #GtkToolButton:label-widget and #GtkToolButton:icon-widget properties.
1248 1249
 * 
 * Since: 2.4
1250 1251
 *
 * Deprecated: 3.10: Use gtk_tool_button_set_icon_name() instead.
1252
 **/
1253 1254 1255 1256 1257 1258 1259 1260
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));

1261
  old_stock_id = button->priv->stock_id;
1262

1263
  button->priv->stock_id = g_strdup (stock_id);
1264
  button->priv->contents_invalid = TRUE;
1265 1266

  g_free (old_stock_id);
1267 1268
  
  g_object_notify (G_OBJECT (button), "stock-id");
1269 1270
}

1271 1272 1273 1274 1275 1276 1277
/**
 * 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.
 * 
1278
 * Returns: the name of the stock item for @button.
1279 1280
 * 
 * Since: 2.4
1281 1282
 *
 * Deprecated: 3.10: Use gtk_tool_button_get_icon_name() instead.
1283
 **/
1284
const gchar *
1285 1286 1287 1288
gtk_tool_button_get_stock_id (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);

1289
  return button->priv->stock_id;
1290 1291
}

1292
/**
1293
 * gtk_tool_button_set_icon_name:
1294
 * @button: a #GtkToolButton
1295 1296
 * @icon_name: (allow-none): the name of the themed icon
 *
1297 1298
 * Sets the icon for the tool button from a named themed icon.
 * See the docs for #GtkIconTheme for more details.
1299 1300 1301
 * The #GtkToolButton:icon-name property only has an effect if not
 * overridden by non-%NULL #GtkToolButton:label-widget, 
 * #GtkToolButton:icon-widget and #GtkToolButton:stock-id properties.
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
 * 
 * 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);
1316
  button->priv->contents_invalid = TRUE; 
1317 1318

  g_free (old_icon_name);
1319 1320

  g_object_notify (G_OBJECT (button), "icon-name");
1321 1322 1323
}

/**
1324
 * gtk_tool_button_get_icon_name:
1325
 * @button: a #GtkToolButton
1326
 *
1327 1328 1329 1330 1331
 * 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
1332
 *
1333 1334
 * Since: 2.8
 **/
1335
const gchar*
1336 1337 1338 1339 1340 1341 1342
gtk_tool_button_get_icon_name (GtkToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOOL_BUTTON (button), NULL);

  return button->priv->icon_name;
}

1343 1344 1345
/**
 * gtk_tool_button_set_icon_widget:
 * @button: a #GtkToolButton
1346 1347
 * @icon_widget: (allow-none): the widget used as icon, or %NULL
 *
1348
 * Sets @icon as the widget used as icon on @button. If @icon_widget is
1349 1350
 * %NULL the icon is determined by the #GtkToolButton:stock-id property. If the
 * #GtkToolButton:stock-id property is also %NULL, @button will not have an icon.
1351 1352 1353
 * 
 * Since: 2.4
 **/
1354 1355
void
gtk_tool_button_set_icon_widget (GtkToolButton *button,
1356
				 GtkWidget     *icon_widget)
1357 1358
{
  g_return_if_fail (GTK_IS_TOOL_BUTTON (button));
1359
  g_return_if_fail (icon_widget == NULL || GTK_IS_WIDGET (icon_widget));
1360

1361
  if (icon_widget != button->priv->icon_widget)
1362
    {
1363
      if (button->priv->icon_widget)
1364
	{
1365 1366 1367 1368 1369 1370
          GtkWidget *parent;

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

1372
	  g_object_unref (button->priv->icon_widget);
1373 1374
	}
      
1375
      if (icon_widget)