gtkimagemenuitem.c 25.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Copyright (C) 2001 Red Hat, Inc.
 *
 * 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27
#include "config.h"
28 29
#include "gtkimagemenuitem.h"
#include "gtkaccellabel.h"
30
#include "gtkintl.h"
31 32 33
#include "gtkstock.h"
#include "gtkiconfactory.h"
#include "gtkimage.h"
34
#include "gtkmenubar.h"
Matthias Clasen's avatar
Matthias Clasen committed
35 36
#include "gtkcontainer.h"
#include "gtkwindow.h"
37
#include "gtkprivate.h"
38
#include "gtkalias.h"
Matthias Clasen's avatar
Matthias Clasen committed
39

40
static void gtk_image_menu_item_destroy              (GtkObject        *object);
41 42 43 44
static void gtk_image_menu_item_size_request         (GtkWidget        *widget,
                                                      GtkRequisition   *requisition);
static void gtk_image_menu_item_size_allocate        (GtkWidget        *widget,
                                                      GtkAllocation    *allocation);
45
static void gtk_image_menu_item_map                  (GtkWidget        *widget);
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
static void gtk_image_menu_item_remove               (GtkContainer     *container,
                                                      GtkWidget        *child);
static void gtk_image_menu_item_toggle_size_request  (GtkMenuItem      *menu_item,
						      gint             *requisition);
static void gtk_image_menu_item_set_label            (GtkMenuItem      *menu_item,
						      const gchar      *label);
static G_CONST_RETURN gchar *gtk_image_menu_item_get_label (GtkMenuItem *menu_item);

static void gtk_image_menu_item_forall               (GtkContainer    *container,
						      gboolean	       include_internals,
						      GtkCallback      callback,
						      gpointer         callback_data);

static void gtk_image_menu_item_finalize             (GObject         *object);
static void gtk_image_menu_item_set_property         (GObject         *object,
						      guint            prop_id,
						      const GValue    *value,
						      GParamSpec      *pspec);
static void gtk_image_menu_item_get_property         (GObject         *object,
						      guint            prop_id,
						      GValue          *value,
						      GParamSpec      *pspec);
static void gtk_image_menu_item_screen_changed       (GtkWidget        *widget,
						      GdkScreen        *previous_screen);

static void gtk_image_menu_item_recalculate          (GtkImageMenuItem *image_menu_item);


typedef struct {
  gchar          *label;
  gboolean        use_stock;
} GtkImageMenuItemPrivate;
78 79

enum {
80
  PROP_0,
81 82 83
  PROP_IMAGE,
  PROP_USE_STOCK,
  PROP_ACCEL_GROUP
84 85
};

Matthias Clasen's avatar
Matthias Clasen committed
86
G_DEFINE_TYPE (GtkImageMenuItem, gtk_image_menu_item, GTK_TYPE_MENU_ITEM)
87

88 89 90
#define GET_PRIVATE(object)  \
  (G_TYPE_INSTANCE_GET_PRIVATE ((object), GTK_TYPE_IMAGE_MENU_ITEM, GtkImageMenuItemPrivate))

