1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2001 Red Hat, Inc.
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.
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.
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.
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/.
28 #include "gtkimagemenuitem.h"
29 #include "gtkaccellabel.h"
32 #include "gtkiconfactory.h"
34 #include "gtkmenubar.h"
35 #include "gtkcontainer.h"
36 #include "gtkwindow.h"
37 #include "gtkprivate.h"
40 static void gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass);
41 static void gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item);
42 static void gtk_image_menu_item_size_request (GtkWidget *widget,
43 GtkRequisition *requisition);
44 static void gtk_image_menu_item_size_allocate (GtkWidget *widget,
45 GtkAllocation *allocation);
46 static void gtk_image_menu_item_remove (GtkContainer *container,
48 static void gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
51 static void gtk_image_menu_item_forall (GtkContainer *container,
52 gboolean include_internals,
54 gpointer callback_data);
56 static void gtk_image_menu_item_set_property (GObject *object,
60 static void gtk_image_menu_item_get_property (GObject *object,
64 static void gtk_image_menu_item_screen_changed (GtkWidget *widget,
65 GdkScreen *previous_screen);
73 static GtkMenuItemClass *parent_class = NULL;
76 gtk_image_menu_item_get_type (void)
78 static GType image_menu_item_type = 0;
80 if (!image_menu_item_type)
82 static const GTypeInfo image_menu_item_info =
84 sizeof (GtkImageMenuItemClass),
86 NULL, /* base_finalize */
87 (GClassInitFunc) gtk_image_menu_item_class_init,
88 NULL, /* class_finalize */
89 NULL, /* class_data */
90 sizeof (GtkImageMenuItem),
92 (GInstanceInitFunc) gtk_image_menu_item_init,
95 image_menu_item_type =
96 g_type_register_static (GTK_TYPE_MENU_ITEM, g_intern_static_string ("GtkImageMenuItem"),
97 &image_menu_item_info, 0);
100 return image_menu_item_type;
104 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
106 GObjectClass *gobject_class;
107 GtkWidgetClass *widget_class;
108 GtkMenuItemClass *menu_item_class;
109 GtkContainerClass *container_class;
111 gobject_class = (GObjectClass*) klass;
112 widget_class = (GtkWidgetClass*) klass;
113 menu_item_class = (GtkMenuItemClass*) klass;
114 container_class = (GtkContainerClass*) klass;
116 parent_class = g_type_class_peek_parent (klass);
118 widget_class->screen_changed = gtk_image_menu_item_screen_changed;
119 widget_class->size_request = gtk_image_menu_item_size_request;
120 widget_class->size_allocate = gtk_image_menu_item_size_allocate;
122 container_class->forall = gtk_image_menu_item_forall;
123 container_class->remove = gtk_image_menu_item_remove;
125 menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
127 gobject_class->set_property = gtk_image_menu_item_set_property;
128 gobject_class->get_property = gtk_image_menu_item_get_property;
130 g_object_class_install_property (gobject_class,
132 g_param_spec_object ("image",
134 P_("Child widget to appear next to the menu text"),
136 GTK_PARAM_READWRITE));
138 gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
139 P_("Show menu images"),
140 P_("Whether images should be shown in menus"),
142 GTK_PARAM_READWRITE));
147 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
149 image_menu_item->image = NULL;
153 gtk_image_menu_item_set_property (GObject *object,
158 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
166 image = (GtkWidget*) g_value_get_object (value);
168 gtk_image_menu_item_set_image (image_menu_item, image);
172 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
177 gtk_image_menu_item_get_property (GObject *object,
182 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
187 g_value_set_object (value,
188 (GObject*) image_menu_item->image);
191 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
197 show_image (GtkImageMenuItem *image_menu_item)
199 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
202 g_object_get (settings, "gtk-menu-images", &show, NULL);
208 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
211 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
212 GtkPackDirection pack_dir;
214 if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
215 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (GTK_WIDGET (menu_item)->parent));
217 pack_dir = GTK_PACK_DIRECTION_LTR;
221 if (image_menu_item->image && show_image (image_menu_item))
223 GtkRequisition image_requisition;
224 guint toggle_spacing;
225 gtk_widget_get_child_requisition (image_menu_item->image,
228 gtk_widget_style_get (GTK_WIDGET (menu_item),
229 "toggle-spacing", &toggle_spacing,
232 if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
234 if (image_requisition.width > 0)
235 *requisition = image_requisition.width + toggle_spacing;
239 if (image_requisition.height > 0)
240 *requisition = image_requisition.height + toggle_spacing;
247 gtk_image_menu_item_size_request (GtkWidget *widget,
248 GtkRequisition *requisition)
250 GtkImageMenuItem *image_menu_item;
251 gint child_width = 0;
252 gint child_height = 0;
253 GtkPackDirection pack_dir;
255 if (GTK_IS_MENU_BAR (widget->parent))
256 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
258 pack_dir = GTK_PACK_DIRECTION_LTR;
260 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
262 if (image_menu_item->image &&
263 GTK_WIDGET_VISIBLE (image_menu_item->image) &&
264 show_image (image_menu_item))
266 GtkRequisition child_requisition;
268 gtk_widget_size_request (image_menu_item->image,
271 child_width = child_requisition.width;
272 child_height = child_requisition.height;
275 (* GTK_WIDGET_CLASS (parent_class)->size_request) (widget, requisition);
277 /* not done with height since that happens via the
278 * toggle_size_request
280 if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
281 requisition->height = MAX (requisition->height, child_height);
283 requisition->width = MAX (requisition->width, child_width);
286 /* Note that GtkMenuShell always size requests before
287 * toggle_size_request, so toggle_size_request will be able to use
288 * image_menu_item->image->requisition
293 gtk_image_menu_item_size_allocate (GtkWidget *widget,
294 GtkAllocation *allocation)
296 GtkImageMenuItem *image_menu_item;
297 GtkPackDirection pack_dir;
299 if (GTK_IS_MENU_BAR (widget->parent))
300 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
302 pack_dir = GTK_PACK_DIRECTION_LTR;
304 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
306 (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
308 if (image_menu_item->image && show_image (image_menu_item))
311 GtkRequisition child_requisition;
312 GtkAllocation child_allocation;
313 guint horizontal_padding, toggle_spacing;
315 gtk_widget_style_get (widget,
316 "horizontal-padding", &horizontal_padding,
317 "toggle-spacing", &toggle_spacing,
320 /* Man this is lame hardcoding action, but I can't
321 * come up with a solution that's really better.
324 gtk_widget_get_child_requisition (image_menu_item->image,
327 if (pack_dir == GTK_PACK_DIRECTION_LTR ||
328 pack_dir == GTK_PACK_DIRECTION_RTL)
330 offset = GTK_CONTAINER (image_menu_item)->border_width +
331 widget->style->xthickness;
333 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
334 (pack_dir == GTK_PACK_DIRECTION_LTR))
335 x = offset + horizontal_padding +
336 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
337 toggle_spacing - child_requisition.width) / 2;
339 x = widget->allocation.width - offset - horizontal_padding -
340 GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
341 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
342 toggle_spacing - child_requisition.width) / 2;
344 y = (widget->allocation.height - child_requisition.height) / 2;
348 offset = GTK_CONTAINER (image_menu_item)->border_width +
349 widget->style->ythickness;
351 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
352 (pack_dir == GTK_PACK_DIRECTION_TTB))
353 y = offset + horizontal_padding +
354 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
355 toggle_spacing - child_requisition.height) / 2;
357 y = widget->allocation.height - offset - horizontal_padding -
358 GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
359 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
360 toggle_spacing - child_requisition.height) / 2;
362 x = (widget->allocation.width - child_requisition.width) / 2;
365 child_allocation.width = child_requisition.width;
366 child_allocation.height = child_requisition.height;
367 child_allocation.x = widget->allocation.x + MAX (x, 0);
368 child_allocation.y = widget->allocation.y + MAX (y, 0);
370 gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
375 gtk_image_menu_item_forall (GtkContainer *container,
376 gboolean include_internals,
377 GtkCallback callback,
378 gpointer callback_data)
380 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
382 (* GTK_CONTAINER_CLASS (parent_class)->forall) (container,
387 if (image_menu_item->image)
388 (* callback) (image_menu_item->image, callback_data);
392 * gtk_image_menu_item_new:
393 * @returns: a new #GtkImageMenuItem.
395 * Creates a new #GtkImageMenuItem with an empty label.
398 gtk_image_menu_item_new (void)
400 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
404 * gtk_image_menu_item_new_with_label:
405 * @label: the text of the menu item.
406 * @returns: a new #GtkImageMenuItem.
408 * Creates a new #GtkImageMenuItem containing a label.
411 gtk_image_menu_item_new_with_label (const gchar *label)
413 GtkImageMenuItem *image_menu_item;
414 GtkWidget *accel_label;
416 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
418 accel_label = gtk_accel_label_new (label);
419 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
421 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
422 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
423 GTK_WIDGET (image_menu_item));
424 gtk_widget_show (accel_label);
426 return GTK_WIDGET(image_menu_item);
431 * gtk_image_menu_item_new_with_mnemonic:
432 * @label: the text of the menu item, with an underscore in front of the
434 * @returns: a new #GtkImageMenuItem
436 * Creates a new #GtkImageMenuItem containing a label. The label
437 * will be created using gtk_label_new_with_mnemonic(), so underscores
438 * in @label indicate the mnemonic for the menu item.
441 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
443 GtkImageMenuItem *image_menu_item;
444 GtkWidget *accel_label;
446 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
448 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
449 gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
450 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
452 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
453 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
454 GTK_WIDGET (image_menu_item));
455 gtk_widget_show (accel_label);
457 return GTK_WIDGET(image_menu_item);
461 * gtk_image_menu_item_new_from_stock:
462 * @stock_id: the name of the stock item.
463 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
465 * @returns: a new #GtkImageMenuItem.
467 * Creates a new #GtkImageMenuItem containing the image and text from a
468 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
469 * and #GTK_STOCK_APPLY.
471 * If you want this menu item to have changeable accelerators, then pass in
472 * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
473 * appropriate path for the menu item, use gtk_stock_lookup() to look up the
474 * standard accelerator for the stock item, and if one is found, call
475 * gtk_accel_map_add_entry() to register it.
478 gtk_image_menu_item_new_from_stock (const gchar *stock_id,
479 GtkAccelGroup *accel_group)
482 GtkStockItem stock_item;
485 g_return_val_if_fail (stock_id != NULL, NULL);
487 image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
489 if (gtk_stock_lookup (stock_id, &stock_item))
491 item = gtk_image_menu_item_new_with_mnemonic (stock_item.label);
493 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
495 if (stock_item.keyval && accel_group)
496 gtk_widget_add_accelerator (item,
505 item = gtk_image_menu_item_new_with_mnemonic (stock_id);
507 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
510 gtk_widget_show (image);
515 * gtk_image_menu_item_set_image:
516 * @image_menu_item: a #GtkImageMenuItem.
517 * @image: a widget to set as the image for the menu item.
519 * Sets the image of @image_menu_item to the given widget.
520 * Note that it depends on the show-menu-images setting whether
521 * the image will be displayed or not.
524 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
527 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
529 if (image == image_menu_item->image)
532 if (image_menu_item->image)
533 gtk_container_remove (GTK_CONTAINER (image_menu_item),
534 image_menu_item->image);
536 image_menu_item->image = image;
541 gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
543 "visible", show_image (image_menu_item),
547 g_object_notify (G_OBJECT (image_menu_item), "image");
551 * gtk_image_menu_item_get_image:
552 * @image_menu_item: a #GtkImageMenuItem.
553 * @returns: the widget set as image of @image_menu_item.
555 * Gets the widget that is currently set as the image of @image_menu_item.
556 * See gtk_image_menu_item_set_image().
559 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
561 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
563 return image_menu_item->image;
567 gtk_image_menu_item_remove (GtkContainer *container,
570 GtkImageMenuItem *image_menu_item;
572 image_menu_item = GTK_IMAGE_MENU_ITEM (container);
574 if (child == image_menu_item->image)
576 gboolean widget_was_visible;
578 widget_was_visible = GTK_WIDGET_VISIBLE (child);
580 gtk_widget_unparent (child);
581 image_menu_item->image = NULL;
583 if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
584 gtk_widget_queue_resize (GTK_WIDGET (container));
586 g_object_notify (G_OBJECT (image_menu_item), "image");
590 (* GTK_CONTAINER_CLASS (parent_class)->remove) (container, child);
595 show_image_change_notify (GtkImageMenuItem *image_menu_item)
597 if (image_menu_item->image)
599 if (show_image (image_menu_item))
600 gtk_widget_show (image_menu_item->image);
602 gtk_widget_hide (image_menu_item->image);
607 traverse_container (GtkWidget *widget,
610 if (GTK_IS_IMAGE_MENU_ITEM (widget))
611 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
612 else if (GTK_IS_CONTAINER (widget))
613 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
617 gtk_image_menu_item_setting_changed (GtkSettings *settings)
621 list = gtk_window_list_toplevels ();
623 for (l = list; l; l = l->next)
624 gtk_container_forall (GTK_CONTAINER (l->data),
625 traverse_container, NULL);
631 gtk_image_menu_item_screen_changed (GtkWidget *widget,
632 GdkScreen *previous_screen)
634 GtkSettings *settings;
635 guint show_image_connection;
637 if (!gtk_widget_has_screen (widget))
640 settings = gtk_widget_get_settings (widget);
642 show_image_connection =
643 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
644 "gtk-image-menu-item-connection"));
646 if (show_image_connection)
649 show_image_connection =
650 g_signal_connect (settings, "notify::gtk-menu-images",
651 G_CALLBACK (gtk_image_menu_item_setting_changed), 0);
652 g_object_set_data (G_OBJECT (settings),
653 g_intern_static_string ("gtk-image-menu-item-connection"),
654 GUINT_TO_POINTER (show_image_connection));
656 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
659 #define __GTK_IMAGE_MENU_ITEM_C__
660 #include "gtkaliasdef.c"