Pileus Git - ~andy/gtk/blob - gtk/gtkimagemenuitem.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2001 Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * 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 #include "gtkalias.h"
  29 #include "gtkimagemenuitem.h"
  30 #include "gtkaccellabel.h"
  31 #include "gtkintl.h"
  32 #include "gtkstock.h"
  33 #include "gtkiconfactory.h"
  34 #include "gtkimage.h"
  35
  36 typedef struct _GtkImageMenuItemPrivate GtkImageMenuItemPrivate;
  37
  38 struct _GtkImageMenuItemPrivate
  39 {
  40   GtkSettings *settings;
  41   guint        show_image_connection;
  42 };
  43
  44 #define GTK_IMAGE_MENU_ITEM_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_IMAGE_MENU_ITEM, GtkImageMenuItemPrivate))
  45
  46 static void gtk_image_menu_item_class_init           (GtkImageMenuItemClass *klass);
  47 static void gtk_image_menu_item_init                 (GtkImageMenuItem      *image_menu_item);
  48 static void gtk_image_menu_item_size_request         (GtkWidget        *widget,
  49                                                       GtkRequisition   *requisition);
  50 static void gtk_image_menu_item_size_allocate        (GtkWidget        *widget,
  51                                                       GtkAllocation    *allocation);
  52 static void gtk_image_menu_item_remove               (GtkContainer          *container,
  53                                                       GtkWidget             *child);
  54 static void gtk_image_menu_item_toggle_size_request  (GtkMenuItem           *menu_item,
  55                                                       gint                  *requisition);
  56
  57 static void gtk_image_menu_item_forall     (GtkContainer   *container,
  58                                             gboolean        include_internals,
  59                                             GtkCallback     callback,
  60                                             gpointer        callback_data);
  61
  62 static void gtk_image_menu_item_set_property (GObject         *object,
  63                                               guint            prop_id,
  64                                               const GValue    *value,
  65                                               GParamSpec      *pspec);
  66 static void gtk_image_menu_item_get_property (GObject         *object,
  67                                               guint            prop_id,
  68                                               GValue          *value,
  69                                               GParamSpec      *pspec);
  70 static void gtk_image_menu_item_screen_changed (GtkWidget        *widget,
  71                                                 GdkScreen        *previous_screen);
  72
  73
  74 enum {
  75   PROP_ZERO,
  76   PROP_IMAGE
  77 };
  78
  79 static GtkMenuItemClass *parent_class = NULL;
  80
  81 GType
  82 gtk_image_menu_item_get_type (void)
  83 {
  84   static GType image_menu_item_type = 0;
  85
  86   if (!image_menu_item_type)
  87     {
  88       static const GTypeInfo image_menu_item_info =
  89       {
  90         sizeof (GtkImageMenuItemClass),
  91         NULL,           /* base_init */
  92         NULL,           /* base_finalize */
  93         (GClassInitFunc) gtk_image_menu_item_class_init,
  94         NULL,           /* class_finalize */
  95         NULL,           /* class_data */
  96         sizeof (GtkImageMenuItem),
  97         0,              /* n_preallocs */
  98         (GInstanceInitFunc) gtk_image_menu_item_init,
  99       };
 100
 101       image_menu_item_type =
 102         g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkImageMenuItem",
 103                                 &image_menu_item_info, 0);
 104     }
 105
 106   return image_menu_item_type;
 107 }
 108
 109 static void
 110 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
 111 {
 112   GObjectClass *gobject_class;
 113   GtkWidgetClass *widget_class;
 114   GtkMenuItemClass *menu_item_class;
 115   GtkContainerClass *container_class;
 116
 117   gobject_class = (GObjectClass*) klass;
 118   widget_class = (GtkWidgetClass*) klass;
 119   menu_item_class = (GtkMenuItemClass*) klass;
 120   container_class = (GtkContainerClass*) klass;
 121
 122   parent_class = g_type_class_peek_parent (klass);
 123
 124   widget_class->screen_changed = gtk_image_menu_item_screen_changed;
 125   widget_class->size_request = gtk_image_menu_item_size_request;
 126   widget_class->size_allocate = gtk_image_menu_item_size_allocate;
 127
 128   container_class->forall = gtk_image_menu_item_forall;
 129   container_class->remove = gtk_image_menu_item_remove;
 130
 131   menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
 132
 133   gobject_class->set_property = gtk_image_menu_item_set_property;
 134   gobject_class->get_property = gtk_image_menu_item_get_property;
 135
 136   g_object_class_install_property (gobject_class,
 137                                    PROP_IMAGE,
 138                                    g_param_spec_object ("image",
 139                                                         P_("Image widget"),
 140                                                         P_("Child widget to appear next to the menu text"),
 141                                                         GTK_TYPE_WIDGET,
 142                                                         G_PARAM_READABLE | G_PARAM_WRITABLE));
 143
 144   gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
 145                                                        P_("Show menu images"),
 146                                                        P_("Whether images should be shown in menus"),
 147                                                        TRUE,
 148                                                        G_PARAM_READWRITE));
 149
 150   g_type_class_add_private (gobject_class, sizeof (GtkImageMenuItemPrivate));
 151 }
 152
 153 static void
 154 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
 155 {
 156   image_menu_item->image = NULL;
 157 }
 158
 159 static void
 160 gtk_image_menu_item_set_property (GObject         *object,
 161                                   guint            prop_id,
 162                                   const GValue    *value,
 163                                   GParamSpec      *pspec)
 164 {
 165   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
 166
 167   switch (prop_id)
 168     {
 169     case PROP_IMAGE:
 170       {
 171         GtkWidget *image;
 172
 173         image = (GtkWidget*) g_value_get_object (value);
 174
 175         gtk_image_menu_item_set_image (image_menu_item, image);
 176       }
 177       break;
 178     default:
 179       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 180       break;
 181     }
 182 }
 183 static void
 184 gtk_image_menu_item_get_property (GObject         *object,
 185                                   guint            prop_id,
 186                                   GValue          *value,
 187                                   GParamSpec      *pspec)
 188 {
 189   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
 190
 191   switch (prop_id)
 192     {
 193     case PROP_IMAGE:
 194       g_value_set_object (value,
 195                           (GObject*) image_menu_item->image);
 196       break;
 197     default:
 198       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 199       break;
 200     }
 201 }
 202
 203 static gboolean
 204 show_image (GtkImageMenuItem *image_menu_item)
 205 {
 206   GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
 207   gboolean show;
 208
 209   g_object_get (settings, "gtk-menu-images", &show, NULL);
 210
 211   return show;
 212 }
 213
 214 static void
 215 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 216                                          gint        *requisition)
 217 {
 218   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
 219
 220   *requisition = 0;
 221
 222   if (image_menu_item->image && show_image (image_menu_item))
 223     {
 224       GtkRequisition image_requisition;
 225
 226       gtk_widget_get_child_requisition (image_menu_item->image,
 227                                         &image_requisition);
 228
 229       if (image_requisition.width > 0)
 230         {
 231           guint toggle_spacing;
 232           gtk_widget_style_get (GTK_WIDGET (menu_item),
 233                                 "toggle_spacing", &toggle_spacing,
 234                                 NULL);
 235
 236           *requisition = image_requisition.width + toggle_spacing;
 237         }
 238     }
 239 }
 240
 241
 242 static void
 243 gtk_image_menu_item_size_request (GtkWidget      *widget,
 244                                   GtkRequisition *requisition)
 245 {
 246   GtkImageMenuItem *image_menu_item;
 247   gint child_height = 0;
 248
 249   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 250
 251   if (image_menu_item->image &&
 252       GTK_WIDGET_VISIBLE (image_menu_item->image) &&
 253       show_image (image_menu_item))
 254     {
 255       GtkRequisition child_requisition;
 256
 257       gtk_widget_size_request (image_menu_item->image,
 258                                &child_requisition);
 259
 260       child_height = child_requisition.height;
 261     }
 262
 263   (* GTK_WIDGET_CLASS (parent_class)->size_request) (widget, requisition);
 264
 265   /* not done with height since that happens via the
 266    * toggle_size_request
 267    */
 268   requisition->height = MAX (requisition->height, child_height);
 269
 270   /* Note that GtkMenuShell always size requests before
 271    * toggle_size_request, so toggle_size_request will be able to use
 272    * image_menu_item->image->requisition
 273    */
 274 }
 275
 276 static void
 277 gtk_image_menu_item_size_allocate (GtkWidget     *widget,
 278                                    GtkAllocation *allocation)
 279 {
 280   GtkImageMenuItem *image_menu_item;
 281
 282   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 283
 284   (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
 285
 286   if (image_menu_item->image && show_image (image_menu_item))
 287     {
 288       gint x, y, offset;
 289       GtkRequisition child_requisition;
 290       GtkAllocation child_allocation;
 291       guint horizontal_padding, toggle_spacing;
 292
 293       gtk_widget_style_get (widget,
 294                             "horizontal_padding", &horizontal_padding,
 295                             "toggle_spacing", &toggle_spacing,
 296                             NULL);
 297
 298       /* Man this is lame hardcoding action, but I can't
 299        * come up with a solution that's really better.
 300        */
 301
 302       gtk_widget_get_child_requisition (image_menu_item->image,
 303                                         &child_requisition);
 304
 305       offset = GTK_CONTAINER (image_menu_item)->border_width +
 306         widget->style->xthickness;
 307
 308       if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
 309         {
 310           x = offset + horizontal_padding +
 311               (GTK_MENU_ITEM (image_menu_item)->toggle_size -
 312                toggle_spacing - child_requisition.width) / 2;
 313         }
 314       else
 315         {
 316           x = widget->allocation.width - offset - horizontal_padding -
 317               GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
 318               (GTK_MENU_ITEM (image_menu_item)->toggle_size -
 319                toggle_spacing - child_requisition.width) / 2;
 320         }
 321
 322       y = (widget->allocation.height - child_requisition.height) / 2;
 323
 324       child_allocation.width = child_requisition.width;
 325       child_allocation.height = child_requisition.height;
 326       child_allocation.x = widget->allocation.x + MAX (x, 0);
 327       child_allocation.y = widget->allocation.y + MAX (y, 0);
 328
 329       gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
 330     }
 331 }
 332
 333 static void
 334 gtk_image_menu_item_forall (GtkContainer   *container,
 335                             gboolean        include_internals,
 336                             GtkCallback     callback,
 337                             gpointer        callback_data)
 338 {
 339   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
 340
 341   (* GTK_CONTAINER_CLASS (parent_class)->forall) (container,
 342                                                   include_internals,
 343                                                   callback,
 344                                                   callback_data);
 345
 346   if (image_menu_item->image)
 347     (* callback) (image_menu_item->image, callback_data);
 348 }
 349
 350 /**
 351  * gtk_image_menu_item_new:
 352  * @returns: a new #GtkImageMenuItem.
 353  *
 354  * Creates a new #GtkImageMenuItem with an empty label.
 355  **/
 356 GtkWidget*
 357 gtk_image_menu_item_new (void)
 358 {
 359   return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
 360 }
 361
 362 /**
 363  * gtk_image_menu_item_new_with_label:
 364  * @label: the text of the menu item.
 365  * @returns: a new #GtkImageMenuItem.
 366  *
 367  * Creates a new #GtkImageMenuItem containing a label.
 368  **/
 369 GtkWidget*
 370 gtk_image_menu_item_new_with_label (const gchar *label)
 371 {
 372   GtkImageMenuItem *image_menu_item;
 373   GtkWidget *accel_label;
 374
 375   image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
 376
 377   accel_label = gtk_accel_label_new (label);
 378   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 379
 380   gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
 381   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
 382                                     GTK_WIDGET (image_menu_item));
 383   gtk_widget_show (accel_label);
 384
 385   return GTK_WIDGET(image_menu_item);
 386 }
 387
 388
 389 /**
 390  * gtk_image_menu_item_new_with_mnemonic:
 391  * @label: the text of the menu item, with an underscore in front of the
 392  *         mnemonic character
 393  * @returns: a new #GtkImageMenuItem
 394  *
 395  * Creates a new #GtkImageMenuItem containing a label. The label
 396  * will be created using gtk_label_new_with_mnemonic(), so underscores
 397  * in @label indicate the mnemonic for the menu item.
 398  **/
 399 GtkWidget*
 400 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
 401 {
 402   GtkImageMenuItem *image_menu_item;
 403   GtkWidget *accel_label;
 404
 405   image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
 406
 407   accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
 408   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
 409   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 410
 411   gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
 412   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
 413                                     GTK_WIDGET (image_menu_item));
 414   gtk_widget_show (accel_label);
 415
 416   return GTK_WIDGET(image_menu_item);
 417 }
 418
 419 /**
 420  * gtk_image_menu_item_new_from_stock:
 421  * @stock_id: the name of the stock item.
 422  * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
 423  *   or %NULL.
 424  * @returns: a new #GtkImageMenuItem.
 425  *
 426  * Creates a new #GtkImageMenuItem containing the image and text from a
 427  * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
 428  * and #GTK_STOCK_APPLY.
 429  *
 430  * If you want this menu item to have changeable accelerators, then pass in
 431  * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
 432  * appropriate path for the menu item, use gtk_stock_lookup() to look up the
 433  * standard accelerator for the stock item, and if one is found, call
 434  * gtk_accel_map_add_entry() to register it.
 435  **/
 436 GtkWidget*
 437 gtk_image_menu_item_new_from_stock (const gchar      *stock_id,
 438                                     GtkAccelGroup    *accel_group)
 439 {
 440   GtkWidget *image;
 441   GtkStockItem stock_item;
 442   GtkWidget *item;
 443
 444   g_return_val_if_fail (stock_id != NULL, NULL);
 445
 446   image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
 447
 448   if (gtk_stock_lookup (stock_id, &stock_item))
 449     {
 450       item = gtk_image_menu_item_new_with_mnemonic (stock_item.label);
 451
 452       gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
 453
 454       if (stock_item.keyval && accel_group)
 455         gtk_widget_add_accelerator (item,
 456                                     "activate",
 457                                     accel_group,
 458                                     stock_item.keyval,
 459                                     stock_item.modifier,
 460                                     GTK_ACCEL_VISIBLE);
 461     }
 462   else
 463     {
 464       item = gtk_image_menu_item_new_with_mnemonic (stock_id);
 465
 466       gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
 467     }
 468
 469   gtk_widget_show (image);
 470   return item;
 471 }
 472
 473 /**
 474  * gtk_image_menu_item_set_image:
 475  * @image_menu_item: a #GtkImageMenuItem.
 476  * @image: a widget to set as the image for the menu item.
 477  *
 478  * Sets the image of @image_menu_item to the given widget.
 479  **/
 480 void
 481 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
 482                                GtkWidget        *image)
 483 {
 484   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
 485
 486   if (image == image_menu_item->image)
 487     return;
 488
 489   if (image_menu_item->image)
 490     gtk_container_remove (GTK_CONTAINER (image_menu_item),
 491                           image_menu_item->image);
 492
 493   image_menu_item->image = image;
 494
 495   if (image == NULL)
 496     return;
 497
 498   gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
 499   g_object_set (image,
 500                 "visible", show_image (image_menu_item),
 501                 "no_show_all", TRUE,
 502                 NULL);
 503
 504   g_object_notify (G_OBJECT (image_menu_item), "image");
 505 }
 506
 507 /**
 508  * gtk_image_menu_item_get_image:
 509  * @image_menu_item: a #GtkImageMenuItem.
 510  * @returns: the widget set as image of @image_menu_item.
 511  *
 512  * Gets the widget that is currently set as the image of @image_menu_item.
 513  * See gtk_image_menu_item_set_image().
 514  **/
 515 GtkWidget*
 516 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
 517 {
 518   g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
 519
 520   return image_menu_item->image;
 521 }
 522
 523 static void
 524 gtk_image_menu_item_remove (GtkContainer *container,
 525                             GtkWidget    *child)
 526 {
 527   GtkImageMenuItem *image_menu_item;
 528
 529   image_menu_item = GTK_IMAGE_MENU_ITEM (container);
 530
 531   if (child == image_menu_item->image)
 532     {
 533       gboolean widget_was_visible;
 534
 535       widget_was_visible = GTK_WIDGET_VISIBLE (child);
 536
 537       gtk_widget_unparent (child);
 538       image_menu_item->image = NULL;
 539
 540       if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
 541         gtk_widget_queue_resize (GTK_WIDGET (container));
 542
 543       g_object_notify (G_OBJECT (image_menu_item), "image");
 544     }
 545   else
 546     {
 547       (* GTK_CONTAINER_CLASS (parent_class)->remove) (container, child);
 548     }
 549 }
 550
 551 static void
 552 show_image_change_notify (GtkImageMenuItem *image_menu_item)
 553 {
 554   if (image_menu_item->image)
 555     g_object_set (image_menu_item->image, "visible", show_image (image_menu_item), NULL);
 556 }
 557
 558 static void
 559 gtk_image_menu_item_screen_changed (GtkWidget *widget,
 560                                     GdkScreen *previous_screen)
 561 {
 562   GtkImageMenuItemPrivate *priv = GTK_IMAGE_MENU_ITEM_GET_PRIVATE (widget);
 563   GtkSettings *settings;
 564
 565   if (gtk_widget_has_screen (widget))
 566     settings = gtk_widget_get_settings (widget);
 567   else
 568     settings = NULL;
 569
 570   if (settings == priv->settings)
 571     return;
 572
 573   if (priv->settings)
 574     {
 575       g_signal_handler_disconnect (priv->settings, priv->show_image_connection);
 576       g_object_unref (priv->settings);
 577     }
 578
 579   if (settings)
 580     {
 581       priv->show_image_connection =
 582         g_signal_connect_swapped (settings,
 583                                   "notify::gtk-menu-images",
 584                                   G_CALLBACK (show_image_change_notify),
 585                                   widget);
 586
 587       g_object_ref (settings);
 588       priv->settings = settings;
 589     }
 590   else
 591     priv->settings = NULL;
 592
 593   show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
 594 }