91 92 93
static void
gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
{
94 95 96 97 98 99 100 101
  GObjectClass *gobject_class = (GObjectClass*) klass;
  GtkObjectClass *object_class = (GtkObjectClass*) klass;
  GtkWidgetClass *widget_class = (GtkWidgetClass*) klass;
  GtkMenuItemClass *menu_item_class = (GtkMenuItemClass*) klass;
  GtkContainerClass *container_class = (GtkContainerClass*) klass;

  object_class->destroy = gtk_image_menu_item_destroy;

Matthias Clasen's avatar
Matthias Clasen committed
102
  widget_class->screen_changed = gtk_image_menu_item_screen_changed;
103 104
  widget_class->size_request = gtk_image_menu_item_size_request;
  widget_class->size_allocate = gtk_image_menu_item_size_allocate;
105
  widget_class->map = gtk_image_menu_item_map;
106 107 108 109 110

  container_class->forall = gtk_image_menu_item_forall;
  container_class->remove = gtk_image_menu_item_remove;
  
  menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
111 112
  menu_item_class->set_label           = gtk_image_menu_item_set_label;
  menu_item_class->get_label           = gtk_image_menu_item_get_label;
113

114
  gobject_class->finalize     = gtk_image_menu_item_finalize;
115 116 117 118 119 120
  gobject_class->set_property = gtk_image_menu_item_set_property;
  gobject_class->get_property = gtk_image_menu_item_get_property;
  
  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE,
                                   g_param_spec_object ("image",
121 122
                                                        P_("Image widget"),
                                                        P_("Child widget to appear next to the menu text"),
123
                                                        GTK_TYPE_WIDGET,
124
                                                        GTK_PARAM_READWRITE));
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
  /**
   * GtkImageMenuItem:use-stock:
   *
   * If %TRUE, the label set in the menuitem is used as a
   * stock id to select the stock item for the item.
   *
   * Since: 2.16
   **/
  g_object_class_install_property (gobject_class,
                                   PROP_USE_STOCK,
                                   g_param_spec_boolean ("use-stock",
							 P_("Use stock"),
							 P_("Whether to use the label text to create a stock menu item"),
							 FALSE,
							 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));

  /**
   * GtkImageMenuItem:accel-group:
   *
   * The Accel Group to use for stock accelerator keys
   *
   * Since: 2.16
   **/
  g_object_class_install_property (gobject_class,
                                   PROP_ACCEL_GROUP,
                                   g_param_spec_object ("accel-group",
							P_("Accel Group"),
							P_("The Accel Group to use for stock accelerator keys"),
							GTK_TYPE_ACCEL_GROUP,
							GTK_PARAM_WRITABLE));
Matthias Clasen's avatar
Matthias Clasen committed
155 156 157 158 159

  gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
						       P_("Show menu images"),
						       P_("Whether images should be shown in menus"),
						       TRUE,
160
						       GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
161
  
162 163 164

  g_type_class_add_private (object_class, sizeof (GtkImageMenuItemPrivate));

165 166 167 168 169
}

static void
gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
{
170 171 172 173 174
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (image_menu_item);

  priv->use_stock   = FALSE;
  priv->label  = NULL;

175 176 177
  image_menu_item->image = NULL;
}

178 179 180 181 182 183 184 185 186 187 188
static void 
gtk_image_menu_item_finalize (GObject *object)
{
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (object);

  g_free (priv->label);
  priv->label  = NULL;

  G_OBJECT_CLASS (gtk_image_menu_item_parent_class)->finalize (object);
}

189
static void
190 191 192
gtk_image_menu_item_set_property (GObject         *object,
                                  guint            prop_id,
                                  const GValue    *value,
Tim Janik's avatar
Tim Janik committed
193
                                  GParamSpec      *pspec)
194
{
195 196 197 198 199
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_IMAGE:
200 201 202 203 204 205 206
      gtk_image_menu_item_set_image (image_menu_item, (GtkWidget *) g_value_get_object (value));
      break;
    case PROP_USE_STOCK:
      gtk_image_menu_item_set_use_stock (image_menu_item, g_value_get_boolean (value));
      break;
    case PROP_ACCEL_GROUP:
      gtk_image_menu_item_set_accel_group (image_menu_item, g_value_get_object (value));
207 208 209 210 211 212
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}
213

214 215 216 217
static void
gtk_image_menu_item_get_property (GObject         *object,
                                  guint            prop_id,
                                  GValue          *value,
Tim Janik's avatar
Tim Janik committed
218
                                  GParamSpec      *pspec)
