gtkimagemenuitem.c 17.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/* GTK - The GIMP Toolkit
 * 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
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

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

Matthias Clasen's avatar
Matthias Clasen committed
35 36 37 38 39 40 41 42 43 44
typedef struct _GtkImageMenuItemPrivate GtkImageMenuItemPrivate;

struct _GtkImageMenuItemPrivate 
{
  GtkSettings *settings;
  guint        show_image_connection;
};

#define GTK_IMAGE_MENU_ITEM_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_IMAGE_MENU_ITEM, GtkImageMenuItemPrivate))

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
static void gtk_image_menu_item_class_init           (GtkImageMenuItemClass *klass);
static void gtk_image_menu_item_init                 (GtkImageMenuItem      *image_menu_item);
static void gtk_image_menu_item_size_request         (GtkWidget        *widget,
                                                      GtkRequisition   *requisition);
static void gtk_image_menu_item_size_allocate        (GtkWidget        *widget,
                                                      GtkAllocation    *allocation);
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_forall     (GtkContainer   *container,
                                            gboolean	    include_internals,
                                            GtkCallback     callback,
                                            gpointer        callback_data);

61 62 63
static void gtk_image_menu_item_set_property (GObject         *object,
                                              guint            prop_id,
                                              const GValue    *value,
Tim Janik's avatar
Tim Janik committed
64
                                              GParamSpec      *pspec);
65 66 67
static void gtk_image_menu_item_get_property (GObject         *object,
                                              guint            prop_id,
                                              GValue          *value,
Tim Janik's avatar
Tim Janik committed
68
                                              GParamSpec      *pspec);
Matthias Clasen's avatar
Matthias Clasen committed
69 70
static void gtk_image_menu_item_screen_changed (GtkWidget        *widget,
						GdkScreen        *previous_screen);
71 72 73 74 75 76 77


enum {
  PROP_ZERO,
  PROP_IMAGE
};

78 79
static GtkMenuItemClass *parent_class = NULL;

Manish Singh's avatar
Manish Singh committed
80
GType
81 82
gtk_image_menu_item_get_type (void)
{
Manish Singh's avatar
Manish Singh committed
83
  static GType image_menu_item_type = 0;
84 85 86

  if (!image_menu_item_type)
    {
Manish Singh's avatar
Manish Singh committed
87
      static const GTypeInfo image_menu_item_info =
88 89
      {
        sizeof (GtkImageMenuItemClass),
Manish Singh's avatar
Manish Singh committed
90 91 92 93 94 95 96 97
	NULL,		/* base_init */
	NULL,		/* base_finalize */
        (GClassInitFunc) gtk_image_menu_item_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
        sizeof (GtkImageMenuItem),
	0,		/* n_preallocs */
        (GInstanceInitFunc) gtk_image_menu_item_init,
98 99
      };

Manish Singh's avatar
Manish Singh committed
100 101 102
      image_menu_item_type =
	g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkImageMenuItem",
				&image_menu_item_info, 0);
103 104 105 106 107 108 109 110
    }

  return image_menu_item_type;
}

static void
gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
{
111
  GObjectClass *gobject_class;
112 113 114
  GtkWidgetClass *widget_class;
  GtkMenuItemClass *menu_item_class;
  GtkContainerClass *container_class;
115 116

  gobject_class = (GObjectClass*) klass;
117 118 119 120
  widget_class = (GtkWidgetClass*) klass;
  menu_item_class = (GtkMenuItemClass*) klass;
  container_class = (GtkContainerClass*) klass;
  
Manish Singh's avatar
Manish Singh committed
121
  parent_class = g_type_class_peek_parent (klass);
122
  
Matthias Clasen's avatar
Matthias Clasen committed
123
  widget_class->screen_changed = gtk_image_menu_item_screen_changed;
124 125 126 127 128 129 130
  widget_class->size_request = gtk_image_menu_item_size_request;
  widget_class->size_allocate = gtk_image_menu_item_size_allocate;

  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;
131 132 133 134 135 136 137

  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",
138 139
                                                        P_("Image widget"),
                                                        P_("Child widget to appear next to the menu text"),
140 141
                                                        GTK_TYPE_WIDGET,
                                                        G_PARAM_READABLE | G_PARAM_WRITABLE));
Matthias Clasen's avatar
Matthias Clasen committed
142 143 144 145 146 147 148 149

  gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
						       P_("Show menu images"),
						       P_("Whether images should be shown in menus"),
						       TRUE,
						       G_PARAM_READWRITE));

  g_type_class_add_private (gobject_class, sizeof (GtkImageMenuItemPrivate));  
150 151 152 153 154 155 156 157 158
}

static void
gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
{
  image_menu_item->image = NULL;
}

static void
159 160 161
gtk_image_menu_item_set_property (GObject         *object,
                                  guint            prop_id,
                                  const GValue    *value,
Tim Janik's avatar
Tim Janik committed
162
                                  GParamSpec      *pspec)
