gtkimagemenuitem.c 32.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 "gtkactivatable.h"
38
#include "gtkprivate.h"
39
#include "gtkalias.h"
Matthias Clasen's avatar
Matthias Clasen committed
40

41
static void gtk_image_menu_item_destroy              (GtkObject        *object);
42 43 44 45
static void gtk_image_menu_item_size_request         (GtkWidget        *widget,
                                                      GtkRequisition   *requisition);
static void gtk_image_menu_item_size_allocate        (GtkWidget        *widget,
                                                      GtkAllocation    *allocation);
46
static void gtk_image_menu_item_map                  (GtkWidget        *widget);
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
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);

74
static void gtk_image_menu_item_activatable_interface_init (GtkActivatableIface  *iface);
75
static void gtk_image_menu_item_update                     (GtkActivatable       *activatable,
76 77
							    GtkAction            *action,
							    const gchar          *property_name);
78
static void gtk_image_menu_item_sync_action_properties     (GtkActivatable       *activatable,
79
							    GtkAction            *action);
80 81

typedef struct {
82 83 84
  gchar *label;
  guint  use_stock         : 1;
  guint  always_show_image : 1;
85
} GtkImageMenuItemPrivate;
86 87

enum {
88
  PROP_0,
89 90
  PROP_IMAGE,
  PROP_USE_STOCK,
91 92
  PROP_ACCEL_GROUP,
  PROP_ALWAYS_SHOW_IMAGE
93 94
};

95 96 97 98 99 100
static GtkActivatableIface *parent_activatable_iface;


G_DEFINE_TYPE_WITH_CODE (GtkImageMenuItem, gtk_image_menu_item, GTK_TYPE_MENU_ITEM,
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
						gtk_image_menu_item_activatable_interface_init))
101

102 103 104
#define GET_PRIVATE(object)  \
  (G_TYPE_INSTANCE_GET_PRIVATE ((object), GTK_TYPE_IMAGE_MENU_ITEM, GtkImageMenuItemPrivate))

105 106 107
static void
gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
{
108 109 110 111 112 113 114 115
  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
116
  widget_class->screen_changed = gtk_image_menu_item_screen_changed;
117 118
  widget_class->size_request = gtk_image_menu_item_size_request;
  widget_class->size_allocate = gtk_image_menu_item_size_allocate;
119
  widget_class->map = gtk_image_menu_item_map;
120 121 122 123 124

  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;
125 126
  menu_item_class->set_label           = gtk_image_menu_item_set_label;
  menu_item_class->get_label           = gtk_image_menu_item_get_label;
127

128
  gobject_class->finalize     = gtk_image_menu_item_finalize;
129 130 131 132 133 134
  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",
135 136
                                                        P_("Image widget"),
                                                        P_("Child widget to appear next to the menu text"),
137
                                                        GTK_TYPE_WIDGET,
138
                                                        GTK_PARAM_READWRITE));
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));

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
  /**
   * GtkImageMenuItem:always-show-image:
   *
   * If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images 
   * setting and always show the image, if available.
   *
   * Use this property if the menuitem would be useless or hard to use
   * without the image. 
   *
   * Since: 2.16
   **/
  g_object_class_install_property (gobject_class,
                                   PROP_ALWAYS_SHOW_IMAGE,
                                   g_param_spec_boolean ("always-show-image",
							 P_("Always show image"),
							 P_("Whether the image will always be shown"),
							 FALSE,
							 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));