219 220
{
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
221
  
222 223 224
  switch (prop_id)
    {
    case PROP_IMAGE:
225 226 227 228
      g_value_set_object (value, gtk_image_menu_item_get_image (image_menu_item));
      break;
    case PROP_USE_STOCK:
      g_value_set_boolean (value, gtk_image_menu_item_get_use_stock (image_menu_item));      
229 230 231 232 233
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
234 235
}

Matthias Clasen's avatar
Matthias Clasen committed
236 237 238 239 240 241 242 243 244 245
static gboolean
show_image (GtkImageMenuItem *image_menu_item)
{
  GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
  gboolean show;

  g_object_get (settings, "gtk-menu-images", &show, NULL);

  return show;
}
246

247 248 249 250 251 252 253 254 255 256 257 258 259
static void
gtk_image_menu_item_map (GtkWidget *widget)
{
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);

  GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->map (widget);

  if (image_menu_item->image)
    g_object_set (image_menu_item->image,
                  "visible", show_image (image_menu_item),
                  NULL);
}

260 261 262 263 264 265 266 267 268 269 270 271
static void
gtk_image_menu_item_destroy (GtkObject *object)
{
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);

  if (image_menu_item->image)
    gtk_container_remove (GTK_CONTAINER (image_menu_item),
                          image_menu_item->image);

  GTK_OBJECT_CLASS (gtk_image_menu_item_parent_class)->destroy (object);
}

272 273 274 275
static void
gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
					 gint        *requisition)
{
276
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
277 278 279 280 281 282
  GtkPackDirection pack_dir;
  
  if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
    pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (GTK_WIDGET (menu_item)->parent));
  else
    pack_dir = GTK_PACK_DIRECTION_LTR;
283

284 285
  *requisition = 0;

286
  if (image_menu_item->image && GTK_WIDGET_VISIBLE (image_menu_item->image))
287
    {
288
      GtkRequisition image_requisition;
289
      guint toggle_spacing;
290 291 292
      gtk_widget_get_child_requisition (image_menu_item->image,
                                        &image_requisition);

293 294 295 296 297
      gtk_widget_style_get (GTK_WIDGET (menu_item),
			    "toggle-spacing", &toggle_spacing,
			    NULL);
      
      if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
298
	{
299 300 301 302 303 304 305
	  if (image_requisition.width > 0)
	    *requisition = image_requisition.width + toggle_spacing;
	}
      else
	{
	  if (image_requisition.height > 0)
	    *requisition = image_requisition.height + toggle_spacing;
306
	}
307
    }
308 309
}

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
static void
gtk_image_menu_item_recalculate (GtkImageMenuItem *image_menu_item)
{
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (image_menu_item);
  GtkStockItem             stock_item;
  GtkWidget               *image;
  const gchar             *resolved_label = priv->label;

  if (priv->use_stock && priv->label)
    {

      if (!image_menu_item->image)
	{
	  image = gtk_image_new_from_stock (priv->label, GTK_ICON_SIZE_MENU);
	  gtk_image_menu_item_set_image (image_menu_item, image);
	}

      if (gtk_stock_lookup (priv->label, &stock_item))
	  resolved_label = stock_item.label;

	gtk_menu_item_set_use_underline (GTK_MENU_ITEM (image_menu_item), TRUE);
    }

  GTK_MENU_ITEM_CLASS
    (gtk_image_menu_item_parent_class)->set_label (GTK_MENU_ITEM (image_menu_item), resolved_label);

}

static void 
gtk_image_menu_item_set_label (GtkMenuItem      *menu_item,
			       const gchar      *label)
{
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (menu_item);

  if (priv->label != label)
    {
      g_free (priv->label);
      priv->label = g_strdup (label);

      gtk_image_menu_item_recalculate (GTK_IMAGE_MENU_ITEM (menu_item));

      g_object_notify (G_OBJECT (menu_item), "label");

    }
}

static G_CONST_RETURN gchar *
gtk_image_menu_item_get_label (GtkMenuItem *menu_item)
{
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (menu_item);
  
  return priv->label;
}
363 364 365 366 367 368

