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"
30 #include "gtkaccellabel.h"
33 #include "gtkiconfactory.h"
35 #include "gtkcontainer.h"
36 #include "gtkwindow.h"
38 static void gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass);
39 static void gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item);
40 static void gtk_image_menu_item_size_request (GtkWidget *widget,
41 GtkRequisition *requisition);
42 static void gtk_image_menu_item_size_allocate (GtkWidget *widget,
43 GtkAllocation *allocation);
44 static void gtk_image_menu_item_remove (GtkContainer *container,
46 static void gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
49 static void gtk_image_menu_item_forall (GtkContainer *container,
50 gboolean include_internals,
52 gpointer callback_data);
54 static void gtk_image_menu_item_set_property (GObject *object,
58 static void gtk_image_menu_item_get_property (GObject *object,
62 static void gtk_image_menu_item_screen_changed (GtkWidget *widget,
63 GdkScreen *previous_screen);
71 static GtkMenuItemClass *parent_class = NULL;
74 gtk_image_menu_item_get_type (void)
76 static GType image_menu_item_type = 0;
78 if (!image_menu_item_type)
80 static const GTypeInfo image_menu_item_info =
82 sizeof (GtkImageMenuItemClass),
84 NULL, /* base_finalize */
85 (GClassInitFunc) gtk_image_menu_item_class_init,
86 NULL, /* class_finalize */
87 NULL, /* class_data */
88 sizeof (GtkImageMenuItem),
90 (GInstanceInitFunc) gtk_image_menu_item_init,
93 image_menu_item_type =
94 g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkImageMenuItem",
95 &image_menu_item_info, 0);
98 return image_menu_item_type;
102 gtk_image_menu_item_class_init (GtkImageMenuItemClass *klass)
104 GObjectClass *gobject_class;
105 GtkWidgetClass *widget_class;
106 GtkMenuItemClass *menu_item_class;
107 GtkContainerClass *container_class;
109 gobject_class = (GObjectClass*) klass;
110 widget_class = (GtkWidgetClass*) klass;
111 menu_item_class = (GtkMenuItemClass*) klass;
112 container_class = (GtkContainerClass*) klass;
114 parent_class = g_type_class_peek_parent (klass);
116 widget_class->screen_changed = gtk_image_menu_item_screen_changed;
117 widget_class->size_request = gtk_image_menu_item_size_request;
118 widget_class->size_allocate = gtk_image_menu_item_size_allocate;
120 container_class->forall = gtk_image_menu_item_forall;
121 container_class->remove = gtk_image_menu_item_remove;
123 menu_item_class->toggle_size_request = gtk_image_menu_item_toggle_size_request;
125 gobject_class->set_property = gtk_image_menu_item_set_property;
126 gobject_class->get_property = gtk_image_menu_item_get_property;
128 g_object_class_install_property (gobject_class,
130 g_param_spec_object ("image",
132 P_("Child widget to appear next to the menu text"),
134 G_PARAM_READABLE | G_PARAM_WRITABLE));
136 gtk_settings_install_property (g_param_spec_boolean ("gtk-menu-images",
137 P_("Show menu images"),
138 P_("Whether images should be shown in menus"),
145 gtk_image_menu_item_init (GtkImageMenuItem *image_menu_item)
147 image_menu_item->image = NULL;
151 gtk_image_menu_item_set_property (GObject *object,
156 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
164 image = (GtkWidget*) g_value_get_object (value);
166 gtk_image_menu_item_set_image (image_menu_item, image);
170 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
175 gtk_image_menu_item_get_property (GObject *object,
180 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (object);
185 g_value_set_object (value,
186 (GObject*) image_menu_item->image);
189 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
195 show_image (GtkImageMenuItem *image_menu_item)
197 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (image_menu_item));
200 g_object_get (settings, "gtk-menu-images", &show, NULL);
206 gtk_image_menu_item_toggle_size_request (GtkMenuItem *menu_item,
209 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (menu_item);
213 if (image_menu_item->image && show_image (image_menu_item))
215 GtkRequisition image_requisition;
217 gtk_widget_get_child_requisition (image_menu_item->image,
220 if (image_requisition.width > 0)
222 guint toggle_spacing;
223 gtk_widget_style_get (GTK_WIDGET (menu_item),
224 "toggle_spacing", &toggle_spacing,
227 *requisition = image_requisition.width + toggle_spacing;
234 gtk_image_menu_item_size_request (GtkWidget *widget,
235 GtkRequisition *requisition)
237 GtkImageMenuItem *image_menu_item;
238 gint child_height = 0;
240 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
242 if (image_menu_item->image &&
243 GTK_WIDGET_VISIBLE (image_menu_item->image) &&
244 show_image (image_menu_item))
246 GtkRequisition child_requisition;
248 gtk_widget_size_request (image_menu_item->image,
251 child_height = child_requisition.height;
254 (* GTK_WIDGET_CLASS (parent_class)->size_request) (widget, requisition);
256 /* not done with height since that happens via the
257 * toggle_size_request
259 requisition->height = MAX (requisition->height, child_height);
261 /* Note that GtkMenuShell always size requests before
262 * toggle_size_request, so toggle_size_request will be able to use
263 * image_menu_item->image->requisition
268 gtk_image_menu_item_size_allocate (GtkWidget *widget,
269 GtkAllocation *allocation)
271 GtkImageMenuItem *image_menu_item;
273 image_menu_item = GTK_IMAGE_MENU_ITEM (widget);
275 (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
277 if (image_menu_item->image && show_image (image_menu_item))
280 GtkRequisition child_requisition;
281 GtkAllocation child_allocation;
282 guint horizontal_padding, toggle_spacing;
284 gtk_widget_style_get (widget,
285 "horizontal_padding", &horizontal_padding,
286 "toggle_spacing", &toggle_spacing,
289 /* Man this is lame hardcoding action, but I can't
290 * come up with a solution that's really better.
293 gtk_widget_get_child_requisition (image_menu_item->image,
296 offset = GTK_CONTAINER (image_menu_item)->border_width +
297 widget->style->xthickness;
299 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
301 x = offset + horizontal_padding +
302 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
303 toggle_spacing - child_requisition.width) / 2;
307 x = widget->allocation.width - offset - horizontal_padding -
308 GTK_MENU_ITEM (image_menu_item)->toggle_size + toggle_spacing +
309 (GTK_MENU_ITEM (image_menu_item)->toggle_size -
310 toggle_spacing - child_requisition.width) / 2;
313 y = (widget->allocation.height - child_requisition.height) / 2;
315 child_allocation.width = child_requisition.width;
316 child_allocation.height = child_requisition.height;
317 child_allocation.x = widget->allocation.x + MAX (x, 0);
318 child_allocation.y = widget->allocation.y + MAX (y, 0);
320 gtk_widget_size_allocate (image_menu_item->image, &child_allocation);
325 gtk_image_menu_item_forall (GtkContainer *container,
326 gboolean include_internals,
327 GtkCallback callback,
328 gpointer callback_data)
330 GtkImageMenuItem *image_menu_item = GTK_IMAGE_MENU_ITEM (container);
332 (* GTK_CONTAINER_CLASS (parent_class)->forall) (container,
337 if (image_menu_item->image)
338 (* callback) (image_menu_item->image, callback_data);
342 * gtk_image_menu_item_new:
343 * @returns: a new #GtkImageMenuItem.
345 * Creates a new #GtkImageMenuItem with an empty label.
348 gtk_image_menu_item_new (void)
350 return g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
354 * gtk_image_menu_item_new_with_label:
355 * @label: the text of the menu item.
356 * @returns: a new #GtkImageMenuItem.
358 * Creates a new #GtkImageMenuItem containing a label.
361 gtk_image_menu_item_new_with_label (const gchar *label)
363 GtkImageMenuItem *image_menu_item;
364 GtkWidget *accel_label;
366 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
368 accel_label = gtk_accel_label_new (label);
369 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
371 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
372 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
373 GTK_WIDGET (image_menu_item));
374 gtk_widget_show (accel_label);
376 return GTK_WIDGET(image_menu_item);
381 * gtk_image_menu_item_new_with_mnemonic:
382 * @label: the text of the menu item, with an underscore in front of the
384 * @returns: a new #GtkImageMenuItem
386 * Creates a new #GtkImageMenuItem containing a label. The label
387 * will be created using gtk_label_new_with_mnemonic(), so underscores
388 * in @label indicate the mnemonic for the menu item.
391 gtk_image_menu_item_new_with_mnemonic (const gchar *label)
393 GtkImageMenuItem *image_menu_item;
394 GtkWidget *accel_label;
396 image_menu_item = g_object_new (GTK_TYPE_IMAGE_MENU_ITEM, NULL);
398 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
399 gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
400 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
402 gtk_container_add (GTK_CONTAINER (image_menu_item), accel_label);
403 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label),
404 GTK_WIDGET (image_menu_item));
405 gtk_widget_show (accel_label);
407 return GTK_WIDGET(image_menu_item);
411 * gtk_image_menu_item_new_from_stock:
412 * @stock_id: the name of the stock item.
413 * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
415 * @returns: a new #GtkImageMenuItem.
417 * Creates a new #GtkImageMenuItem containing the image and text from a
418 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
419 * and #GTK_STOCK_APPLY.
421 * If you want this menu item to have changeable accelerators, then pass in
422 * %NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
423 * appropriate path for the menu item, use gtk_stock_lookup() to look up the
424 * standard accelerator for the stock item, and if one is found, call
425 * gtk_accel_map_add_entry() to register it.
428 gtk_image_menu_item_new_from_stock (const gchar *stock_id,
429 GtkAccelGroup *accel_group)
432 GtkStockItem stock_item;
435 g_return_val_if_fail (stock_id != NULL, NULL);
437 image = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
439 if (gtk_stock_lookup (stock_id, &stock_item))
441 item = gtk_image_menu_item_new_with_mnemonic (stock_item.label);
443 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
445 if (stock_item.keyval && accel_group)
446 gtk_widget_add_accelerator (item,
455 item = gtk_image_menu_item_new_with_mnemonic (stock_id);
457 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), image);
460 gtk_widget_show (image);
465 * gtk_image_menu_item_set_image:
466 * @image_menu_item: a #GtkImageMenuItem.
467 * @image: a widget to set as the image for the menu item.
469 * Sets the image of @image_menu_item to the given widget.
472 gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item,
475 g_return_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item));
477 if (image == image_menu_item->image)
480 if (image_menu_item->image)
481 gtk_container_remove (GTK_CONTAINER (image_menu_item),
482 image_menu_item->image);
484 image_menu_item->image = image;
489 gtk_widget_set_parent (image, GTK_WIDGET (image_menu_item));
491 "visible", show_image (image_menu_item),
495 g_object_notify (G_OBJECT (image_menu_item), "image");
499 * gtk_image_menu_item_get_image:
500 * @image_menu_item: a #GtkImageMenuItem.
501 * @returns: the widget set as image of @image_menu_item.
503 * Gets the widget that is currently set as the image of @image_menu_item.
504 * See gtk_image_menu_item_set_image().
507 gtk_image_menu_item_get_image (GtkImageMenuItem *image_menu_item)
509 g_return_val_if_fail (GTK_IS_IMAGE_MENU_ITEM (image_menu_item), NULL);
511 return image_menu_item->image;
515 gtk_image_menu_item_remove (GtkContainer *container,
518 GtkImageMenuItem *image_menu_item;
520 image_menu_item = GTK_IMAGE_MENU_ITEM (container);
522 if (child == image_menu_item->image)
524 gboolean widget_was_visible;
526 widget_was_visible = GTK_WIDGET_VISIBLE (child);
528 gtk_widget_unparent (child);
529 image_menu_item->image = NULL;
531 if (GTK_WIDGET_VISIBLE (container) && widget_was_visible)
532 gtk_widget_queue_resize (GTK_WIDGET (container));
534 g_object_notify (G_OBJECT (image_menu_item), "image");
538 (* GTK_CONTAINER_CLASS (parent_class)->remove) (container, child);
543 show_image_change_notify (GtkImageMenuItem *image_menu_item)
545 if (image_menu_item->image)
547 if (show_image (image_menu_item))
548 gtk_widget_show (image_menu_item->image);
550 gtk_widget_hide (image_menu_item->image);
555 traverse_container (GtkWidget *widget,
558 if (GTK_IS_IMAGE_MENU_ITEM (widget))
559 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));
560 else if (GTK_IS_CONTAINER (widget))
561 gtk_container_forall (GTK_CONTAINER (widget), traverse_container, NULL);
565 gtk_image_menu_item_setting_changed (GtkSettings *settings)
569 list = gtk_window_list_toplevels ();
571 for (; list; list = list->next)
572 gtk_container_forall (GTK_CONTAINER (list->data), traverse_container, NULL);
578 gtk_image_menu_item_screen_changed (GtkWidget *widget,
579 GdkScreen *previous_screen)
581 GtkSettings *settings;
582 guint show_image_connection;
584 if (!gtk_widget_has_screen (widget))
587 settings = gtk_widget_get_settings (widget);
589 show_image_connection =
590 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
591 "gtk-image-menu-item-connection"));
593 if (show_image_connection)
596 show_image_connection =
597 g_signal_connect (settings, "notify::gtk-menu-images",
598 G_CALLBACK (gtk_image_menu_item_setting_changed), 0);
599 g_object_set_data (G_OBJECT (settings),
600 "gtk-image-menu-item-connection",
601 GINT_TO_POINTER (show_image_connection));
603 show_image_change_notify (GTK_IMAGE_MENU_ITEM (widget));