174 175 176 177 178 179 180 181 182 183 184 185 186 187
  /**
   * 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
188 189 190 191 192

  gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
						       P_("Show menu images"),
						       P_("Whether images should be shown in menus"),
						       TRUE,
193
						       GTK_PARAM_READWRITE));
Matthias Clasen's avatar
Matthias Clasen committed
194
  
195 196 197

  g_type_class_add_private (object_class, sizeof (GtkImageMenuItemPrivate));

198 199 200 201 202
}

static void
gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
{
203 204 205 206 207
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (image_menu_item);

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

208 209 210
  image_menu_item->image = NULL;
}

211 212 213 214 215 216 217 218 219 220 221
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);
}

222
static void
223 224 225
gtk_image_menu_item_set_property (GObject         *object,
                                  guint            prop_id,
                                  const GValue    *value,
Tim Janik's avatar
Tim Janik committed
226
                                  GParamSpec      *pspec)
227
{
228 229 230 231 232
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_IMAGE:
233 234 235 236 237
      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;
238 239 240
    case PROP_ALWAYS_SHOW_IMAGE:
      gtk_image_menu_item_set_always_show_image (image_menu_item, g_value_get_boolean (value));
      break;
241 242
    case PROP_ACCEL_GROUP:
      gtk_image_menu_item_set_accel_group (image_menu_item, g_value_get_object (value));
243 244 245 246 247 248
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}
249

250 251 252 253
static void
gtk_image_menu_item_get_property (GObject         *object,
                                  guint            prop_id,
                                  GValue          *value,
Tim Janik's avatar
Tim Janik committed
254
                                  GParamSpec      *pspec)
255 256
{
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
257
  
258 259 260
  switch (prop_id)
    {
    case PROP_IMAGE:
261 262 263 264
      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));      
265
      break;
266 267 268
    case PROP_ALWAYS_SHOW_IMAGE:
      g_value_set_boolean (value, gtk_image_menu_item_get_always_show_image (image_menu_item));
      break;
269 270 271 272
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
273 274
}

Matthias Clasen's avatar
Matthias Clasen committed
275 276 277
static gboolean
show_image (GtkImageMenuItem *image_menu_item)
{
278
  GtkImageMenuItemPrivate *priv = GET_PRIVATE (image_menu_item);
Matthias Clasen's avatar
Matthias Clasen committed
279 280 281
  GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
  gboolean show;

282 283 284 285
  if (priv->always_show_image)
    show = TRUE;
  else
    g_object_get (settings, "gtk-menu-images", &show, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
286 287 288

  return show;
}
289

290 291 292 293 294 295 296 297 298 299 300 301 302
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);
}

303 304 305 306 307 308 309 310 311 312 313 314
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);
}

315 316 317 318
static void
gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
					 gint        *requisition)
{
319
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
320 321 322 323 324 325
  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;
326

327 328
  *requisition = 0;

329
  if (image_menu_item->image && gtk_widget_get_visible (image_menu_item->image))
330
    {
331
      GtkRequisition image_requisition;
332
      guint toggle_spacing;
333 334 335
      gtk_widget_get_child_requisition (image_menu_item->image,
                                        &image_requisition);

336 337 338 339 340
      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)
341
	{
342 343 344 345 346 347 348
	  if (image_requisition.width > 0)
	    *requisition = image_requisition.width + toggle_spacing;
	}
      else
	{
	  if (image_requisition.height > 0)
	    *requisition = image_requisition.height + toggle_spacing;
349
	}
350
    }
351 352
}

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
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;
}
406 407 408 409 410 411

static void
gtk_image_menu_item_size_request (GtkWidget      *widget,
                                  GtkRequisition *requisition)
{
  GtkImageMenuItem *image_menu_item;
412
  gint child_width = 0;
413
  gint child_height = 0;
414
  GtkPackDirection pack_dir;
415
  
416 417 418 419 420
  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;

421
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
422

423
  if (image_menu_item->image && gtk_widget_get_visible (image_menu_item->image))
424 425 426 427 428 429
    {
      GtkRequisition child_requisition;
      
      gtk_widget_size_request (image_menu_item->image,
                               &child_requisition);

430
      child_width = child_requisition.width;
431 432
      child_height = child_requisition.height;
    }
433 434

  GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_request (widget, requisition);
435 436 437 438

  /* not done with height since that happens via the
   * toggle_size_request
   */
439 440 441 442 443
  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);
    
444 445 446 447 448 449 450 451 452 453 454 455
  
  /* 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;
456 457 458 459 460 461
  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;
462 463
  
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);  
464 465

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

467
  if (image_menu_item->image && gtk_widget_get_visible (image_menu_item->image))
468
    {
469 470
      gint x, y, offset;
      GtkRequisition child_requisition;
471
      GtkAllocation child_allocation;
472 473 474
      guint horizontal_padding, toggle_spacing;

      gtk_widget_style_get (widget,
475 476
			    "horizontal-padding", &horizontal_padding,
			    "toggle-spacing", &toggle_spacing,
477
			    NULL);
478 479 480 481
      
      /* Man this is lame hardcoding action, but I can't
       * come up with a solution that's really better.
       */
482 483 484 485

      gtk_widget_get_child_requisition (image_menu_item->image,
                                        &child_requisition);