static void
gtk_image_menu_item_size_request (GtkWidget      *widget,
                                  GtkRequisition *requisition)
{
  GtkImageMenuItem *image_menu_item;
369
  gint child_width = 0;
370
  gint child_height = 0;
371
  GtkPackDirection pack_dir;
372
  
373 374 375 376 377
  if (GTK_IS_MENU_BAR (widget->parent))
    pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
  else
    pack_dir = GTK_PACK_DIRECTION_LTR;

378
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
379 380

  if (image_menu_item->image && GTK_WIDGET_VISIBLE (image_menu_item->image))
381 382 383 384 385 386
    {
      GtkRequisition child_requisition;
      
      gtk_widget_size_request (image_menu_item->image,
                               &child_requisition);

387
      child_width = child_requisition.width;
388 389
      child_height = child_requisition.height;
    }
390 391

  GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_request (widget, requisition);
392 393 394 395

  /* not done with height since that happens via the
   * toggle_size_request
   */
396 397 398 399 400
  if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
    requisition->height = MAX (requisition->height, child_height);
  else
    requisition->width = MAX (requisition->width, child_width);
    
401 402 403 404 405 406 407 408 409 410 411 412
  
  /* Note that GtkMenuShell always size requests before
   * toggle_size_request, so toggle_size_request will be able to use
   * image_menu_item->image->requisition
   */
}

static void
gtk_image_menu_item_size_allocate (GtkWidget     *widget,
                                   GtkAllocation *allocation)
{
  GtkImageMenuItem *image_menu_item;
413 414 415 416 417 418
  GtkPackDirection pack_dir;
  
  if (GTK_IS_MENU_BAR (widget->parent))
    pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
  else
    pack_dir = GTK_PACK_DIRECTION_LTR;
419 420
  
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);  
421 422

  GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_allocate (widget, allocation);
423

424
  if (image_menu_item->image && GTK_WIDGET_VISIBLE (image_menu_item->image))
425
    {
426 427
      gint x, y, offset;
      GtkRequisition child_requisition;
428
      GtkAllocation child_allocation;
429 430 431
      guint horizontal_padding, toggle_spacing;

      gtk_widget_style_get (widget,
432 433
			    "horizontal-padding", &horizontal_padding,
			    "toggle-spacing", &toggle_spacing,
434
			    NULL);
435 436 437 438
      
      /* Man this is lame hardcoding action, but I can't
       * come up with a solution that's really better.
       */
439 440 441 442

      gtk_widget_get_child_requisition (image_menu_item->image,
                                        &child_requisition);

443 444
      if (pack_dir == GTK_PACK_DIRECTION_LTR ||
	  pack_dir == GTK_PACK_DIRECTION_RTL)
445
	{
446 447 448 449 450 451
	  offset = GTK_CONTAINER (image_menu_item)->border_width +
	    widget->style->xthickness;
	  
	  if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
	      (pack_dir == GTK_PACK_DIRECTION_LTR))
	    x = offset + horizontal_padding +
452
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
453
	       toggle_spacing - child_requisition.width) / 2;
454 455 456 457 458 459 460
	  else
	    x = widget->allocation.width - offset - horizontal_padding -
	      GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
	       toggle_spacing - child_requisition.width) / 2;
	  
	  y = (widget->allocation.height - child_requisition.height) / 2;
461 462 463
	}
      else
	{
464 465 466 467 468 469 470 471 472 473
	  offset = GTK_CONTAINER (image_menu_item)->border_width +
	    widget->style->ythickness;
	  
	  if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
	      (pack_dir == GTK_PACK_DIRECTION_TTB))
	    y = offset + horizontal_padding +
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
	       toggle_spacing - child_requisition.height) / 2;
	  else
	    y = widget->allocation.height - offset - horizontal_padding -
474 475
	      GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
476
	       toggle_spacing - child_requisition.height) / 2;
477

478 479 480
	  x = (widget->allocation.width - child_requisition.width) / 2;
	}
      
481 482
      child_allocation.width = child_requisition.width;
      child_allocation.height = child_requisition.height;
483 484
      child_allocation.x = widget->allocation.x + MAX (x, 0);
      child_allocation.y = widget->allocation.y + MAX (y, 0);
