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 "gtkimagemenuitem.h"
  28 #include "gtkaccellabel.h"
  29 #include "gtksignal.h"
  30 #include "gtkintl.h"
  31 #include "gtkstock.h"
  32 #include "gtkiconfactory.h"
  33 #include "gtkimage.h"
  34
  35 static void gtk_image_menu_item_class_init           (GtkImageMenuItemClass *klass);
  36 static void gtk_image_menu_item_init                 (GtkImageMenuItem      *image_menu_item);
  37 static void gtk_image_menu_item_size_request         (GtkWidget        *widget,
  38                                                       GtkRequisition   *requisition);
  39 static void gtk_image_menu_item_size_allocate        (GtkWidget        *widget,
  40                                                       GtkAllocation    *allocation);
  41 static void gtk_image_menu_item_remove               (GtkContainer          *container,
  42                                                       GtkWidget             *child);
  43 static void gtk_image_menu_item_toggle_size_request  (GtkMenuItem           *menu_item,
  44                                                       gint                  *requisition);
  45
  46 static void gtk_image_menu_item_map        (GtkWidget      *widget);
  47 static void gtk_image_menu_item_unmap      (GtkWidget      *widget);
  48 static void gtk_image_menu_item_forall     (GtkContainer   *container,
  49                                             gboolean        include_internals,
  50                                             GtkCallback     callback,
  51                                             gpointer        callback_data);
  52
  53 static void gtk_image_menu_item_set_property (GObject         *object,
  54                                               guint            prop_id,
  55                                               const GValue    *value,
  56                                               GParamSpec      *pspec);
  57 static void gtk_image_menu_item_get_property (GObject         *object,
  58                                               guint            prop_id,
  59                                               GValue          *value,
  60                                               GParamSpec      *pspec);
  61
  62
  63 enum {
  64   PROP_ZERO,
  65   PROP_IMAGE
  66 };
  67
  68 static GtkMenuItemClass *parent_class = NULL;
  69
  70 GtkType
  71 gtk_image_menu_item_get_type (void)
  72 {
  73   static GtkType image_menu_item_type = 0;
  74
  75   if (!image_menu_item_type)
  76     {
  77       static const GtkTypeInfo image_menu_item_info =
  78       {
  79         "GtkImageMenuItem",
  80         sizeof (GtkImageMenuItem),
  81         sizeof (GtkImageMenuItemClass),
  82         (GtkClassInitFunc) gtk_image_menu_item_class_init,
  83         (GtkObjectInitFunc) gtk_image_menu_item_init,
  84         /* reserved_1 */ NULL,
  85         /* reserved_2 */ NULL,
  86         (GtkClassInitFunc) NULL,
  87       };
  88
  89       image_menu_item_type = gtk_type_unique (GTK_TYPE_MENU_ITEM, &image_menu_item_info);
  90     }
  91
  92   return image_menu_item_type;
  93 }
  94
  95 static void
  96 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
  97 {
  98   GObjectClass *gobject_class;
  99   GtkObjectClass *object_class;
 100   GtkWidgetClass *widget_class;
 101   GtkMenuItemClass *menu_item_class;
 102   GtkContainerClass *container_class;
 103
 104   gobject_class = (GObjectClass*) klass;
 105   object_class = (GtkObjectClass*) klass;
 106   widget_class = (GtkWidgetClass*) klass;
 107   menu_item_class = (GtkMenuItemClass*) klass;
 108   container_class = (GtkContainerClass*) klass;
 109
 110   parent_class = gtk_type_class (GTK_TYPE_MENU_ITEM);
 111
 112   widget_class->size_request = gtk_image_menu_item_size_request;
 113   widget_class->size_allocate = gtk_image_menu_item_size_allocate;
 114   widget_class->map = gtk_image_menu_item_map;
 115   widget_class->unmap = gtk_image_menu_item_unmap;
 116
 117   container_class->forall = gtk_image_menu_item_forall;
 118   container_class->remove = gtk_image_menu_item_remove;
 119
 120   menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
 121
 122   gobject_class->set_property = gtk_image_menu_item_set_property;
 123   gobject_class->get_property = gtk_image_menu_item_get_property;
 124
 125   g_object_class_install_property (gobject_class,
 126                                    PROP_IMAGE,
 127                                    g_param_spec_object ("image",
 128                                                         _("Image widget"),
 129                                                         _("Child widget to appear next to the menu text"),
 130                                                         GTK_TYPE_WIDGET,
 131                                                         G_PARAM_READABLE | G_PARAM_WRITABLE));
 132 }
 133
 134 static void
 135 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
 136 {
 137   image_menu_item->image = NULL;
 138 }
 139
 140 static void
 141 gtk_image_menu_item_set_property (GObject         *object,
 142                                   guint            prop_id,
 143                                   const GValue    *value,
 144                                   GParamSpec      *pspec)
 145 {
 146   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
 147
 148   switch (prop_id)
 149     {
 150     case PROP_IMAGE:
 151       {
 152         GtkWidget *image;
 153
 154         image = (GtkWidget*) g_value_get_object (value);
 155
 156         gtk_image_menu_item_set_image (image_menu_item, image);
 157       }
 158       break;
 159     default:
 160       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 161       break;
 162     }
 163 }
 164 static void
 165 gtk_image_menu_item_get_property (GObject         *object,
 166                                   guint            prop_id,
 167                                   GValue          *value,
 168                                   GParamSpec      *pspec)
 169 {
 170   GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
 171
 172   switch (prop_id)
 173     {
 174     case PROP_IMAGE:
 175       g_value_set_object (value,
 176                           (GObject*) image_menu_item->image);
 177       break;
 178     default:
 179       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 180       break;
 181     }
 182 }
 183
 184
 185 static void
 186 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 187                                          gint        *requisition)
 188 {
 189   GtkImageMenuItem *image_menu_item;
 190
 191   g_return_if_fail (menu_item != NULL);
 192   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (menu_item));
 193
 194   image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
 195
 196   if (image_menu_item->image)
 197     *requisition = image_menu_item->image->requisition.width;
 198   else
 199     *requisition = 0;
 200 }
 201
 202
 203 static void
 204 gtk_image_menu_item_size_request (GtkWidget      *widget,
 205                                   GtkRequisition *requisition)
 206 {
 207   GtkImageMenuItem *image_menu_item;
 208   gint child_height = 0;
 209
 210   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 211
 212   if (image_menu_item->image && GTK_WIDGET_VISIBLE (image_menu_item->image))
 213     {
 214       GtkRequisition child_requisition;
 215
 216       gtk_widget_size_request (image_menu_item->image,
 217                                &child_requisition);
 218
 219       child_height = child_requisition.height;
 220     }
 221
 222   (* GTK_WIDGET_CLASS (parent_class)->size_request) (widget, requisition);
 223
 224   /* not done with height since that happens via the
 225    * toggle_size_request
 226    */
 227   requisition->height = MAX (requisition->height, child_height);
 228
 229   /* Note that GtkMenuShell always size requests before
 230    * toggle_size_request, so toggle_size_request will be able to use
 231    * image_menu_item->image->requisition
 232    */
 233 }
 234
 235 static void
 236 gtk_image_menu_item_size_allocate (GtkWidget     *widget,
 237                                    GtkAllocation *allocation)
 238 {
 239   GtkImageMenuItem *image_menu_item;
 240
 241   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 242
 243   (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
 244
 245   if (image_menu_item->image)
 246     {
 247       gint width, height, x, y;
 248       GtkAllocation child_allocation;
 249
 250       /* Man this is lame hardcoding action, but I can't
 251        * come up with a solution that's really better.
 252        */
 253
 254       width = image_menu_item->image->requisition.width;
 255       height = image_menu_item->image->requisition.height;
 256
 257       x = (GTK_CONTAINER (image_menu_item)->border_width +
 258            widget->style->xthickness) +
 259         (GTK_MENU_ITEM (image_menu_item)->toggle_size - width) / 2;
 260       y = (widget->allocation.height - height) / 2;
 261
 262       child_allocation.width = width;
 263       child_allocation.height = height;
 264       child_allocation.x = MAX (x, 0);
 265       child_allocation.y = MAX (y, 0);
 266
 267       gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
 268     }
 269 }
 270
 271 static void
 272 gtk_image_menu_item_map (GtkWidget *widget)
 273 {
 274   GtkImageMenuItem *image_menu_item;
 275
 276   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (widget));
 277
 278   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 279
 280   (* GTK_WIDGET_CLASS (parent_class)->map) (widget);
 281
 282   if (image_menu_item->image &&
 283       GTK_WIDGET_VISIBLE (image_menu_item->image) &&
 284       !GTK_WIDGET_MAPPED (image_menu_item->image))
 285     gtk_widget_map (image_menu_item->image);
 286
 287   if (!GTK_WIDGET_NO_WINDOW (widget))
 288     gdk_window_show (widget->window);
 289 }
 290
 291 static void
 292 gtk_image_menu_item_unmap (GtkWidget *widget)
 293 {
 294   GtkImageMenuItem *image_menu_item;
 295
 296   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (widget));
 297
 298   image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
 299
 300   (* GTK_WIDGET_CLASS (parent_class)->unmap) (widget);
 301
 302   if (!GTK_WIDGET_NO_WINDOW (widget))
 303     gdk_window_hide (widget->window);
 304
 305   if (image_menu_item->image && GTK_WIDGET_MAPPED (image_menu_item->image))
 306     gtk_widget_unmap (image_menu_item->image);
 307 }
 308
 309 static void
 310 gtk_image_menu_item_forall (GtkContainer   *container,
 311                             gboolean        include_internals,
 312                             GtkCallback     callback,
 313                             gpointer        callback_data)
 314 {
 315   GtkImageMenuItem *image_menu_item;
 316
 317   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (container));
 318
 319   image_menu_item = GTK_IMAGE_MENU_ITEM (container);
 320
 321   (* GTK_CONTAINER_CLASS (parent_class)->forall) (container,
 322                                                   include_internals,
 323                                                   callback,
 324                                                   callback_data);
 325
 326   if (image_menu_item->image)
 327     (* callback) (image_menu_item->image, callback_data);
 328 }
 329
 330 GtkWidget*
 331 gtk_image_menu_item_new (void)
 332 {
 333   return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
 334 }
 335
 336 GtkWidget*
 337 gtk_image_menu_item_new_with_label (const gchar *label)
 338 {
 339   GtkImageMenuItem *image_menu_item;
 340   GtkWidget *accel_label;
 341
 342   image_menu_item = GTK_IMAGE_MENU_ITEM (g_object_new (GTK_TYPE_IMAGE_MENU_ITEM,
 343                                                        NULL));
 344
 345   accel_label = gtk_accel_label_new (label);
 346   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 347
 348   gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
 349   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
 350                                     GTK_WIDGET (image_menu_item));
 351   gtk_widget_show (accel_label);
 352
 353   return GTK_WIDGET(image_menu_item);
 354 }
 355
 356
 357 /**
 358  * gtk_image_menu_item_new_with_mnemonic:
 359  * @label: The text of the button, with an underscore in front of the
 360  *         mnemonic character
 361  * @returns: a new #GtkImageMenuItem
 362  *
 363  * Creates a new #GtkImageMenuItem containing a label. The label
 364  * will be created using gtk_label_new_with_mnemonic(), so underscores
 365  * in @label indicate the mnemonic for the menu item.
 366  **/
 367 GtkWidget*
 368 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
 369 {
 370   GtkImageMenuItem *image_menu_item;
 371   GtkWidget *accel_label;
 372
 373   image_menu_item = GTK_IMAGE_MENU_ITEM (g_object_new (GTK_TYPE_IMAGE_MENU_ITEM,
 374                                                        NULL));
 375
 376   accel_label = gtk_type_new (GTK_TYPE_ACCEL_LABEL);
 377   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), 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 GtkWidget*
 389 gtk_image_menu_item_new_from_stock (const gchar      *stock_id,
 390                                     GtkAccelGroup    *accel_group)
 391 {
 392   GtkWidget *image;
 393   GtkStockItem stock_item;
 394   GtkWidget *item;
 395
 396   g_return_val_if_fail (stock_id != NULL, NULL);
 397
 398   image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
 399
 400   if (gtk_stock_lookup (stock_id, &stock_item))
 401     {
 402       item = gtk_image_menu_item_new_with_label (stock_item.label);
 403
 404       gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
 405
 406       if (stock_item.keyval && accel_group)
 407         gtk_widget_add_accelerator (item,
 408                                     "activate",
 409                                     accel_group,
 410                                     stock_item.keyval,
 411                                     stock_item.modifier,
 412                                     GTK_ACCEL_VISIBLE);
 413     }
 414   else
 415     {
 416       item = gtk_image_menu_item_new_with_label (stock_id);
 417
 418       gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
 419     }
 420
 421   gtk_widget_show (image);
 422   return item;
 423 }
 424
 425 void
 426 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
 427                                GtkWidget        *image)
 428 {
 429   g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
 430
 431   if (image == image_menu_item->image)
 432     return;
 433
 434   if (image_menu_item->image)
 435     gtk_container_remove (GTK_CONTAINER (image_menu_item),
 436                           image_menu_item->image);
 437
 438   image_menu_item->image = image;
 439
 440   if (image == NULL)
 441     return;
 442
 443   gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
 444
 445   g_object_notify (G_OBJECT (image_menu_item), "image");
 446
 447   if (GTK_WIDGET_REALIZED (image->parent))
 448     gtk_widget_realize (image);
 449
 450   if (GTK_WIDGET_VISIBLE (image->parent) && GTK_WIDGET_VISIBLE (image))
 451     {
 452       if (GTK_WIDGET_MAPPED (image->parent))
 453         gtk_widget_map (image);
 454
 455       gtk_widget_queue_resize (image);
 456     }
 457 }
 458
 459 GtkWidget*
 460 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
 461 {
 462   g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
 463
 464   return image_menu_item->image;
 465 }
 466
 467 static void
 468 gtk_image_menu_item_remove (GtkContainer *container,
 469                             GtkWidget    *child)
 470 {
 471   GtkImageMenuItem *image_menu_item;
 472
 473   image_menu_item = GTK_IMAGE_MENU_ITEM (container);
 474
 475   if (child == image_menu_item->image)
 476     {
 477       gboolean widget_was_visible;
 478
 479       widget_was_visible = GTK_WIDGET_VISIBLE (child);
 480
 481       gtk_widget_unparent (child);
 482       image_menu_item->image = NULL;
 483
 484       if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
 485         gtk_widget_queue_resize (GTK_WIDGET (container));
 486
 487       g_object_notify (G_OBJECT (image_menu_item), "image");
 488     }
 489   else
 490     {
 491       (* GTK_CONTAINER_CLASS (parent_class)->remove) (container, child);
 492     }
 493 }
 494
 495