486 487
      if (pack_dir == GTK_PACK_DIRECTION_LTR ||
	  pack_dir == GTK_PACK_DIRECTION_RTL)
488
	{
489 490 491 492 493 494
	  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 +
495
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
496
	       toggle_spacing - child_requisition.width) / 2;
497 498 499 500 501 502 503
	  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;
504 505 506
	}
      else
	{
507 508 509 510 511 512 513 514 515 516
	  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 -
517 518
	      GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
519
	       toggle_spacing - child_requisition.height) / 2;
520

521 522 523
	  x = (widget->allocation.width - child_requisition.width) / 2;
	}
      
524 525
      child_allocation.width = child_requisition.width;
      child_allocation.height = child_requisition.height;
526 527
      child_allocation.x = widget->allocation.x + MAX (x, 0);
      child_allocation.y = widget->allocation.y + MAX (y, 0);
528 529 530 531 532 533 534 535 536 537 538

      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)
{
539
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
540 541 542 543 544

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

546
  if (include_internals && image_menu_item->image)
547 548 549
    (* callback) (image_menu_item->image, callback_data);
}

550 551 552 553 554

static void 
gtk_image_menu_item_activatable_interface_init (GtkActivatableIface  *iface)
{
  parent_activatable_iface = g_type_interface_peek_parent (iface);
555 556
  iface->update = gtk_image_menu_item_update;
  iface->sync_action_properties = gtk_image_menu_item_sync_action_properties;
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
}

static gboolean
activatable_update_stock_id (GtkImageMenuItem *image_menu_item, GtkAction *action)
{
  GtkWidget   *image;
  const gchar *stock_id  = gtk_action_get_stock_id (action);

  image = gtk_image_menu_item_get_image (image_menu_item);
	  
  if (GTK_IS_IMAGE (image) &&
      stock_id && gtk_icon_factory_lookup_default (stock_id))
    {
      gtk_image_set_from_stock (GTK_IMAGE (image), stock_id, GTK_ICON_SIZE_MENU);
      return TRUE;
    }

  return FALSE;
}

static gboolean
activatable_update_gicon (GtkImageMenuItem *image_menu_item, GtkAction *action)
{
  GtkWidget   *image;
  GIcon       *icon = gtk_action_get_gicon (action);
  const gchar *stock_id = gtk_action_get_stock_id (action);

  image = gtk_image_menu_item_get_image (image_menu_item);

  if (icon && GTK_IS_IMAGE (image) &&
      !(stock_id && gtk_icon_factory_lookup_default (stock_id)))
    {
      gtk_image_set_from_gicon (GTK_IMAGE (image), icon, GTK_ICON_SIZE_MENU);
      return TRUE;
    }

  return FALSE;
}

static void
activatable_update_icon_name (GtkImageMenuItem *image_menu_item, GtkAction *action)
{
  GtkWidget   *image;
  const gchar *icon_name = gtk_action_get_icon_name (action);

  image = gtk_image_menu_item_get_image (image_menu_item);
	  
604
  if (GTK_IS_IMAGE (image) && 
605 606 607 608 609 610 611
      (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
       gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_ICON_NAME))
    {
      gtk_image_set_from_icon_name (GTK_IMAGE (image), icon_name, GTK_ICON_SIZE_MENU);
    }
}

612 613 614 615
static void
gtk_image_menu_item_update (GtkActivatable *activatable,
			    GtkAction      *action,
			    const gchar    *property_name)
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
{
  GtkImageMenuItem *image_menu_item;
  gboolean   use_appearance;

  image_menu_item = GTK_IMAGE_MENU_ITEM (activatable);

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

  use_appearance = gtk_activatable_get_use_action_appearance (activatable);
  if (!use_appearance)
    return;

  if (strcmp (property_name, "stock-id") == 0)
    activatable_update_stock_id (image_menu_item, action);
  else if (strcmp (property_name, "gicon") == 0)
    activatable_update_gicon (image_menu_item, action);
  else if (strcmp (property_name, "icon-name") == 0)
    activatable_update_icon_name (image_menu_item, action);
}

static void 
637 638
gtk_image_menu_item_sync_action_properties (GtkActivatable *activatable,
			                    GtkAction      *action)