485 486 487 488 489 490 491 492 493 494 495

      gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
    }
}

static void
gtk_image_menu_item_forall (GtkContainer   *container,
                            gboolean	    include_internals,
                            GtkCallback     callback,
                            gpointer        callback_data)
{
496
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
497 498 499 500 501

  GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->forall (container,
                                                                  include_internals,
                                                                  callback,
                                                                  callback_data);
502

503
  if (include_internals && image_menu_item->image)
504 505 506
    (* callback) (image_menu_item->image, callback_data);
}

Matthias Clasen's avatar
Matthias Clasen committed
507 508 509 510 511 512
/**
 * gtk_image_menu_item_new:
 * @returns: a new #GtkImageMenuItem.
 *
 * Creates a new #GtkImageMenuItem with an empty label.
 **/
513
GtkWidget*
514 515 516 517 518
gtk_image_menu_item_new (void)
{
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
519 520 521 522 523 524 525
/**
 * gtk_image_menu_item_new_with_label:
 * @label: the text of the menu item.
 * @returns: a new #GtkImageMenuItem.
 *
 * Creates a new #GtkImageMenuItem containing a label. 
 **/
526 527
GtkWidget*
gtk_image_menu_item_new_with_label (const gchar *label)
528
{
529 530 531
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "label", label,
		       NULL);
532 533
}

534 535 536

/**
 * gtk_image_menu_item_new_with_mnemonic:
Matthias Clasen's avatar
Matthias Clasen committed
537
 * @label: the text of the menu item, with an underscore in front of the
538 539 540 541 542 543 544 545 546 547
 *         mnemonic character
 * @returns: a new #GtkImageMenuItem
 *
 * Creates a new #GtkImageMenuItem containing a label. The label
 * will be created using gtk_label_new_with_mnemonic(), so underscores
 * in @label indicate the mnemonic for the menu item.
 **/
GtkWidget*
gtk_image_menu_item_new_with_mnemonic (const gchar *label)
{
548 549 550 551
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "use-underline", TRUE,
		       "label", label,
		       NULL);
552 553
}

Matthias Clasen's avatar
Matthias Clasen committed
554 555 556
/**
 * gtk_image_menu_item_new_from_stock:
 * @stock_id: the name of the stock item.
557 558
 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
 *   or %NULL.
Matthias Clasen's avatar
Matthias Clasen committed
559 560 561 562 563
 * @returns: a new #GtkImageMenuItem.
 *
 * Creates a new #GtkImageMenuItem containing the image and text from a 
 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK 
 * and #GTK_STOCK_APPLY.
564
 *
Matthias Clasen's avatar
Matthias Clasen committed
565 566 567 568 569
 * If you want this menu item to have changeable accelerators, then pass in
 * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
 * appropriate path for the menu item, use gtk_stock_lookup() to look up the
 * standard accelerator for the stock item, and if one is found, call
 * gtk_accel_map_add_entry() to register it.
Matthias Clasen's avatar
Matthias Clasen committed
570
 **/
571 572 573 574
GtkWidget*
gtk_image_menu_item_new_from_stock (const gchar      *stock_id,
				    GtkAccelGroup    *accel_group)
{
575 576 577 578 579 580
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "label", stock_id,
		       "use-stock", TRUE,
		       "accel-group", accel_group,
		       NULL);
}
581

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
/**
 * gtk_image_menu_item_set_use_stock:
 * @image_menu_item: a #GtkImageMenuItem
 * @use_stock: %TRUE if the menuitem should use a stock item
 *
 * If %TRUE, the label set in the menuitem is used as a
 * stock id to select the stock item for the item.
 *
 * Since: 2.16
 */
void
gtk_image_menu_item_set_use_stock (GtkImageMenuItem *image_menu_item,
				   gboolean          use_stock)
{
  GtkImageMenuItemPrivate *priv;

  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
599

600
  priv = GET_PRIVATE (image_menu_item);
601

602
  if (priv->use_stock != use_stock)
603
    {
604
      priv->use_stock = use_stock;
605

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
      gtk_image_menu_item_recalculate (image_menu_item);

      g_object_notify (G_OBJECT (image_menu_item), "use-stock");
    }
}

