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/.
29 #include "gtkimagemenuitem.h"
31 #include "gtkmenuitemprivate.h"
32 #include "gtkaccellabel.h"
34 #include "gtkiconfactory.h"
36 #include "gtkmenubar.h"
37 #include "gtkcontainer.h"
38 #include "gtkwindow.h"
39 #include "gtkactivatable.h"
42 #include "gtkprivate.h"
46 struct _GtkImageMenuItemPrivate
52 guint always_show_image : 1;
60 PROP_ALWAYS_SHOW_IMAGE
63 static GtkActivatableIface *parent_activatable_iface;
65 static void gtk_image_menu_item_destroy (GtkWidget *widget);
66 static void gtk_image_menu_item_get_preferred_width (GtkWidget *widget,
69 static void gtk_image_menu_item_get_preferred_height (GtkWidget *widget,
72 static void gtk_image_menu_item_get_preferred_height_for_width (GtkWidget *widget,
76 static void gtk_image_menu_item_size_allocate (GtkWidget *widget,
77 GtkAllocation *allocation);
78 static void gtk_image_menu_item_map (GtkWidget *widget);
79 static void gtk_image_menu_item_remove (GtkContainer *container,
81 static void gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
83 static void gtk_image_menu_item_set_label (GtkMenuItem *menu_item,
85 static G_CONST_RETURN gchar *gtk_image_menu_item_get_label (GtkMenuItem *menu_item);
87 static void gtk_image_menu_item_forall (GtkContainer *container,
88 gboolean include_internals,
90 gpointer callback_data);
92 static void gtk_image_menu_item_finalize (GObject *object);
93 static void gtk_image_menu_item_set_property (GObject *object,
97 static void gtk_image_menu_item_get_property (GObject *object,
101 static void gtk_image_menu_item_screen_changed (GtkWidget *widget,
102 GdkScreen *previous_screen);
104 static void gtk_image_menu_item_recalculate (GtkImageMenuItem *image_menu_item);
106 static void gtk_image_menu_item_activatable_interface_init (GtkActivatableIface *iface);
107 static void gtk_image_menu_item_update (GtkActivatable *activatable,
109 const gchar *property_name);
110 static void gtk_image_menu_item_sync_action_properties (GtkActivatable *activatable,
114 G_DEFINE_TYPE_WITH_CODE (GtkImageMenuItem, gtk_image_menu_item, GTK_TYPE_MENU_ITEM,
115 G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
116 gtk_image_menu_item_activatable_interface_init))
120 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
122 GObjectClass *gobject_class = (GObjectClass*) klass;
123 GtkWidgetClass *widget_class = (GtkWidgetClass*) klass;
124 GtkMenuItemClass *menu_item_class = (GtkMenuItemClass*) klass;
125 GtkContainerClass *container_class = (GtkContainerClass*) klass;
127 widget_class->destroy = gtk_image_menu_item_destroy;
128 widget_class->screen_changed = gtk_image_menu_item_screen_changed;
129 widget_class->get_preferred_width = gtk_image_menu_item_get_preferred_width;
130 widget_class->get_preferred_height = gtk_image_menu_item_get_preferred_height;
131 widget_class->get_preferred_height_for_width = gtk_image_menu_item_get_preferred_height_for_width;
132 widget_class->size_allocate = gtk_image_menu_item_size_allocate;
133 widget_class->map = gtk_image_menu_item_map;
135 container_class->forall = gtk_image_menu_item_forall;
136 container_class->remove = gtk_image_menu_item_remove;
138 menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
139 menu_item_class->set_label = gtk_image_menu_item_set_label;
140 menu_item_class->get_label = gtk_image_menu_item_get_label;
142 gobject_class->finalize = gtk_image_menu_item_finalize;
143 gobject_class->set_property = gtk_image_menu_item_set_property;
144 gobject_class->get_property = gtk_image_menu_item_get_property;
146 g_object_class_install_property (gobject_class,
148 g_param_spec_object ("image",
150 P_("Child widget to appear next to the menu text"),
152 GTK_PARAM_READWRITE));
154 * GtkImageMenuItem:use-stock:
156 * If %TRUE, the label set in the menuitem is used as a
157 * stock id to select the stock item for the item.
161 g_object_class_install_property (gobject_class,
163 g_param_spec_boolean ("use-stock",
165 P_("Whether to use the label text to create a stock menu item"),
167 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
170 * GtkImageMenuItem:always-show-image:
172 * If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images
173 * setting and always show the image, if available.
175 * Use this property if the menuitem would be useless or hard to use
180 g_object_class_install_property (gobject_class,
181 PROP_ALWAYS_SHOW_IMAGE,
182 g_param_spec_boolean ("always-show-image",
183 P_("Always show image"),
184 P_("Whether the image will always be shown"),
186 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
189 * GtkImageMenuItem:accel-group:
191 * The Accel Group to use for stock accelerator keys
195 g_object_class_install_property (gobject_class,
197 g_param_spec_object ("accel-group",
199 P_("The Accel Group to use for stock accelerator keys"),
200 GTK_TYPE_ACCEL_GROUP,
201 GTK_PARAM_WRITABLE));
203 g_type_class_add_private (klass, sizeof (GtkImageMenuItemPrivate));
207 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
209 GtkImageMenuItemPrivate *priv;
211 image_menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (image_menu_item,
212 GTK_TYPE_IMAGE_MENU_ITEM,
213 GtkImageMenuItemPrivate);
214 priv = image_menu_item->priv;
217 priv->use_stock = FALSE;
222 gtk_image_menu_item_finalize (GObject *object)
224 GtkImageMenuItemPrivate *priv = GTK_IMAGE_MENU_ITEM (object)->priv;
226 g_free (priv->label);
229 G_OBJECT_CLASS (gtk_image_menu_item_parent_class)->finalize (object);
233 gtk_image_menu_item_set_property (GObject *object,
238 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
243 gtk_image_menu_item_set_image (image_menu_item, (GtkWidget *) g_value_get_object (value));
246 gtk_image_menu_item_set_use_stock (image_menu_item, g_value_get_boolean (value));
248 case PROP_ALWAYS_SHOW_IMAGE:
249 gtk_image_menu_item_set_always_show_image (image_menu_item, g_value_get_boolean (value));
251 case PROP_ACCEL_GROUP:
252 gtk_image_menu_item_set_accel_group (image_menu_item, g_value_get_object (value));
255 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
261 gtk_image_menu_item_get_property (GObject *object,
266 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
271 g_value_set_object (value, gtk_image_menu_item_get_image (image_menu_item));
274 g_value_set_boolean (value, gtk_image_menu_item_get_use_stock (image_menu_item));
276 case PROP_ALWAYS_SHOW_IMAGE:
277 g_value_set_boolean (value, gtk_image_menu_item_get_always_show_image (image_menu_item));
280 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
286 show_image (GtkImageMenuItem *image_menu_item)
288 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
289 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
292 if (priv->always_show_image)
295 g_object_get (settings, "gtk-menu-images", &show, NULL);
301 gtk_image_menu_item_map (GtkWidget *widget)
303 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
304 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
306 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->map (widget);
309 g_object_set (priv->image,
310 "visible", show_image (image_menu_item),
315 gtk_image_menu_item_destroy (GtkWidget *widget)
317 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
318 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
321 gtk_container_remove (GTK_CONTAINER (image_menu_item),
324 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->destroy (widget);
328 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
331 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
332 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
333 GtkPackDirection pack_dir;
335 GtkWidget *widget = GTK_WIDGET (menu_item);
337 parent = gtk_widget_get_parent (widget);
339 if (GTK_IS_MENU_BAR (parent))
340 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (parent));
342 pack_dir = GTK_PACK_DIRECTION_LTR;
346 if (priv->image && gtk_widget_get_visible (priv->image))
348 GtkRequisition image_requisition;
349 guint toggle_spacing;
351 gtk_widget_get_preferred_size (priv->image, &image_requisition, NULL);
353 gtk_widget_style_get (GTK_WIDGET (menu_item),
354 "toggle-spacing", &toggle_spacing,
357 if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
359 if (image_requisition.width > 0)
360 *requisition = image_requisition.width + toggle_spacing;
364 if (image_requisition.height > 0)
365 *requisition = image_requisition.height + toggle_spacing;
371 gtk_image_menu_item_recalculate (GtkImageMenuItem *image_menu_item)
373 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
374 GtkStockItem stock_item;
376 const gchar *resolved_label = priv->label;
378 if (priv->use_stock && priv->label)
383 image = gtk_image_new_from_stock (priv->label, GTK_ICON_SIZE_MENU);
384 gtk_image_menu_item_set_image (image_menu_item, image);
387 if (gtk_stock_lookup (priv->label, &stock_item))
388 resolved_label = stock_item.label;
390 gtk_menu_item_set_use_underline (GTK_MENU_ITEM (image_menu_item), TRUE);
394 (gtk_image_menu_item_parent_class)->set_label (GTK_MENU_ITEM (image_menu_item), resolved_label);
399 gtk_image_menu_item_set_label (GtkMenuItem *menu_item,
402 GtkImageMenuItemPrivate *priv = GTK_IMAGE_MENU_ITEM (menu_item)->priv;
404 if (priv->label != label)
406 g_free (priv->label);
407 priv->label = g_strdup (label);
409 gtk_image_menu_item_recalculate (GTK_IMAGE_MENU_ITEM (menu_item));
411 g_object_notify (G_OBJECT (menu_item), "label");
416 static G_CONST_RETURN gchar *
417 gtk_image_menu_item_get_label (GtkMenuItem *menu_item)
419 GtkImageMenuItemPrivate *priv = GTK_IMAGE_MENU_ITEM (menu_item)->priv;
425 gtk_image_menu_item_get_preferred_width (GtkWidget *widget,
429 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
430 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
431 gint child_width = 0;
432 GtkPackDirection pack_dir;
435 parent = gtk_widget_get_parent (widget);
437 if (GTK_IS_MENU_BAR (parent))
438 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (parent));
440 pack_dir = GTK_PACK_DIRECTION_LTR;
442 if (priv->image && gtk_widget_get_visible (priv->image))
444 GtkRequisition child_requisition;
446 gtk_widget_get_preferred_size (priv->image, &child_requisition, NULL);
448 child_width = child_requisition.width;
451 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->get_preferred_width (widget, minimum, natural);
453 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
455 *minimum = MAX (*minimum, child_width);
456 *natural = MAX (*natural, child_width);
461 gtk_image_menu_item_get_preferred_height (GtkWidget *widget,
465 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
466 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
467 gint child_height = 0;
468 GtkPackDirection pack_dir;
471 parent = gtk_widget_get_parent (widget);
473 if (GTK_IS_MENU_BAR (parent))
474 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (parent));
476 pack_dir = GTK_PACK_DIRECTION_LTR;
478 if (priv->image && gtk_widget_get_visible (priv->image))
480 GtkRequisition child_requisition;
482 gtk_widget_get_preferred_size (priv->image, &child_requisition, NULL);
484 child_height = child_requisition.height;
487 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->get_preferred_height (widget, minimum, natural);
489 if (pack_dir == GTK_PACK_DIRECTION_RTL || pack_dir == GTK_PACK_DIRECTION_LTR)
491 *minimum = MAX (*minimum, child_height);
492 *natural = MAX (*natural, child_height);
497 gtk_image_menu_item_get_preferred_height_for_width (GtkWidget *widget,
502 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
503 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
504 gint child_height = 0;
505 GtkPackDirection pack_dir;
508 parent = gtk_widget_get_parent (widget);
510 if (GTK_IS_MENU_BAR (parent))
511 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (parent));
513 pack_dir = GTK_PACK_DIRECTION_LTR;
515 if (priv->image && gtk_widget_get_visible (priv->image))
517 GtkRequisition child_requisition;
519 gtk_widget_get_preferred_size (priv->image, &child_requisition, NULL);
521 child_height = child_requisition.height;
525 (gtk_image_menu_item_parent_class)->get_preferred_height_for_width (widget, width, minimum, natural);
527 if (pack_dir == GTK_PACK_DIRECTION_RTL || pack_dir == GTK_PACK_DIRECTION_LTR)
529 *minimum = MAX (*minimum, child_height);
530 *natural = MAX (*natural, child_height);
536 gtk_image_menu_item_size_allocate (GtkWidget *widget,
537 GtkAllocation *allocation)
539 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
540 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
541 GtkAllocation widget_allocation;
542 GtkPackDirection pack_dir;
545 parent = gtk_widget_get_parent (widget);
547 if (GTK_IS_MENU_BAR (parent))
548 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (parent));
550 pack_dir = GTK_PACK_DIRECTION_LTR;
552 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_allocate (widget, allocation);
554 if (priv->image && gtk_widget_get_visible (priv->image))
557 GtkRequisition child_requisition;
558 GtkAllocation child_allocation;
559 guint horizontal_padding, toggle_spacing;
562 toggle_size = GTK_MENU_ITEM (image_menu_item)->priv->toggle_size;
563 gtk_widget_style_get (widget,
564 "horizontal-padding", &horizontal_padding,
565 "toggle-spacing", &toggle_spacing,
568 /* Man this is lame hardcoding action, but I can't
569 * come up with a solution that's really better.
572 gtk_widget_get_preferred_size (priv->image, &child_requisition, NULL);
574 gtk_widget_get_allocation (widget, &widget_allocation);
576 if (pack_dir == GTK_PACK_DIRECTION_LTR ||
577 pack_dir == GTK_PACK_DIRECTION_RTL)
579 offset = gtk_container_get_border_width (GTK_CONTAINER (image_menu_item)) +
580 gtk_widget_get_style (widget)->xthickness;
582 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
583 (pack_dir == GTK_PACK_DIRECTION_LTR))
584 x = offset + horizontal_padding +
585 (toggle_size - toggle_spacing - child_requisition.width) / 2;
587 x = widget_allocation.width - offset - horizontal_padding -
588 toggle_size + toggle_spacing +
589 (toggle_size - toggle_spacing - child_requisition.width) / 2;
591 y = (widget_allocation.height - child_requisition.height) / 2;
595 offset = gtk_container_get_border_width (GTK_CONTAINER (image_menu_item)) +
596 gtk_widget_get_style (widget)->ythickness;
598 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
599 (pack_dir == GTK_PACK_DIRECTION_TTB))
600 y = offset + horizontal_padding +
601 (toggle_size - toggle_spacing - child_requisition.height) / 2;
603 y = widget_allocation.height - offset - horizontal_padding -
604 toggle_size + toggle_spacing +
605 (toggle_size - toggle_spacing - child_requisition.height) / 2;
607 x = (widget_allocation.width - child_requisition.width) / 2;
610 child_allocation.width = child_requisition.width;
611 child_allocation.height = child_requisition.height;
612 child_allocation.x = widget_allocation.x + MAX (x, 0);
613 child_allocation.y = widget_allocation.y + MAX (y, 0);
615 gtk_widget_size_allocate (priv->image, &child_allocation);
620 gtk_image_menu_item_forall (GtkContainer *container,
621 gboolean include_internals,
622 GtkCallback callback,
623 gpointer callback_data)
625 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
626 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
628 GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->forall (container,
633 if (include_internals && priv->image)
634 (* callback) (priv->image, callback_data);
639 gtk_image_menu_item_activatable_interface_init (GtkActivatableIface *iface)
641 parent_activatable_iface = g_type_interface_peek_parent (iface);
642 iface->update = gtk_image_menu_item_update;
643 iface->sync_action_properties = gtk_image_menu_item_sync_action_properties;
647 activatable_update_stock_id (GtkImageMenuItem *image_menu_item, GtkAction *action)
650 const gchar *stock_id = gtk_action_get_stock_id (action);
652 image = gtk_image_menu_item_get_image (image_menu_item);
654 if (GTK_IS_IMAGE (image) &&
655 stock_id && gtk_icon_factory_lookup_default (stock_id))
657 gtk_image_set_from_stock (GTK_IMAGE (image), stock_id, GTK_ICON_SIZE_MENU);
665 activatable_update_gicon (GtkImageMenuItem *image_menu_item, GtkAction *action)
668 GIcon *icon = gtk_action_get_gicon (action);
669 const gchar *stock_id = gtk_action_get_stock_id (action);
671 image = gtk_image_menu_item_get_image (image_menu_item);
673 if (icon && GTK_IS_IMAGE (image) &&
674 !(stock_id && gtk_icon_factory_lookup_default (stock_id)))
676 gtk_image_set_from_gicon (GTK_IMAGE (image), icon, GTK_ICON_SIZE_MENU);
684 activatable_update_icon_name (GtkImageMenuItem *image_menu_item, GtkAction *action)
687 const gchar *icon_name = gtk_action_get_icon_name (action);
689 image = gtk_image_menu_item_get_image (image_menu_item);
691 if (GTK_IS_IMAGE (image) &&
692 (gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_EMPTY ||
693 gtk_image_get_storage_type (GTK_IMAGE (image)) == GTK_IMAGE_ICON_NAME))
695 gtk_image_set_from_icon_name (GTK_IMAGE (image), icon_name, GTK_ICON_SIZE_MENU);
700 gtk_image_menu_item_update (GtkActivatable *activatable,
702 const gchar *property_name)
704 GtkImageMenuItem *image_menu_item;
705 gboolean use_appearance;
707 image_menu_item = GTK_IMAGE_MENU_ITEM (activatable);
709 parent_activatable_iface->update (activatable, action, property_name);
711 use_appearance = gtk_activatable_get_use_action_appearance (activatable);
715 if (strcmp (property_name, "stock-id") == 0)
716 activatable_update_stock_id (image_menu_item, action);
717 else if (strcmp (property_name, "gicon") == 0)
718 activatable_update_gicon (image_menu_item, action);
719 else if (strcmp (property_name, "icon-name") == 0)
720 activatable_update_icon_name (image_menu_item, action);
724 gtk_image_menu_item_sync_action_properties (GtkActivatable *activatable,
727 GtkImageMenuItem *image_menu_item;
729 gboolean use_appearance;
731 image_menu_item = GTK_IMAGE_MENU_ITEM (activatable);
733 parent_activatable_iface->sync_action_properties (activatable, action);
738 use_appearance = gtk_activatable_get_use_action_appearance (activatable);
742 image = gtk_image_menu_item_get_image (image_menu_item);
743 if (image && !GTK_IS_IMAGE (image))
745 gtk_image_menu_item_set_image (image_menu_item, NULL);
751 image = gtk_image_new ();
752 gtk_widget_show (image);
753 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (activatable),
757 if (!activatable_update_stock_id (image_menu_item, action) &&
758 !activatable_update_gicon (image_menu_item, action))
759 activatable_update_icon_name (image_menu_item, action);
761 gtk_image_menu_item_set_always_show_image (image_menu_item,
762 gtk_action_get_always_show_image (action));
767 * gtk_image_menu_item_new:
768 * @returns: a new #GtkImageMenuItem.
770 * Creates a new #GtkImageMenuItem with an empty label.
773 gtk_image_menu_item_new (void)
775 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
779 * gtk_image_menu_item_new_with_label:
780 * @label: the text of the menu item.
781 * @returns: a new #GtkImageMenuItem.
783 * Creates a new #GtkImageMenuItem containing a label.
786 gtk_image_menu_item_new_with_label (const gchar *label)
788 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM,
795 * gtk_image_menu_item_new_with_mnemonic:
796 * @label: the text of the menu item, with an underscore in front of the
798 * @returns: a new #GtkImageMenuItem
800 * Creates a new #GtkImageMenuItem containing a label. The label
801 * will be created using gtk_label_new_with_mnemonic(), so underscores
802 * in @label indicate the mnemonic for the menu item.
805 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
807 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM,
808 "use-underline", TRUE,
814 * gtk_image_menu_item_new_from_stock:
815 * @stock_id: the name of the stock item.
816 * @accel_group: (allow-none): the #GtkAccelGroup to add the menu items
817 * accelerator to, or %NULL.
818 * @returns: a new #GtkImageMenuItem.
820 * Creates a new #GtkImageMenuItem containing the image and text from a
821 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
822 * and #GTK_STOCK_APPLY.
824 * If you want this menu item to have changeable accelerators, then pass in
825 * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
826 * appropriate path for the menu item, use gtk_stock_lookup() to look up the
827 * standard accelerator for the stock item, and if one is found, call
828 * gtk_accel_map_add_entry() to register it.
831 gtk_image_menu_item_new_from_stock (const gchar *stock_id,
832 GtkAccelGroup *accel_group)
834 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM,
837 "accel-group", accel_group,
842 * gtk_image_menu_item_set_use_stock:
843 * @image_menu_item: a #GtkImageMenuItem
844 * @use_stock: %TRUE if the menuitem should use a stock item
846 * If %TRUE, the label set in the menuitem is used as a
847 * stock id to select the stock item for the item.
852 gtk_image_menu_item_set_use_stock (GtkImageMenuItem *image_menu_item,
855 GtkImageMenuItemPrivate *priv;
857 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
859 priv = image_menu_item->priv;
861 if (priv->use_stock != use_stock)
863 priv->use_stock = use_stock;
865 gtk_image_menu_item_recalculate (image_menu_item);
867 g_object_notify (G_OBJECT (image_menu_item), "use-stock");
872 * gtk_image_menu_item_get_use_stock:
873 * @image_menu_item: a #GtkImageMenuItem
875 * Checks whether the label set in the menuitem is used as a
876 * stock id to select the stock item for the item.
878 * Returns: %TRUE if the label set in the menuitem is used as a
879 * stock id to select the stock item for the item
884 gtk_image_menu_item_get_use_stock (GtkImageMenuItem *image_menu_item)
886 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), FALSE);
888 return image_menu_item->priv->use_stock;
892 * gtk_image_menu_item_set_always_show_image:
893 * @image_menu_item: a #GtkImageMenuItem
894 * @always_show: %TRUE if the menuitem should always show the image
896 * If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images
897 * setting and always show the image, if available.
899 * Use this property if the menuitem would be useless or hard to use
905 gtk_image_menu_item_set_always_show_image (GtkImageMenuItem *image_menu_item,
906 gboolean always_show)
908 GtkImageMenuItemPrivate *priv;
910 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
912 priv = image_menu_item->priv;
914 if (priv->always_show_image != always_show)
916 priv->always_show_image = always_show;
920 if (show_image (image_menu_item))
921 gtk_widget_show (priv->image);
923 gtk_widget_hide (priv->image);
926 g_object_notify (G_OBJECT (image_menu_item), "always-show-image");
931 * gtk_image_menu_item_get_always_show_image:
932 * @image_menu_item: a #GtkImageMenuItem
934 * Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images
935 * setting and always show the image, if available.
937 * Returns: %TRUE if the menu item will always show the image
942 gtk_image_menu_item_get_always_show_image (GtkImageMenuItem *image_menu_item)
944 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), FALSE);
946 return image_menu_item->priv->always_show_image;
951 * gtk_image_menu_item_set_accel_group:
952 * @image_menu_item: a #GtkImageMenuItem
953 * @accel_group: the #GtkAccelGroup
955 * Specifies an @accel_group to add the menu items accelerator to
956 * (this only applies to stock items so a stock item must already
957 * be set, make sure to call gtk_image_menu_item_set_use_stock()
958 * and gtk_menu_item_set_label() with a valid stock item first).
960 * If you want this menu item to have changeable accelerators then
961 * you shouldnt need this (see gtk_image_menu_item_new_from_stock()).
966 gtk_image_menu_item_set_accel_group (GtkImageMenuItem *image_menu_item,
967 GtkAccelGroup *accel_group)
969 GtkImageMenuItemPrivate *priv;
970 GtkStockItem stock_item;
972 /* Silent return for the constructor */
976 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
977 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
979 priv = image_menu_item->priv;
981 if (priv->use_stock && priv->label && gtk_stock_lookup (priv->label, &stock_item))
982 if (stock_item.keyval)
984 gtk_widget_add_accelerator (GTK_WIDGET (image_menu_item),
991 g_object_notify (G_OBJECT (image_menu_item), "accel-group");
996 * gtk_image_menu_item_set_image:
997 * @image_menu_item: a #GtkImageMenuItem.
998 * @image: (allow-none): a widget to set as the image for the menu item.
1000 * Sets the image of @image_menu_item to the given widget.
1001 * Note that it depends on the show-menu-images setting whether
1002 * the image will be displayed or not.
1005 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
1008 GtkImageMenuItemPrivate *priv;
1010 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
1012 priv = image_menu_item->priv;
1014 if (image == priv->image)
1018 gtk_container_remove (GTK_CONTAINER (image_menu_item),
1021 priv->image = image;
1026 gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
1027 g_object_set (image,
1028 "visible", show_image (image_menu_item),
1029 "no-show-all", TRUE,
1032 g_object_notify (G_OBJECT (image_menu_item), "image");
1036 * gtk_image_menu_item_get_image:
1037 * @image_menu_item: a #GtkImageMenuItem
1039 * Gets the widget that is currently set as the image of @image_menu_item.
1040 * See gtk_image_menu_item_set_image().
1042 * Return value: (transfer none): the widget set as image of @image_menu_item
1045 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
1047 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
1049 return image_menu_item->priv->image;
1053 gtk_image_menu_item_remove (GtkContainer *container,
1056 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
1057 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
1059 if (child == priv->image)
1061 gboolean widget_was_visible;
1063 widget_was_visible = gtk_widget_get_visible (child);
1065 gtk_widget_unparent (child);
1068 if (widget_was_visible &&
1069 gtk_widget_get_visible (GTK_WIDGET (container)))
1070 gtk_widget_queue_resize (GTK_WIDGET (container));
1072 g_object_notify (G_OBJECT (image_menu_item), "image");
1076 GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->remove (container, child);
1081 show_image_change_notify (GtkImageMenuItem *image_menu_item)
1083 GtkImageMenuItemPrivate *priv = image_menu_item->priv;
1087 if (show_image (image_menu_item))
1088 gtk_widget_show (priv->image);
1090 gtk_widget_hide (priv->image);
1095 traverse_container (GtkWidget *widget,
1098 if (GTK_IS_IMAGE_MENU_ITEM (widget))
1099 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
1100 else if (GTK_IS_CONTAINER (widget))
1101 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
1105 gtk_image_menu_item_setting_changed (GtkSettings *settings)
1109 list = gtk_window_list_toplevels ();
1111 for (l = list; l; l = l->next)
1112 gtk_container_forall (GTK_CONTAINER (l->data),
1113 traverse_container, NULL);
1119 gtk_image_menu_item_screen_changed (GtkWidget *widget,
1120 GdkScreen *previous_screen)
1122 GtkSettings *settings;
1123 gulong show_image_connection;
1125 if (!gtk_widget_has_screen (widget))
1128 settings = gtk_widget_get_settings (widget);
1130 show_image_connection =
1131 g_signal_handler_find (settings, G_SIGNAL_MATCH_FUNC, 0, 0,
1132 NULL, gtk_image_menu_item_setting_changed, NULL);
1134 if (show_image_connection)
1137 g_signal_connect (settings, "notify::gtk-menu-images",
1138 G_CALLBACK (gtk_image_menu_item_setting_changed), NULL);
1140 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));