639 640 641 642 643 644 645
{
  GtkImageMenuItem *image_menu_item;
  GtkWidget *image;
  gboolean   use_appearance;

  image_menu_item = GTK_IMAGE_MENU_ITEM (activatable);

646
  parent_activatable_iface->sync_action_properties (activatable, action);
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

  if (!action)
    return;

  use_appearance = gtk_activatable_get_use_action_appearance (activatable);
  if (!use_appearance)
    return;

  image = gtk_image_menu_item_get_image (image_menu_item);
  if (image && !GTK_IS_IMAGE (image))
    {
      gtk_image_menu_item_set_image (image_menu_item, NULL);
      image = NULL;
    }
  
  if (!image)
    {
      image = gtk_image_new ();
      gtk_widget_show (image);
      gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (activatable),
				     image);
    }
  
  if (!activatable_update_stock_id (image_menu_item, action) &&
      !activatable_update_gicon (image_menu_item, action))
    activatable_update_icon_name (image_menu_item, action);

674 675
  gtk_image_menu_item_set_always_show_image (image_menu_item,
                                             gtk_action_get_always_show_image (action));
676 677 678
}


Matthias Clasen's avatar
Matthias Clasen committed
679 680 681 682 683 684
/**
 * gtk_image_menu_item_new:
 * @returns: a new #GtkImageMenuItem.
 *
 * Creates a new #GtkImageMenuItem with an empty label.
 **/
685
GtkWidget*
686 687 688 689 690
gtk_image_menu_item_new (void)
{
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
691 692 693 694 695 696 697
/**
 * 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. 
 **/
698 699
GtkWidget*
gtk_image_menu_item_new_with_label (const gchar *label)
700
{
701 702 703
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "label", label,
		       NULL);
704 705
}

706 707 708

/**
 * gtk_image_menu_item_new_with_mnemonic:
Matthias Clasen's avatar
Matthias Clasen committed
709
 * @label: the text of the menu item, with an underscore in front of the
710 711 712 713 714 715 716 717 718 719
 *         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)
{
720 721 722 723
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "use-underline", TRUE,
		       "label", label,
		       NULL);
724 725
}

Matthias Clasen's avatar
Matthias Clasen committed
726 727 728
/**
 * gtk_image_menu_item_new_from_stock:
 * @stock_id: the name of the stock item.
729 730
 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
 *   or %NULL.
Matthias Clasen's avatar
Matthias Clasen committed
731 732 733 734 735
 * @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.
736
 *
Matthias Clasen's avatar
Matthias Clasen committed
737 738 739 740 741
 * 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
742
 **/
743 744 745 746
GtkWidget*
gtk_image_menu_item_new_from_stock (const gchar      *stock_id,
				    GtkAccelGroup    *accel_group)
{
747 748 749 750 751 752
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, 
		       "label", stock_id,
		       "use-stock", TRUE,
		       "accel-group", accel_group,
		       NULL);
}
753

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
/**
 * 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));
771

772
  priv = GET_PRIVATE (image_menu_item);
773

774
  if (priv->use_stock != use_stock)
775
    {
776
      priv->use_stock = use_stock;
777

778 779 780 781 782 783 784 785 786 787 788 789 790 791
      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
 *
 * 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
Matthias Clasen's avatar
Matthias Clasen committed
792
 *     stock id to select the stock item for the item
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
 *
 * 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;
}

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
/**
 * gtk_image_menu_item_set_always_show_image:
 * @image_menu_item: a #GtkImageMenuItem
 * @always_show: %TRUE if the menuitem should always show the image
 *
 * If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images 
 * setting and always show the image, if available.
 *
 * Use this property if the menuitem would be useless or hard to use
 * without the image. 
 * 
 * Since: 2.16
 */
void
gtk_image_menu_item_set_always_show_image (GtkImageMenuItem *image_menu_item,
                                           gboolean          always_show)
{
  GtkImageMenuItemPrivate *priv;

  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));

  priv = GET_PRIVATE (image_menu_item);

  if (priv->always_show_image != always_show)
    {
      priv->always_show_image = always_show;

      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);
        }

      g_object_notify (G_OBJECT (image_menu_item), "always-show-image");
    }
}

/**
 * gtk_image_menu_item_get_always_show_image:
 * @image_menu_item: a #GtkImageMenuItem
 *
Matthias Clasen's avatar
Matthias Clasen committed
851
 * Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
 * setting and always show the image, if available.
 * 
 * Returns: %TRUE if the menu item will always show the image
 *
 * Since: 2.16
 */