/**
 * gtk_image_menu_item_get_use_stock:
 * @image_menu_item: a #GtkImageMenuItem
 * @use_stock: %TRUE if the menuitem should use a stock item
 *
 * Checks whether the label set in the menuitem is used as a
 * stock id to select the stock item for the item.
 *
 * Returns: %TRUE if the label set in the menuitem is used as a
 * stock id to select the stock item for the item
 *
 * Since: 2.16
 */
gboolean
gtk_image_menu_item_get_use_stock (GtkImageMenuItem *image_menu_item)
{
  GtkImageMenuItemPrivate *priv;

  g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), FALSE);

  priv = GET_PRIVATE (image_menu_item);

  return priv->use_stock;
}


/**
 * gtk_image_menu_item_set_accel_group:
 * @image_menu_item: a #GtkImageMenuItem
 * @accel_group: the #GtkAccelGroup
 *
 * Specifies an @accel_group to add the menu items accelerator to
 * (this only applies to stock items so a stock item must already
 * be set, make sure to call gtk_image_menu_item_set_use_stock()
 * and gtk_menu_item_set_label() with a valid stock item first).
 *
 * If you want this menu item to have changeable accelerators then
 * you shouldnt need this (see gtk_image_menu_item_new_from_stock()).
 *
 * Returns: whether an accelerator from the stock was successfully added.
 *
 * Since: 2.16
 */
void
gtk_image_menu_item_set_accel_group (GtkImageMenuItem *image_menu_item, 
				     GtkAccelGroup    *accel_group)
{
  GtkImageMenuItemPrivate *priv;
  GtkStockItem             stock_item;

  /* Silent return for the constructor */
  if (!accel_group) 
    return;
  
  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
  g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));

  priv = GET_PRIVATE (image_menu_item);

  if (priv->use_stock && priv->label && gtk_stock_lookup (priv->label, &stock_item))
    if (stock_item.keyval)
      {
	gtk_widget_add_accelerator (GTK_WIDGET (image_menu_item),
675 676 677 678 679
				    "activate",
				    accel_group,
				    stock_item.keyval,
				    stock_item.modifier,
				    GTK_ACCEL_VISIBLE);
680 681 682
	
	g_object_notify (G_OBJECT (image_menu_item), "accel-group");
      }
683 684
}

Matthias Clasen's avatar
Matthias Clasen committed
685 686 687 688 689 690
/** 
 * gtk_image_menu_item_set_image:
 * @image_menu_item: a #GtkImageMenuItem.
 * @image: a widget to set as the image for the menu item.
 * 
 * Sets the image of @image_menu_item to the given widget.
Matthias Clasen's avatar
Matthias Clasen committed
691 692
 * Note that it depends on the show-menu-images setting whether
 * the image will be displayed or not.
Matthias Clasen's avatar
Matthias Clasen committed
693
 **/ 
694
void
695 696
gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
                               GtkWidget        *image)
697 698
{
  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
699 700 701 702 703 704 705 706 707 708 709 710 711 712

  if (image == image_menu_item->image)
    return;

  if (image_menu_item->image)
    gtk_container_remove (GTK_CONTAINER (image_menu_item),
			  image_menu_item->image);

  image_menu_item->image = image;

  if (image == NULL)
    return;

  gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
713
  g_object_set (image,
Matthias Clasen's avatar
Matthias Clasen committed
714
		"visible", show_image (image_menu_item),
715
		"no-show-all", TRUE,
Matthias Clasen's avatar
Matthias Clasen committed
716
		NULL);
717

718
  g_object_notify (G_OBJECT (image_menu_item), "image");
719 720
}

Matthias Clasen's avatar
Matthias Clasen committed
721 722 723 724 725 726 727 728
/**
 * gtk_image_menu_item_get_image:
 * @image_menu_item: a #GtkImageMenuItem.
 * @returns: the widget set as image of @image_menu_item.
 *
 * Gets the widget that is currently set as the image of @image_menu_item.
 * See gtk_image_menu_item_set_image().
 **/
