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_destroy (GtkObject *object);
41 static void gtk_image_menu_item_size_request (GtkWidget *widget,
42 GtkRequisition *requisition);
43 static void gtk_image_menu_item_size_allocate (GtkWidget *widget,
44 GtkAllocation *allocation);
45 static void gtk_image_menu_item_remove (GtkContainer *container,
47 static void gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
50 static void gtk_image_menu_item_forall (GtkContainer *container,
51 gboolean include_internals,
53 gpointer callback_data);
55 static void gtk_image_menu_item_set_property (GObject *object,
59 static void gtk_image_menu_item_get_property (GObject *object,
63 static void gtk_image_menu_item_screen_changed (GtkWidget *widget,
64 GdkScreen *previous_screen);
72 G_DEFINE_TYPE (GtkImageMenuItem, gtk_image_menu_item, GTK_TYPE_MENU_ITEM)
75 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
77 GObjectClass *gobject_class = (GObjectClass*) klass;
78 GtkObjectClass *object_class = (GtkObjectClass*) klass;
79 GtkWidgetClass *widget_class = (GtkWidgetClass*) klass;
80 GtkMenuItemClass *menu_item_class = (GtkMenuItemClass*) klass;
81 GtkContainerClass *container_class = (GtkContainerClass*) klass;
83 object_class->destroy = gtk_image_menu_item_destroy;
85 widget_class->screen_changed = gtk_image_menu_item_screen_changed;
86 widget_class->size_request = gtk_image_menu_item_size_request;
87 widget_class->size_allocate = gtk_image_menu_item_size_allocate;
89 container_class->forall = gtk_image_menu_item_forall;
90 container_class->remove = gtk_image_menu_item_remove;
92 menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
94 gobject_class->set_property = gtk_image_menu_item_set_property;
95 gobject_class->get_property = gtk_image_menu_item_get_property;
97 g_object_class_install_property (gobject_class,
99 g_param_spec_object ("image",
101 P_("Child widget to appear next to the menu text"),
103 GTK_PARAM_READWRITE));
105 gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
106 P_("Show menu images"),
107 P_("Whether images should be shown in menus"),
109 GTK_PARAM_READWRITE));
114 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
116 image_menu_item->image = NULL;
120 gtk_image_menu_item_set_property (GObject *object,
125 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
133 image = (GtkWidget*) g_value_get_object (value);
135 gtk_image_menu_item_set_image (image_menu_item, image);
139 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
144 gtk_image_menu_item_get_property (GObject *object,
149 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
154 g_value_set_object (value,
155 (GObject*) image_menu_item->image);
158 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
164 show_image (GtkImageMenuItem *image_menu_item)
166 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
169 g_object_get (settings, "gtk-menu-images", &show, NULL);
175 gtk_image_menu_item_destroy (GtkObject *object)
177 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
179 if (image_menu_item->image)
180 gtk_container_remove (GTK_CONTAINER (image_menu_item),
181 image_menu_item->image);
183 GTK_OBJECT_CLASS (gtk_image_menu_item_parent_class)->destroy (object);
187 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
190 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
191 GtkPackDirection pack_dir;
193 if (GTK_IS_MENU_BAR (GTK_WIDGET (menu_item)->parent))
194 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (GTK_WIDGET (menu_item)->parent));
196 pack_dir = GTK_PACK_DIRECTION_LTR;
200 if (image_menu_item->image && show_image (image_menu_item))
202 GtkRequisition image_requisition;
203 guint toggle_spacing;
204 gtk_widget_get_child_requisition (image_menu_item->image,
207 gtk_widget_style_get (GTK_WIDGET (menu_item),
208 "toggle-spacing", &toggle_spacing,
211 if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
213 if (image_requisition.width > 0)
214 *requisition = image_requisition.width + toggle_spacing;
218 if (image_requisition.height > 0)
219 *requisition = image_requisition.height + toggle_spacing;
226 gtk_image_menu_item_size_request (GtkWidget *widget,
227 GtkRequisition *requisition)
229 GtkImageMenuItem *image_menu_item;
230 gint child_width = 0;
231 gint child_height = 0;
232 GtkPackDirection pack_dir;
234 if (GTK_IS_MENU_BAR (widget->parent))
235 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
237 pack_dir = GTK_PACK_DIRECTION_LTR;
239 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
241 if (image_menu_item->image &&
242 GTK_WIDGET_VISIBLE (image_menu_item->image) &&
243 show_image (image_menu_item))
245 GtkRequisition child_requisition;
247 gtk_widget_size_request (image_menu_item->image,
250 child_width = child_requisition.width;
251 child_height = child_requisition.height;
254 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_request (widget, requisition);
256 /* not done with height since that happens via the
257 * toggle_size_request
259 if (pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL)
260 requisition->height = MAX (requisition->height, child_height);
262 requisition->width = MAX (requisition->width, child_width);
265 /* Note that GtkMenuShell always size requests before
266 * toggle_size_request, so toggle_size_request will be able to use
267 * image_menu_item->image->requisition
272 gtk_image_menu_item_size_allocate (GtkWidget *widget,
273 GtkAllocation *allocation)
275 GtkImageMenuItem *image_menu_item;
276 GtkPackDirection pack_dir;
278 if (GTK_IS_MENU_BAR (widget->parent))
279 pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
281 pack_dir = GTK_PACK_DIRECTION_LTR;
283 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
285 GTK_WIDGET_CLASS (gtk_image_menu_item_parent_class)->size_allocate (widget, allocation);
287 if (image_menu_item->image && show_image (image_menu_item))
290 GtkRequisition child_requisition;
291 GtkAllocation child_allocation;
292 guint horizontal_padding, toggle_spacing;
294 gtk_widget_style_get (widget,
295 "horizontal-padding", &horizontal_padding,
296 "toggle-spacing", &toggle_spacing,
299 /* Man this is lame hardcoding action, but I can't
300 * come up with a solution that's really better.
303 gtk_widget_get_child_requisition (image_menu_item->image,
306 if (pack_dir == GTK_PACK_DIRECTION_LTR ||
307 pack_dir == GTK_PACK_DIRECTION_RTL)
309 offset = GTK_CONTAINER (image_menu_item)->border_width +
310 widget->style->xthickness;
312 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
313 (pack_dir == GTK_PACK_DIRECTION_LTR))
314 x = offset + horizontal_padding +
315 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
316 toggle_spacing - child_requisition.width) / 2;
318 x = widget->allocation.width - offset - horizontal_padding -
319 GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
320 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
321 toggle_spacing - child_requisition.width) / 2;
323 y = (widget->allocation.height - child_requisition.height) / 2;
327 offset = GTK_CONTAINER (image_menu_item)->border_width +
328 widget->style->ythickness;
330 if ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR) ==
331 (pack_dir == GTK_PACK_DIRECTION_TTB))
332 y = offset + horizontal_padding +
333 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
334 toggle_spacing - child_requisition.height) / 2;
336 y = widget->allocation.height - offset - horizontal_padding -
337 GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
338 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
339 toggle_spacing - child_requisition.height) / 2;
341 x = (widget->allocation.width - child_requisition.width) / 2;
344 child_allocation.width = child_requisition.width;
345 child_allocation.height = child_requisition.height;
346 child_allocation.x = widget->allocation.x + MAX (x, 0);
347 child_allocation.y = widget->allocation.y + MAX (y, 0);
349 gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
354 gtk_image_menu_item_forall (GtkContainer *container,
355 gboolean include_internals,
356 GtkCallback callback,
357 gpointer callback_data)
359 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
361 GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->forall (container,
366 if (include_internals && image_menu_item->image)
367 (* callback) (image_menu_item->image, callback_data);
371 * gtk_image_menu_item_new:
372 * @returns: a new #GtkImageMenuItem.
374 * Creates a new #GtkImageMenuItem with an empty label.
377 gtk_image_menu_item_new (void)
379 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
383 * gtk_image_menu_item_new_with_label:
384 * @label: the text of the menu item.
385 * @returns: a new #GtkImageMenuItem.
387 * Creates a new #GtkImageMenuItem containing a label.
390 gtk_image_menu_item_new_with_label (const gchar *label)
392 GtkImageMenuItem *image_menu_item;
393 GtkWidget *accel_label;
395 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
397 accel_label = gtk_accel_label_new (label);
398 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
400 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
401 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
402 GTK_WIDGET (image_menu_item));
403 gtk_widget_show (accel_label);
405 return GTK_WIDGET(image_menu_item);
410 * gtk_image_menu_item_new_with_mnemonic:
411 * @label: the text of the menu item, with an underscore in front of the
413 * @returns: a new #GtkImageMenuItem
415 * Creates a new #GtkImageMenuItem containing a label. The label
416 * will be created using gtk_label_new_with_mnemonic(), so underscores
417 * in @label indicate the mnemonic for the menu item.
420 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
422 GtkImageMenuItem *image_menu_item;
423 GtkWidget *accel_label;
425 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
427 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
428 gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
429 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
431 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
432 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
433 GTK_WIDGET (image_menu_item));
434 gtk_widget_show (accel_label);
436 return GTK_WIDGET(image_menu_item);
440 * gtk_image_menu_item_new_from_stock:
441 * @stock_id: the name of the stock item.
442 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
444 * @returns: a new #GtkImageMenuItem.
446 * Creates a new #GtkImageMenuItem containing the image and text from a
447 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
448 * and #GTK_STOCK_APPLY.
450 * If you want this menu item to have changeable accelerators, then pass in
451 * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
452 * appropriate path for the menu item, use gtk_stock_lookup() to look up the
453 * standard accelerator for the stock item, and if one is found, call
454 * gtk_accel_map_add_entry() to register it.
457 gtk_image_menu_item_new_from_stock (const gchar *stock_id,
458 GtkAccelGroup *accel_group)
461 GtkStockItem stock_item;
464 g_return_val_if_fail (stock_id != NULL, NULL);
466 image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
468 if (gtk_stock_lookup (stock_id, &stock_item))
470 item = gtk_image_menu_item_new_with_mnemonic (stock_item.label);
472 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
474 if (stock_item.keyval && accel_group)
475 gtk_widget_add_accelerator (item,
484 item = gtk_image_menu_item_new_with_mnemonic (stock_id);
486 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
489 gtk_widget_show (image);
494 * gtk_image_menu_item_set_image:
495 * @image_menu_item: a #GtkImageMenuItem.
496 * @image: a widget to set as the image for the menu item.
498 * Sets the image of @image_menu_item to the given widget.
499 * Note that it depends on the show-menu-images setting whether
500 * the image will be displayed or not.
503 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
506 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
508 if (image == image_menu_item->image)
511 if (image_menu_item->image)
512 gtk_container_remove (GTK_CONTAINER (image_menu_item),
513 image_menu_item->image);
515 image_menu_item->image = image;
520 gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
522 "visible", show_image (image_menu_item),
526 g_object_notify (G_OBJECT (image_menu_item), "image");
530 * gtk_image_menu_item_get_image:
531 * @image_menu_item: a #GtkImageMenuItem.
532 * @returns: the widget set as image of @image_menu_item.
534 * Gets the widget that is currently set as the image of @image_menu_item.
535 * See gtk_image_menu_item_set_image().
538 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
540 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
542 return image_menu_item->image;
546 gtk_image_menu_item_remove (GtkContainer *container,
549 GtkImageMenuItem *image_menu_item;
551 image_menu_item = GTK_IMAGE_MENU_ITEM (container);
553 if (child == image_menu_item->image)
555 gboolean widget_was_visible;
557 widget_was_visible = GTK_WIDGET_VISIBLE (child);
559 gtk_widget_unparent (child);
560 image_menu_item->image = NULL;
562 if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
563 gtk_widget_queue_resize (GTK_WIDGET (container));
565 g_object_notify (G_OBJECT (image_menu_item), "image");
569 GTK_CONTAINER_CLASS (gtk_image_menu_item_parent_class)->remove (container, child);
574 show_image_change_notify (GtkImageMenuItem *image_menu_item)
576 if (image_menu_item->image)
578 if (show_image (image_menu_item))
579 gtk_widget_show (image_menu_item->image);
581 gtk_widget_hide (image_menu_item->image);
586 traverse_container (GtkWidget *widget,
589 if (GTK_IS_IMAGE_MENU_ITEM (widget))
590 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
591 else if (GTK_IS_CONTAINER (widget))
592 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
596 gtk_image_menu_item_setting_changed (GtkSettings *settings)
600 list = gtk_window_list_toplevels ();
602 for (l = list; l; l = l->next)
603 gtk_container_forall (GTK_CONTAINER (l->data),
604 traverse_container, NULL);
610 gtk_image_menu_item_screen_changed (GtkWidget *widget,
611 GdkScreen *previous_screen)
613 GtkSettings *settings;
614 guint show_image_connection;
616 if (!gtk_widget_has_screen (widget))
619 settings = gtk_widget_get_settings (widget);
621 show_image_connection =
622 GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (settings),
623 "gtk-image-menu-item-connection"));
625 if (show_image_connection)
628 show_image_connection =
629 g_signal_connect (settings, "notify::gtk-menu-images",
630 G_CALLBACK (gtk_image_menu_item_setting_changed), NULL);
631 g_object_set_data (G_OBJECT (settings),
632 I_("gtk-image-menu-item-connection"),
633 GUINT_TO_POINTER (show_image_connection));
635 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
638 #define __GTK_IMAGE_MENU_ITEM_C__
639 #include "gtkaliasdef.c"