163
{
164 165 166 167 168 169
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_IMAGE:
      {
170 171 172 173 174
        GtkWidget *image;

        image = (GtkWidget*) g_value_get_object (value);

	gtk_image_menu_item_set_image (image_menu_item, image);
175 176 177 178 179 180 181 182 183 184 185
      }
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}
static void
gtk_image_menu_item_get_property (GObject         *object,
                                  guint            prop_id,
                                  GValue          *value,
Tim Janik's avatar
Tim Janik committed
186
                                  GParamSpec      *pspec)
187 188
{
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
189
  
190 191 192 193 194 195 196 197 198 199
  switch (prop_id)
    {
    case PROP_IMAGE:
      g_value_set_object (value,
                          (GObject*) image_menu_item->image);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
200 201
}

Matthias Clasen's avatar
Matthias Clasen committed
202 203 204 205 206 207 208 209 210 211
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;
}
212

213 214 215 216
static void
gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
					 gint        *requisition)
{
217
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
218

219 220
  *requisition = 0;

Matthias Clasen's avatar
Matthias Clasen committed
221
  if (image_menu_item->image && show_image (image_menu_item))
222
    {
223 224 225 226 227 228 229 230 231 232 233
      guint image_width = image_menu_item->image->requisition.width;

      if (image_width > 0)
	{
	  guint toggle_spacing;
	  gtk_widget_style_get (GTK_WIDGET (menu_item),
				"toggle_spacing", &toggle_spacing,
				NULL);
	  
	  *requisition = image_width + toggle_spacing;
	}
234
    }
235 236 237 238 239 240 241 242 243 244 245 246
}


static void
gtk_image_menu_item_size_request (GtkWidget      *widget,
                                  GtkRequisition *requisition)
{
  GtkImageMenuItem *image_menu_item;
  gint child_height = 0;
  
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
  
Matthias Clasen's avatar
Matthias Clasen committed
247 248 249
  if (image_menu_item->image && 
      GTK_WIDGET_VISIBLE (image_menu_item->image) && 
      show_image (image_menu_item))
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
    {
      GtkRequisition child_requisition;
      
      gtk_widget_size_request (image_menu_item->image,
                               &child_requisition);

      child_height = child_requisition.height;
    }
  
  (* GTK_WIDGET_CLASS (parent_class)->size_request) (widget, requisition);

  /* not done with height since that happens via the
   * toggle_size_request
   */
  requisition->height = MAX (requisition->height, child_height);
  
  /* 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;
  
  image_menu_item = GTK_IMAGE_MENU_ITEM (widget);  
  
  (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);

Matthias Clasen's avatar
Matthias Clasen committed
282
  if (image_menu_item->image && show_image (image_menu_item))
283
    {
284
      gint width, height, x, y, offset;
285
      GtkAllocation child_allocation;
286 287 288 289 290 291
      guint horizontal_padding, toggle_spacing;

      gtk_widget_style_get (widget,
			    "horizontal_padding", &horizontal_padding,
			    "toggle_spacing", &toggle_spacing,
			    NULL);
292 293 294 295 296 297 298
      
      /* Man this is lame hardcoding action, but I can't
       * come up with a solution that's really better.
       */
      
      width = image_menu_item->image->requisition.width;
      height = image_menu_item->image->requisition.height;
299
      offset = GTK_CONTAINER (image_menu_item)->border_width +
300
	widget->style->xthickness;
301 302

      if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) 
303 304 305 306 307 308 309 310 311 312 313 314 315
	{
	  x = offset + horizontal_padding +
	      (GTK_MENU_ITEM (image_menu_item)->toggle_size -
	       toggle_spacing - width) / 2;
	}
      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 - width) / 2;
	}

316 317 318 319
      y = (widget->allocation.height - height) / 2;

      child_allocation.width = width;
      child_allocation.height = height;
320 321
      child_allocation.x = widget->allocation.x + MAX (x, 0);
      child_allocation.y = widget->allocation.y + MAX (y, 0);
322 323 324 325 326 327 328 329 330 331 332

      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)
{
333
  GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
334 335 336 337 338 339 340 341 342 343
  
  (* GTK_CONTAINER_CLASS (parent_class)->forall) (container,
                                                  include_internals,
                                                  callback,
                                                  callback_data);

  if (image_menu_item->image)
    (* callback) (image_menu_item->image, callback_data);
}

Matthias Clasen's avatar
Matthias Clasen committed
344 345 346 347 348 349
/**
 * gtk_image_menu_item_new:
 * @returns: a new #GtkImageMenuItem.
 *
 * Creates a new #GtkImageMenuItem with an empty label.
 **/
350
GtkWidget*
351 352 353 354 355
gtk_image_menu_item_new (void)
{
  return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
356 357 358 359 360 361 362
/**
 * 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. 
 **/
363 364
GtkWidget*
gtk_image_menu_item_new_with_label (const gchar *label)
365 366 367 368
{
  GtkImageMenuItem *image_menu_item;
  GtkWidget *accel_label;
  
Manish Singh's avatar
Manish Singh committed
369
  image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
370 371 372 373 374 375 376 377 378 379 380 381

  accel_label = gtk_accel_label_new (label);
  gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);

  gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
  gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
                                    GTK_WIDGET (image_menu_item));
  gtk_widget_show (accel_label);

  return GTK_WIDGET(image_menu_item);
}