729 730 731 732 733 734 735 736
GtkWidget*
gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
{
  g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);

  return image_menu_item->image;
}

737
static void
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
gtk_image_menu_item_remove (GtkContainer *container,
                            GtkWidget    *child)
{
  GtkImageMenuItem *image_menu_item;

  image_menu_item = GTK_IMAGE_MENU_ITEM (container);

  if (child == image_menu_item->image)
    {
      gboolean widget_was_visible;
      
      widget_was_visible = GTK_WIDGET_VISIBLE (child);
      
      gtk_widget_unparent (child);
      image_menu_item->image = NULL;
      
754
      if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
755
        gtk_widget_queue_resize (GTK_WIDGET (container));
756 757

      g_object_notify (G_OBJECT (image_menu_item), "image");
758 759 760
    }
  else
    {
761
      GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->remove (container, child);
762 763 764
    }
}

Matthias Clasen's avatar
Matthias Clasen committed
765 766 767
static void 
show_image_change_notify (GtkImageMenuItem *image_menu_item)
{
Matthias Clasen's avatar
Matthias Clasen committed
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
  if (image_menu_item->image)
    {
      if (show_image (image_menu_item))
	gtk_widget_show (image_menu_item->image);
      else
	gtk_widget_hide (image_menu_item->image);
    }
}

static void
traverse_container (GtkWidget *widget,
		    gpointer   data)
{
  if (GTK_IS_IMAGE_MENU_ITEM (widget))
    show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
  else if (GTK_IS_CONTAINER (widget))
    gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
}

static void
gtk_image_menu_item_setting_changed (GtkSettings *settings)
{
790
  GList *list, *l;
Matthias Clasen's avatar
Matthias Clasen committed
791 792 793

  list = gtk_window_list_toplevels ();

794 795 796
  for (l = list; l; l = l->next)
    gtk_container_forall (GTK_CONTAINER (l->data), 
			  traverse_container, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
797 798

  g_list_free (list);  
Matthias Clasen's avatar
Matthias Clasen committed
799 800 801 802 803 804 805
}

static void
gtk_image_menu_item_screen_changed (GtkWidget *widget,
				    GdkScreen *previous_screen)
{
  GtkSettings *settings;
Matthias Clasen's avatar
Matthias Clasen committed
806
  guint show_image_connection;
Matthias Clasen's avatar
Matthias Clasen committed
807

Matthias Clasen's avatar
Matthias Clasen committed
808
  if (!gtk_widget_has_screen (widget))
Matthias Clasen's avatar
Matthias Clasen committed
809
    return;
810

Matthias Clasen's avatar
Matthias Clasen committed
811 812 813
  settings = gtk_widget_get_settings (widget);
  
  show_image_connection = 
814 815
    GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings), 
					 "gtk-image-menu-item-connection"));
Matthias Clasen's avatar
Matthias Clasen committed
816 817 818
  
  if (show_image_connection)
    return;
Matthias Clasen's avatar
Matthias Clasen committed
819

Matthias Clasen's avatar
Matthias Clasen committed
820 821
  show_image_connection =
    g_signal_connect (settings, "notify::gtk-menu-images",
822
		      G_CALLBACK (gtk_image_menu_item_setting_changed), NULL);
Matthias Clasen's avatar
Matthias Clasen committed
823
  g_object_set_data (G_OBJECT (settings), 
Matthias Clasen's avatar
Matthias Clasen committed
824
		     I_("gtk-image-menu-item-connection"),
825
		     GUINT_TO_POINTER (show_image_connection));
Matthias Clasen's avatar
Matthias Clasen committed
826 827 828

  show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
}
Matthias Clasen's avatar
Matthias Clasen committed
829

830 831
#define __GTK_IMAGE_MENU_ITEM_C__
#include "gtkaliasdef.c"