gboolean
gtk_image_menu_item_get_always_show_image (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->always_show_image;
}

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905

/**
 * 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()).
 *
 * 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),
906 907 908 909 910
				    "activate",
				    accel_group,
				    stock_item.keyval,
				    stock_item.modifier,
				    GTK_ACCEL_VISIBLE);
911 912 913
	
	g_object_notify (G_OBJECT (image_menu_item), "accel-group");
      }
914 915
}

Matthias Clasen's avatar
Matthias Clasen committed
916 917 918
/** 
 * gtk_image_menu_item_set_image:
 * @image_menu_item: a #GtkImageMenuItem.
919 920
 * @image: (allow-none): a widget to set as the image for the menu item.
 *
Matthias Clasen's avatar
Matthias Clasen committed
921
 * Sets the image of @image_menu_item to the given widget.
Matthias Clasen's avatar
Matthias Clasen committed
922 923
 * 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
924
 **/ 
925
void
926 927
gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
                               GtkWidget        *image)
928 929
{
  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
930 931 932 933 934 935 936 937 938 939 940 941 942 943

  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));
944
  g_object_set (image,
Matthias Clasen's avatar
Matthias Clasen committed
945
		"visible", show_image (image_menu_item),
946
		"no-show-all", TRUE,
Matthias Clasen's avatar
Matthias Clasen committed
947
		NULL);
948

949
  g_object_notify (G_OBJECT (image_menu_item), "image");
950 951
}

Matthias Clasen's avatar
Matthias Clasen committed
952 953 954 955 956 957 958 959
/**
 * 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().
 **/
960 961 962 963 964 965 966 967
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;
}

968
static void
969 970 971 972 973 974 975 976 977 978 979
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;
      
980
      widget_was_visible = gtk_widget_get_visible (child);
981 982 983 984
      
      gtk_widget_unparent (child);
      image_menu_item->image = NULL;
      
985 986
      if (widget_was_visible &&
          gtk_widget_get_visible (GTK_WIDGET (container)))
987
        gtk_widget_queue_resize (GTK_WIDGET (container));
988 989

      g_object_notify (G_OBJECT (image_menu_item), "image");
990 991 992
    }
  else
    {
993
      GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->remove (container, child);
994 995 996
    }
}

Matthias Clasen's avatar
Matthias Clasen committed
997 998 999
static void 
show_image_change_notify (GtkImageMenuItem *image_menu_item)
{
Matthias Clasen's avatar
Matthias Clasen committed
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  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)
{
1022
  GList *list, *l;
Matthias Clasen's avatar
Matthias Clasen committed
1023 1024 1025

  list = gtk_window_list_toplevels ();

1026 1027 1028
  for (l = list; l; l = l->next)
    gtk_container_forall (GTK_CONTAINER (l->data), 
			  traverse_container, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
1029 1030

  g_list_free (list);  
Matthias Clasen's avatar
Matthias Clasen committed
1031 1032 1033 1034 1035 1036 1037
}

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

Matthias Clasen's avatar
Matthias Clasen committed
1040
  if (!gtk_widget_has_screen (widget))
Matthias Clasen's avatar
Matthias Clasen committed
1041
    return;
1042

Matthias Clasen's avatar
Matthias Clasen committed
1043 1044 1045
  settings = gtk_widget_get_settings (widget);
  
  show_image_connection = 
1046 1047
    GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings), 
					 "gtk-image-menu-item-connection"));
Matthias Clasen's avatar
Matthias Clasen committed
1048 1049 1050
  
  if (show_image_connection)
    return;
Matthias Clasen's avatar
Matthias Clasen committed
1051

Matthias Clasen's avatar
Matthias Clasen committed
1052 1053
  show_image_connection =
    g_signal_connect (settings, "notify::gtk-menu-images",
1054
		      G_CALLBACK (gtk_image_menu_item_setting_changed), NULL);
Matthias Clasen's avatar
Matthias Clasen committed
1055
  g_object_set_data (G_OBJECT (settings), 
Matthias Clasen's avatar
Matthias Clasen committed
1056
		     I_("gtk-image-menu-item-connection"),
1057
		     GUINT_TO_POINTER (show_image_connection));
Matthias Clasen's avatar
Matthias Clasen committed
1058 1059 1060

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

1062 1063
#define __GTK_IMAGE_MENU_ITEM_C__
#include "gtkaliasdef.c"