382 383 384

/**
 * gtk_image_menu_item_new_with_mnemonic:
Matthias Clasen's avatar
Matthias Clasen committed
385
 * @label: the text of the menu item, with an underscore in front of the
386 387 388 389 390 391 392 393 394 395 396 397 398
 *         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)
{
  GtkImageMenuItem *image_menu_item;
  GtkWidget *accel_label;
  
Manish Singh's avatar
Manish Singh committed
399
  image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
400

Manish Singh's avatar
Manish Singh committed
401
  accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
402 403 404 405 406 407 408 409 410 411 412
  gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
  gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);

  gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
  gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
                                    GTK_WIDGET (image_menu_item));
  gtk_widget_show (accel_label);

  return GTK_WIDGET(image_menu_item);
}

Matthias Clasen's avatar
Matthias Clasen committed
413 414 415
/**
 * gtk_image_menu_item_new_from_stock:
 * @stock_id: the name of the stock item.
416 417
 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
 *   or %NULL.
Matthias Clasen's avatar
Matthias Clasen committed
418 419 420 421 422
 * @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.
423
 *
Matthias Clasen's avatar
Matthias Clasen committed
424 425 426 427 428
 * 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
429
 **/
430 431 432 433 434 435 436 437 438 439 440 441 442 443
GtkWidget*
gtk_image_menu_item_new_from_stock (const gchar      *stock_id,
				    GtkAccelGroup    *accel_group)
{
  GtkWidget *image;
  GtkStockItem stock_item;
  GtkWidget *item;

  g_return_val_if_fail (stock_id != NULL, NULL);

  image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);

  if (gtk_stock_lookup (stock_id, &stock_item))
    {
444
      item = gtk_image_menu_item_new_with_mnemonic (stock_item.label);
445 446

      gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
447 448 449 450 451 452 453 454 455 456
      
      if (stock_item.keyval && accel_group)
	gtk_widget_add_accelerator (item,
				    "activate",
				    accel_group,
				    stock_item.keyval,
				    stock_item.modifier,
				    GTK_ACCEL_VISIBLE);
    }
  else
457
    {
458
      item = gtk_image_menu_item_new_with_mnemonic (stock_id);
459 460 461 462

      gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
    }

463 464 465 466
  gtk_widget_show (image);
  return item;
}

Matthias Clasen's avatar
Matthias Clasen committed
467 468 469 470 471 472 473
/** 
 * 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.
 **/ 
474
void
475 476
gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
                               GtkWidget        *image)
477 478
{
  g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
479 480 481 482 483 484 485 486 487 488 489 490 491 492

  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));
Matthias Clasen's avatar
Matthias Clasen committed
493 494 495 496
  g_object_set (image, 
		"visible", show_image (image_menu_item),
		"no_show_all", TRUE,
		NULL);
497

498
  g_object_notify (G_OBJECT (image_menu_item), "image");
499 500
}

Matthias Clasen's avatar
Matthias Clasen committed
501 502 503 504 505 506 507 508
/**
 * 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().
 **/
509 510 511 512 513 514 515 516
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;
}

517
static void
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
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;
      
534
      if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
535
        gtk_widget_queue_resize (GTK_WIDGET (container));
536 537

      g_object_notify (G_OBJECT (image_menu_item), "image");
538 539 540 541 542 543 544
    }
  else
    {
      (* GTK_CONTAINER_CLASS (parent_class)->remove) (container, child);
    }
}

Matthias Clasen's avatar
Matthias Clasen committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
static void 
show_image_change_notify (GtkImageMenuItem *image_menu_item)
{
  if (image_menu_item->image) 
    g_object_set (image_menu_item->image, "visible", show_image (image_menu_item), NULL);
}

static void
gtk_image_menu_item_screen_changed (GtkWidget *widget,
				    GdkScreen *previous_screen)
{
  GtkImageMenuItemPrivate *priv = GTK_IMAGE_MENU_ITEM_GET_PRIVATE (widget);
  GtkSettings *settings;

  if (gtk_widget_has_screen (widget))
    settings = gtk_widget_get_settings (widget);
  else
    settings = NULL;

  if (settings == priv->settings)
    return;
566

Matthias Clasen's avatar
Matthias Clasen committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  if (priv->settings)
    {
      g_signal_handler_disconnect (priv->settings, priv->show_image_connection);
      g_object_unref (priv->settings);
    }

  if (settings)
    {
      priv->show_image_connection =
	g_signal_connect_swapped (settings,
				  "notify::gtk-menu-images",
				  G_CALLBACK (show_image_change_notify),
				  widget);

      g_object_ref (settings);
      priv->settings = settings;
    }
  else
    priv->settings = NULL;

  show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
}