1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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/.
27 #define GTK_MENU_INTERNALS
32 #include "gtkaccellabel.h"
34 #include "gtkmarshalers.h"
36 #include "gtkmenubar.h"
37 #include "gtkmenuitem.h"
38 #include "gtkseparatormenuitem.h"
39 #include "gtkprivate.h"
43 #define MENU_ITEM_CLASS(w) GTK_MENU_ITEM_CLASS (GTK_OBJECT (w)->klass)
54 static void gtk_menu_item_destroy (GtkObject *object);
55 static void gtk_menu_item_finalize (GObject *object);
56 static void gtk_menu_item_size_request (GtkWidget *widget,
57 GtkRequisition *requisition);
58 static void gtk_menu_item_size_allocate (GtkWidget *widget,
59 GtkAllocation *allocation);
60 static void gtk_menu_item_realize (GtkWidget *widget);
61 static void gtk_menu_item_unrealize (GtkWidget *widget);
62 static void gtk_menu_item_map (GtkWidget *widget);
63 static void gtk_menu_item_unmap (GtkWidget *widget);
64 static void gtk_menu_item_paint (GtkWidget *widget,
66 static gint gtk_menu_item_expose (GtkWidget *widget,
67 GdkEventExpose *event);
68 static void gtk_menu_item_parent_set (GtkWidget *widget,
69 GtkWidget *previous_parent);
72 static void gtk_real_menu_item_select (GtkItem *item);
73 static void gtk_real_menu_item_deselect (GtkItem *item);
74 static void gtk_real_menu_item_activate_item (GtkMenuItem *item);
75 static void gtk_real_menu_item_toggle_size_request (GtkMenuItem *menu_item,
77 static void gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
79 static gboolean gtk_menu_item_mnemonic_activate (GtkWidget *widget,
80 gboolean group_cycling);
82 static gint gtk_menu_item_select_timeout (gpointer data);
83 static void gtk_menu_item_position_menu (GtkMenu *menu,
88 static void gtk_menu_item_show_all (GtkWidget *widget);
89 static void gtk_menu_item_hide_all (GtkWidget *widget);
90 static void gtk_menu_item_forall (GtkContainer *container,
91 gboolean include_internals,
93 gpointer callback_data);
94 static gboolean gtk_menu_item_can_activate_accel (GtkWidget *widget,
98 static guint menu_item_signals[LAST_SIGNAL] = { 0 };
100 G_DEFINE_TYPE (GtkMenuItem, gtk_menu_item, GTK_TYPE_ITEM)
103 gtk_menu_item_class_init (GtkMenuItemClass *klass)
105 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
106 GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);
107 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
108 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
109 GtkItemClass *item_class = GTK_ITEM_CLASS (klass);
111 gobject_class->finalize = gtk_menu_item_finalize;
113 object_class->destroy = gtk_menu_item_destroy;
115 widget_class->size_request = gtk_menu_item_size_request;
116 widget_class->size_allocate = gtk_menu_item_size_allocate;
117 widget_class->expose_event = gtk_menu_item_expose;
118 widget_class->realize = gtk_menu_item_realize;
119 widget_class->unrealize = gtk_menu_item_unrealize;
120 widget_class->map = gtk_menu_item_map;
121 widget_class->unmap = gtk_menu_item_unmap;
122 widget_class->show_all = gtk_menu_item_show_all;
123 widget_class->hide_all = gtk_menu_item_hide_all;
124 widget_class->mnemonic_activate = gtk_menu_item_mnemonic_activate;
125 widget_class->parent_set = gtk_menu_item_parent_set;
126 widget_class->can_activate_accel = gtk_menu_item_can_activate_accel;
128 container_class->forall = gtk_menu_item_forall;
130 item_class->select = gtk_real_menu_item_select;
131 item_class->deselect = gtk_real_menu_item_deselect;
133 klass->activate = NULL;
134 klass->activate_item = gtk_real_menu_item_activate_item;
135 klass->toggle_size_request = gtk_real_menu_item_toggle_size_request;
136 klass->toggle_size_allocate = gtk_real_menu_item_toggle_size_allocate;
138 klass->hide_on_activate = TRUE;
140 menu_item_signals[ACTIVATE] =
141 g_signal_new (I_("activate"),
142 G_OBJECT_CLASS_TYPE (gobject_class),
143 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
144 G_STRUCT_OFFSET (GtkMenuItemClass, activate),
146 _gtk_marshal_VOID__VOID,
148 widget_class->activate_signal = menu_item_signals[ACTIVATE];
150 menu_item_signals[ACTIVATE_ITEM] =
151 g_signal_new (I_("activate_item"),
152 G_OBJECT_CLASS_TYPE (gobject_class),
154 G_STRUCT_OFFSET (GtkMenuItemClass, activate_item),
156 _gtk_marshal_VOID__VOID,
159 menu_item_signals[TOGGLE_SIZE_REQUEST] =
160 g_signal_new (I_("toggle_size_request"),
161 G_OBJECT_CLASS_TYPE (gobject_class),
163 G_STRUCT_OFFSET (GtkMenuItemClass, toggle_size_request),
165 _gtk_marshal_VOID__POINTER,
169 menu_item_signals[TOGGLE_SIZE_ALLOCATE] =
170 g_signal_new (I_("toggle_size_allocate"),
171 G_OBJECT_CLASS_TYPE (gobject_class),
173 G_STRUCT_OFFSET (GtkMenuItemClass, toggle_size_allocate),
175 _gtk_marshal_NONE__INT,
179 gtk_widget_class_install_style_property_parser (widget_class,
180 g_param_spec_enum ("selected-shadow-type",
181 "Selected Shadow Type",
182 "Shadow type when item is selected",
183 GTK_TYPE_SHADOW_TYPE,
186 gtk_rc_property_parse_enum);
188 gtk_widget_class_install_style_property (widget_class,
189 g_param_spec_int ("horizontal-padding",
190 "Horizontal Padding",
191 "Padding to left and right of the menu item",
195 GTK_PARAM_READABLE));
197 gtk_widget_class_install_style_property (widget_class,
198 g_param_spec_int ("toggle-spacing",
200 "Space between icon and label",
204 GTK_PARAM_READABLE));
206 gtk_widget_class_install_style_property (widget_class,
207 g_param_spec_int ("arrow-spacing",
209 "Space between label and arrow",
213 GTK_PARAM_READABLE));
217 gtk_menu_item_init (GtkMenuItem *menu_item)
219 GTK_WIDGET_SET_FLAGS (menu_item, GTK_NO_WINDOW);
221 menu_item->submenu = NULL;
222 menu_item->toggle_size = 0;
223 menu_item->accelerator_width = 0;
224 menu_item->show_submenu_indicator = FALSE;
225 if (gtk_widget_get_direction (GTK_WIDGET (menu_item)) == GTK_TEXT_DIR_RTL)
226 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
228 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
229 menu_item->submenu_placement = GTK_TOP_BOTTOM;
230 menu_item->right_justify = FALSE;
232 menu_item->timer = 0;
236 gtk_menu_item_new (void)
238 return g_object_new (GTK_TYPE_MENU_ITEM, NULL);
242 gtk_menu_item_new_with_label (const gchar *label)
244 GtkWidget *menu_item;
245 GtkWidget *accel_label;
247 menu_item = gtk_menu_item_new ();
248 accel_label = gtk_accel_label_new (label);
249 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
251 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
252 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
253 gtk_widget_show (accel_label);
260 * gtk_menu_item_new_with_mnemonic:
261 * @label: The text of the button, with an underscore in front of the
263 * @returns: a new #GtkMenuItem
265 * Creates a new #GtkMenuItem containing a label. The label
266 * will be created using gtk_label_new_with_mnemonic(), so underscores
267 * in @label indicate the mnemonic for the menu item.
270 gtk_menu_item_new_with_mnemonic (const gchar *label)
272 GtkWidget *menu_item;
273 GtkWidget *accel_label;
275 menu_item = gtk_menu_item_new ();
276 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
277 gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
278 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
280 gtk_container_add (GTK_CONTAINER (menu_item), accel_label);
281 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), menu_item);
282 gtk_widget_show (accel_label);
288 gtk_menu_item_destroy (GtkObject *object)
290 GtkMenuItem *menu_item;
292 g_return_if_fail (GTK_IS_MENU_ITEM (object));
294 menu_item = GTK_MENU_ITEM (object);
296 if (menu_item->submenu)
297 gtk_widget_destroy (menu_item->submenu);
299 GTK_OBJECT_CLASS (gtk_menu_item_parent_class)->destroy (object);
303 gtk_menu_item_finalize (GObject *object)
305 GtkMenuItem *menu_item = GTK_MENU_ITEM (object);
307 g_free (menu_item->accel_path);
309 G_OBJECT_CLASS (gtk_menu_item_parent_class)->finalize (object);
313 gtk_menu_item_detacher (GtkWidget *widget,
316 GtkMenuItem *menu_item;
318 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
320 menu_item = GTK_MENU_ITEM (widget);
321 g_return_if_fail (menu_item->submenu == (GtkWidget*) menu);
323 menu_item->submenu = NULL;
327 gtk_menu_item_set_submenu (GtkMenuItem *menu_item,
330 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
332 if (menu_item->submenu != submenu)
334 gtk_menu_item_remove_submenu (menu_item);
336 menu_item->submenu = submenu;
337 gtk_menu_attach_to_widget (GTK_MENU (submenu),
338 GTK_WIDGET (menu_item),
339 gtk_menu_item_detacher);
341 if (GTK_WIDGET (menu_item)->parent)
342 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
347 * gtk_menu_item_get_submenu:
348 * @menu_item: a #GtkMenuItem
350 * Gets the submenu underneath this menu item, if any. See
351 * gtk_menu_item_set_submenu().
353 * Return value: submenu for this menu item, or %NULL if none.
356 gtk_menu_item_get_submenu (GtkMenuItem *menu_item)
358 g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), NULL);
360 return menu_item->submenu;
364 gtk_menu_item_remove_submenu (GtkMenuItem *menu_item)
366 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
368 if (menu_item->submenu)
369 gtk_menu_detach (GTK_MENU (menu_item->submenu));
372 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
373 GtkSubmenuPlacement placement);
376 _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
377 GtkSubmenuPlacement placement)
379 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
381 menu_item->submenu_placement = placement;
385 gtk_menu_item_select (GtkMenuItem *menu_item)
387 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
389 gtk_item_select (GTK_ITEM (menu_item));
393 gtk_menu_item_deselect (GtkMenuItem *menu_item)
395 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
397 gtk_item_deselect (GTK_ITEM (menu_item));
401 gtk_menu_item_activate (GtkMenuItem *menu_item)
403 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
405 g_signal_emit (menu_item, menu_item_signals[ACTIVATE], 0);
409 gtk_menu_item_toggle_size_request (GtkMenuItem *menu_item,
412 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
414 g_signal_emit (menu_item, menu_item_signals[TOGGLE_SIZE_REQUEST], 0, requisition);
418 gtk_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
421 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
423 g_signal_emit (menu_item, menu_item_signals[TOGGLE_SIZE_ALLOCATE], 0, allocation);
427 gtk_menu_item_accel_width_foreach (GtkWidget *widget,
432 if (GTK_IS_ACCEL_LABEL (widget))
436 w = gtk_accel_label_get_accel_width (GTK_ACCEL_LABEL (widget));
437 *width = MAX (*width, w);
439 else if (GTK_IS_CONTAINER (widget))
440 gtk_container_foreach (GTK_CONTAINER (widget),
441 gtk_menu_item_accel_width_foreach,
446 get_minimum_width (GtkWidget *widget)
448 PangoContext *context;
449 PangoFontMetrics *metrics;
452 context = gtk_widget_get_pango_context (widget);
453 metrics = pango_context_get_metrics (context,
454 widget->style->font_desc,
455 pango_context_get_language (context));
457 height = pango_font_metrics_get_ascent (metrics) +
458 pango_font_metrics_get_descent (metrics);
460 pango_font_metrics_unref (metrics);
462 return PANGO_PIXELS (7 * height);
466 gtk_menu_item_size_request (GtkWidget *widget,
467 GtkRequisition *requisition)
469 GtkMenuItem *menu_item;
472 guint horizontal_padding;
473 GtkPackDirection pack_dir;
474 GtkPackDirection child_pack_dir;
476 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
477 g_return_if_fail (requisition != NULL);
479 gtk_widget_style_get (widget,
480 "horizontal-padding", &horizontal_padding,
483 bin = GTK_BIN (widget);
484 menu_item = GTK_MENU_ITEM (widget);
486 if (GTK_IS_MENU_BAR (widget->parent))
488 pack_dir = gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (widget->parent));
489 child_pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
493 pack_dir = GTK_PACK_DIRECTION_LTR;
494 child_pack_dir = GTK_PACK_DIRECTION_LTR;
497 requisition->width = (GTK_CONTAINER (widget)->border_width +
498 widget->style->xthickness) * 2;
499 requisition->height = (GTK_CONTAINER (widget)->border_width +
500 widget->style->ythickness) * 2;
502 if ((pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL) &&
503 (child_pack_dir == GTK_PACK_DIRECTION_LTR || child_pack_dir == GTK_PACK_DIRECTION_RTL))
504 requisition->width += 2 * horizontal_padding;
505 else if ((pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT) &&
506 (child_pack_dir == GTK_PACK_DIRECTION_TTB || child_pack_dir == GTK_PACK_DIRECTION_BTT))
507 requisition->height += 2 * horizontal_padding;
509 if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
511 GtkRequisition child_requisition;
513 gtk_widget_size_request (bin->child, &child_requisition);
515 requisition->width += child_requisition.width;
516 requisition->height += child_requisition.height;
518 if (menu_item->submenu && menu_item->show_submenu_indicator)
522 gtk_widget_style_get (widget,
523 "arrow-spacing", &arrow_spacing,
526 requisition->width += child_requisition.height;
527 requisition->width += arrow_spacing;
529 requisition->width = MAX (requisition->width, get_minimum_width (widget));
532 else /* separator item */
534 gboolean wide_separators;
535 gint separator_height;
537 gtk_widget_style_get (widget,
538 "wide-separators", &wide_separators,
539 "separator-height", &separator_height,
543 requisition->height += separator_height + widget->style->ythickness;
545 requisition->height += widget->style->ythickness * 2;
549 gtk_container_foreach (GTK_CONTAINER (menu_item),
550 gtk_menu_item_accel_width_foreach,
552 menu_item->accelerator_width = accel_width;
556 gtk_menu_item_size_allocate (GtkWidget *widget,
557 GtkAllocation *allocation)
559 GtkMenuItem *menu_item;
561 GtkAllocation child_allocation;
562 GtkTextDirection direction;
563 GtkPackDirection pack_dir;
564 GtkPackDirection child_pack_dir;
566 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
567 g_return_if_fail (allocation != NULL);
569 menu_item = GTK_MENU_ITEM (widget);
570 bin = GTK_BIN (widget);
572 direction = gtk_widget_get_direction (widget);
574 if (GTK_IS_MENU_BAR (widget->parent))
576 pack_dir = gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (widget->parent));
577 child_pack_dir = gtk_menu_bar_get_child_pack_direction (GTK_MENU_BAR (widget->parent));
581 pack_dir = GTK_PACK_DIRECTION_LTR;
582 child_pack_dir = GTK_PACK_DIRECTION_LTR;
585 widget->allocation = *allocation;
589 GtkRequisition child_requisition;
590 guint horizontal_padding;
592 gtk_widget_style_get (widget,
593 "horizontal-padding", &horizontal_padding,
596 child_allocation.x = GTK_CONTAINER (widget)->border_width + widget->style->xthickness;
597 child_allocation.y = GTK_CONTAINER (widget)->border_width + widget->style->ythickness;
599 if ((pack_dir == GTK_PACK_DIRECTION_LTR || pack_dir == GTK_PACK_DIRECTION_RTL) &&
600 (child_pack_dir == GTK_PACK_DIRECTION_LTR || child_pack_dir == GTK_PACK_DIRECTION_RTL))
601 child_allocation.x += horizontal_padding;
602 else if ((pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT) &&
603 (child_pack_dir == GTK_PACK_DIRECTION_TTB || child_pack_dir == GTK_PACK_DIRECTION_BTT))
604 child_allocation.y += horizontal_padding;
606 child_allocation.width = MAX (1, (gint)allocation->width - child_allocation.x * 2);
607 child_allocation.height = MAX (1, (gint)allocation->height - child_allocation.y * 2);
609 if (child_pack_dir == GTK_PACK_DIRECTION_LTR ||
610 child_pack_dir == GTK_PACK_DIRECTION_RTL)
612 if ((direction == GTK_TEXT_DIR_LTR) == (child_pack_dir != GTK_PACK_DIRECTION_RTL))
613 child_allocation.x += GTK_MENU_ITEM (widget)->toggle_size;
614 child_allocation.width -= GTK_MENU_ITEM (widget)->toggle_size;
618 if ((direction == GTK_TEXT_DIR_LTR) == (child_pack_dir != GTK_PACK_DIRECTION_BTT))
619 child_allocation.y += GTK_MENU_ITEM (widget)->toggle_size;
620 child_allocation.height -= GTK_MENU_ITEM (widget)->toggle_size;
623 child_allocation.x += widget->allocation.x;
624 child_allocation.y += widget->allocation.y;
626 gtk_widget_get_child_requisition (bin->child, &child_requisition);
627 if (menu_item->submenu && menu_item->show_submenu_indicator)
629 if (direction == GTK_TEXT_DIR_RTL)
630 child_allocation.x += child_requisition.height;
631 child_allocation.width -= child_requisition.height;
634 if (child_allocation.width < 1)
635 child_allocation.width = 1;
637 gtk_widget_size_allocate (bin->child, &child_allocation);
640 if (GTK_WIDGET_REALIZED (widget))
641 gdk_window_move_resize (menu_item->event_window,
642 allocation->x, allocation->y,
643 allocation->width, allocation->height);
645 if (menu_item->submenu)
646 gtk_menu_reposition (GTK_MENU (menu_item->submenu));
650 gtk_menu_item_realize (GtkWidget *widget)
652 GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
653 GdkWindowAttr attributes;
654 gint attributes_mask;
656 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
658 widget->window = gtk_widget_get_parent_window (widget);
659 g_object_ref (widget->window);
661 attributes.x = widget->allocation.x;
662 attributes.y = widget->allocation.y;
663 attributes.width = widget->allocation.width;
664 attributes.height = widget->allocation.height;
665 attributes.window_type = GDK_WINDOW_CHILD;
666 attributes.wclass = GDK_INPUT_ONLY;
667 attributes.event_mask = (gtk_widget_get_events (widget) |
668 GDK_BUTTON_PRESS_MASK |
669 GDK_BUTTON_RELEASE_MASK |
670 GDK_ENTER_NOTIFY_MASK |
671 GDK_LEAVE_NOTIFY_MASK |
672 GDK_POINTER_MOTION_MASK);
674 attributes_mask = GDK_WA_X | GDK_WA_Y;
675 menu_item->event_window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
676 gdk_window_set_user_data (menu_item->event_window, widget);
678 widget->style = gtk_style_attach (widget->style, widget->window);
682 gtk_menu_item_unrealize (GtkWidget *widget)
684 GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
686 gdk_window_set_user_data (menu_item->event_window, NULL);
687 gdk_window_destroy (menu_item->event_window);
688 menu_item->event_window = NULL;
690 if (GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->unrealize)
691 (* GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->unrealize) (widget);
695 gtk_menu_item_map (GtkWidget *widget)
697 GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
699 GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->map (widget);
701 gdk_window_show (menu_item->event_window);
705 gtk_menu_item_unmap (GtkWidget *widget)
707 GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
709 gdk_window_hide (menu_item->event_window);
711 GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->unmap (widget);
715 gtk_menu_item_paint (GtkWidget *widget,
718 GtkMenuItem *menu_item;
719 GtkStateType state_type;
720 GtkShadowType shadow_type, selected_shadow_type;
723 gint border_width = GTK_CONTAINER (widget)->border_width;
725 if (GTK_WIDGET_DRAWABLE (widget))
727 menu_item = GTK_MENU_ITEM (widget);
729 state_type = widget->state;
731 x = widget->allocation.x + border_width;
732 y = widget->allocation.y + border_width;
733 width = widget->allocation.width - border_width * 2;
734 height = widget->allocation.height - border_width * 2;
736 if ((state_type == GTK_STATE_PRELIGHT) &&
737 (GTK_BIN (menu_item)->child))
739 gtk_widget_style_get (widget,
740 "selected-shadow-type", &selected_shadow_type,
742 gtk_paint_box (widget->style,
745 selected_shadow_type,
746 area, widget, "menuitem",
747 x, y, width, height);
750 if (menu_item->submenu && menu_item->show_submenu_indicator)
752 gint arrow_x, arrow_y;
755 guint horizontal_padding;
756 GtkTextDirection direction;
757 GtkArrowType arrow_type;
758 PangoContext *context;
759 PangoFontMetrics *metrics;
760 gint ascent, descent;
762 direction = gtk_widget_get_direction (widget);
764 gtk_widget_style_get (widget,
765 "horizontal-padding", &horizontal_padding,
768 context = gtk_widget_get_pango_context (GTK_BIN (menu_item)->child);
769 metrics = pango_context_get_metrics (context,
770 GTK_WIDGET (GTK_BIN (menu_item)->child)->style->font_desc,
771 pango_context_get_language (context));
773 ascent = pango_font_metrics_get_ascent (metrics);
774 descent = pango_font_metrics_get_descent (metrics);
775 pango_font_metrics_unref (metrics);
777 arrow_size = PANGO_PIXELS (ascent + descent) - 2 * widget->style->ythickness;
779 arrow_extent = arrow_size * 0.8;
781 shadow_type = GTK_SHADOW_OUT;
782 if (state_type == GTK_STATE_PRELIGHT)
783 shadow_type = GTK_SHADOW_IN;
785 if (direction == GTK_TEXT_DIR_LTR)
787 arrow_x = x + width - horizontal_padding - arrow_extent;
788 arrow_type = GTK_ARROW_RIGHT;
792 arrow_x = x + horizontal_padding;
793 arrow_type = GTK_ARROW_LEFT;
796 arrow_y = y + (height - arrow_extent) / 2;
798 gtk_paint_arrow (widget->style, widget->window,
799 state_type, shadow_type,
800 area, widget, "menuitem",
803 arrow_extent, arrow_extent);
805 else if (!GTK_BIN (menu_item)->child)
807 gboolean wide_separators;
808 gint separator_height;
809 guint horizontal_padding;
811 gtk_widget_style_get (widget,
812 "wide-separators", &wide_separators,
813 "separator-height", &separator_height,
814 "horizontal-padding", &horizontal_padding,
818 gtk_paint_box (widget->style, widget->window,
819 GTK_STATE_NORMAL, GTK_SHADOW_ETCHED_OUT,
820 area, widget, "hseparator",
821 widget->allocation.x + horizontal_padding + widget->style->xthickness,
822 widget->allocation.y + (widget->allocation.height -
824 widget->style->ythickness) / 2,
825 widget->allocation.width -
826 2 * (horizontal_padding + widget->style->xthickness),
829 gtk_paint_hline (widget->style, widget->window,
830 GTK_STATE_NORMAL, area, widget, "menuitem",
831 widget->allocation.x + horizontal_padding + widget->style->xthickness,
832 widget->allocation.x + widget->allocation.width - horizontal_padding - widget->style->xthickness - 1,
833 widget->allocation.y + (widget->allocation.height -
834 widget->style->ythickness) / 2);
840 gtk_menu_item_expose (GtkWidget *widget,
841 GdkEventExpose *event)
843 g_return_val_if_fail (GTK_IS_MENU_ITEM (widget), FALSE);
844 g_return_val_if_fail (event != NULL, FALSE);
846 if (GTK_WIDGET_DRAWABLE (widget))
848 gtk_menu_item_paint (widget, &event->area);
850 (* GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->expose_event) (widget, event);
857 get_popup_delay (GtkMenuItem *menu_item)
859 GtkWidget *parent = GTK_WIDGET (menu_item)->parent;
861 if (GTK_IS_MENU_SHELL (parent))
863 return _gtk_menu_shell_get_popup_delay (GTK_MENU_SHELL (parent));
869 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_item)),
870 "gtk-menu-popup-delay", &popup_delay,
878 gtk_real_menu_item_select (GtkItem *item)
880 GtkMenuItem *menu_item;
882 g_return_if_fail (GTK_IS_MENU_ITEM (item));
884 menu_item = GTK_MENU_ITEM (item);
886 if (menu_item->submenu &&
887 (!GTK_WIDGET_MAPPED (menu_item->submenu) ||
888 GTK_MENU (menu_item->submenu)->tearoff_active))
892 if (menu_item->timer)
894 g_source_remove (menu_item->timer);
895 menu_item->timer = 0;
899 popup_delay = get_popup_delay (menu_item);
903 GdkEvent *event = gtk_get_current_event ();
905 menu_item->timer = g_timeout_add (popup_delay,
906 gtk_menu_item_select_timeout,
909 event->type != GDK_BUTTON_PRESS &&
910 event->type != GDK_ENTER_NOTIFY)
911 menu_item->timer_from_keypress = TRUE;
913 menu_item->timer_from_keypress = FALSE;
916 gdk_event_free (event);
919 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item));
922 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_PRELIGHT);
923 gtk_widget_queue_draw (GTK_WIDGET (menu_item));
927 gtk_real_menu_item_deselect (GtkItem *item)
929 GtkMenuItem *menu_item;
931 g_return_if_fail (GTK_IS_MENU_ITEM (item));
933 menu_item = GTK_MENU_ITEM (item);
935 if (menu_item->submenu)
937 if (menu_item->timer)
939 g_source_remove (menu_item->timer);
940 menu_item->timer = 0;
943 gtk_menu_popdown (GTK_MENU (menu_item->submenu));
946 gtk_widget_set_state (GTK_WIDGET (menu_item), GTK_STATE_NORMAL);
947 gtk_widget_queue_draw (GTK_WIDGET (menu_item));
951 gtk_menu_item_mnemonic_activate (GtkWidget *widget,
952 gboolean group_cycling)
956 GTK_IS_MENU_SHELL (widget->parent) &&
957 GTK_MENU_SHELL (widget->parent)->active)
959 gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent),
963 g_signal_emit (widget, menu_item_signals[ACTIVATE_ITEM], 0);
970 gtk_real_menu_item_activate_item (GtkMenuItem *menu_item)
974 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
976 widget = GTK_WIDGET (menu_item);
978 if (widget->parent &&
979 GTK_IS_MENU_SHELL (widget->parent))
981 if (menu_item->submenu == NULL)
982 gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget->parent),
986 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget->parent);
988 _gtk_menu_shell_activate (menu_shell);
990 gtk_menu_shell_select_item (GTK_MENU_SHELL (widget->parent), widget);
991 _gtk_menu_item_popup_submenu (widget);
993 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
998 gtk_real_menu_item_toggle_size_request (GtkMenuItem *menu_item,
1001 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1007 gtk_real_menu_item_toggle_size_allocate (GtkMenuItem *menu_item,
1010 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1012 menu_item->toggle_size = allocation;
1016 gtk_menu_item_select_timeout (gpointer data)
1018 GtkMenuItem *menu_item;
1021 GDK_THREADS_ENTER ();
1023 menu_item = GTK_MENU_ITEM (data);
1025 parent = GTK_WIDGET (menu_item)->parent;
1027 if ((GTK_IS_MENU_SHELL (parent) && GTK_MENU_SHELL (parent)->active) ||
1028 (GTK_IS_MENU (parent) && GTK_MENU (parent)->torn_off))
1030 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item));
1031 if (menu_item->timer_from_keypress && menu_item->submenu)
1032 GTK_MENU_SHELL (menu_item->submenu)->ignore_enter = TRUE;
1035 GDK_THREADS_LEAVE ();
1041 _gtk_menu_item_popup_submenu (GtkWidget *widget)
1043 GtkMenuItem *menu_item;
1045 menu_item = GTK_MENU_ITEM (widget);
1047 if (menu_item->timer)
1048 g_source_remove (menu_item->timer);
1049 menu_item->timer = 0;
1051 if (GTK_WIDGET_IS_SENSITIVE (menu_item->submenu))
1053 gboolean take_focus;
1055 take_focus = gtk_menu_shell_get_take_focus (GTK_MENU_SHELL (widget->parent));
1056 gtk_menu_shell_set_take_focus (GTK_MENU_SHELL (menu_item->submenu),
1059 gtk_menu_popup (GTK_MENU (menu_item->submenu),
1062 gtk_menu_item_position_menu,
1064 GTK_MENU_SHELL (widget->parent)->button,
1070 get_offsets (GtkMenu *menu,
1071 gint *horizontal_offset,
1072 gint *vertical_offset)
1074 gint vertical_padding;
1075 gint horizontal_padding;
1077 gtk_widget_style_get (GTK_WIDGET (menu),
1078 "horizontal-offset", horizontal_offset,
1079 "vertical-offset", vertical_offset,
1080 "horizontal-padding", &horizontal_padding,
1081 "vertical-padding", &vertical_padding,
1084 *vertical_offset -= GTK_WIDGET (menu)->style->ythickness;
1085 *vertical_offset -= vertical_padding;
1086 *horizontal_offset += horizontal_padding;
1090 gtk_menu_item_position_menu (GtkMenu *menu,
1096 GtkMenuItem *menu_item;
1098 GtkMenuItem *parent_menu_item;
1100 gint twidth, theight;
1102 GtkTextDirection direction;
1103 GdkRectangle monitor;
1105 gint horizontal_offset;
1106 gint vertical_offset;
1107 gint parent_xthickness;
1109 g_return_if_fail (menu != NULL);
1110 g_return_if_fail (x != NULL);
1111 g_return_if_fail (y != NULL);
1113 menu_item = GTK_MENU_ITEM (user_data);
1114 widget = GTK_WIDGET (user_data);
1119 direction = gtk_widget_get_direction (widget);
1121 twidth = GTK_WIDGET (menu)->requisition.width;
1122 theight = GTK_WIDGET (menu)->requisition.height;
1124 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
1125 monitor_num = gdk_screen_get_monitor_at_window (screen, menu_item->event_window);
1126 if (monitor_num < 0)
1128 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
1130 if (!gdk_window_get_origin (widget->window, &tx, &ty))
1132 g_warning ("Menu not on screen");
1136 tx += widget->allocation.x;
1137 ty += widget->allocation.y;
1139 get_offsets (menu, &horizontal_offset, &vertical_offset);
1141 if (GTK_IS_MENU_BAR (widget->parent))
1143 menu_item->from_menubar = TRUE;
1145 else if (GTK_IS_MENU (widget->parent))
1147 if (GTK_MENU (widget->parent)->parent_menu_item)
1148 menu_item->from_menubar = GTK_MENU_ITEM (GTK_MENU (widget->parent)->parent_menu_item)->from_menubar;
1150 menu_item->from_menubar = FALSE;
1154 menu_item->from_menubar = FALSE;
1157 switch (menu_item->submenu_placement)
1159 case GTK_TOP_BOTTOM:
1160 if (direction == GTK_TEXT_DIR_LTR)
1161 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
1164 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
1165 tx += widget->allocation.width - twidth;
1167 if ((ty + widget->allocation.height + theight) <= monitor.y + monitor.height)
1168 ty += widget->allocation.height;
1169 else if ((ty - theight) >= monitor.y)
1171 else if (monitor.y + monitor.height - (ty + widget->allocation.height) > ty)
1172 ty += widget->allocation.height;
1177 case GTK_LEFT_RIGHT:
1178 if (GTK_IS_MENU (widget->parent))
1179 parent_menu_item = GTK_MENU_ITEM (GTK_MENU (widget->parent)->parent_menu_item);
1181 parent_menu_item = NULL;
1183 parent_xthickness = widget->parent->style->xthickness;
1185 if (parent_menu_item && !GTK_MENU (widget->parent)->torn_off)
1187 menu_item->submenu_direction = parent_menu_item->submenu_direction;
1191 if (direction == GTK_TEXT_DIR_LTR)
1192 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
1194 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
1197 switch (menu_item->submenu_direction)
1199 case GTK_DIRECTION_LEFT:
1200 if ((tx - twidth - parent_xthickness - horizontal_offset) >= monitor.x)
1201 tx -= twidth + parent_xthickness + horizontal_offset;
1204 menu_item->submenu_direction = GTK_DIRECTION_RIGHT;
1205 tx += widget->allocation.width + parent_xthickness + horizontal_offset;
1209 case GTK_DIRECTION_RIGHT:
1210 if ((tx + widget->allocation.width + parent_xthickness + horizontal_offset + twidth) <= monitor.x + monitor.width)
1211 tx += widget->allocation.width + parent_xthickness + horizontal_offset;
1214 menu_item->submenu_direction = GTK_DIRECTION_LEFT;
1215 tx -= twidth + parent_xthickness + horizontal_offset;
1220 ty += vertical_offset;
1222 /* If the height of the menu doesn't fit we move it upward. */
1223 ty = CLAMP (ty, monitor.y, MAX (monitor.y, monitor.y + monitor.height - theight));
1227 /* If we have negative, tx, here it is because we can't get
1228 * the menu all the way on screen. Favor the left portion.
1230 *x = CLAMP (tx, monitor.x, MAX (monitor.x, monitor.x + monitor.width - twidth));
1233 gtk_menu_set_monitor (menu, monitor_num);
1235 if (!GTK_WIDGET_VISIBLE (menu->toplevel))
1237 gtk_window_set_type_hint (GTK_WINDOW (menu->toplevel), menu_item->from_menubar?
1238 GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU : GDK_WINDOW_TYPE_HINT_POPUP_MENU);
1243 * gtk_menu_item_set_right_justified:
1244 * @menu_item: a #GtkMenuItem.
1245 * @right_justified: if %TRUE the menu item will appear at the
1246 * far right if added to a menu bar.
1248 * Sets whether the menu item appears justified at the right
1249 * side of a menu bar. This was traditionally done for "Help" menu
1250 * items, but is now considered a bad idea. (If the widget
1251 * layout is reversed for a right-to-left language like Hebrew
1252 * or Arabic, right-justified-menu-items appear at the left.)
1255 gtk_menu_item_set_right_justified (GtkMenuItem *menu_item,
1256 gboolean right_justified)
1258 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1260 right_justified = right_justified != FALSE;
1262 if (right_justified != menu_item->right_justify)
1264 menu_item->right_justify = right_justified;
1265 gtk_widget_queue_resize (GTK_WIDGET (menu_item));
1270 * gtk_menu_item_get_right_justified:
1271 * @menu_item: a #GtkMenuItem
1273 * Gets whether the menu item appears justified at the right
1274 * side of the menu bar.
1276 * Return value: %TRUE if the menu item will appear at the
1277 * far right if added to a menu bar.
1280 gtk_menu_item_get_right_justified (GtkMenuItem *menu_item)
1282 g_return_val_if_fail (GTK_IS_MENU_ITEM (menu_item), FALSE);
1284 return menu_item->right_justify;
1289 gtk_menu_item_show_all (GtkWidget *widget)
1291 GtkMenuItem *menu_item;
1293 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1295 menu_item = GTK_MENU_ITEM (widget);
1297 /* show children including submenu */
1298 if (menu_item->submenu)
1299 gtk_widget_show_all (menu_item->submenu);
1300 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
1302 gtk_widget_show (widget);
1306 gtk_menu_item_hide_all (GtkWidget *widget)
1308 GtkMenuItem *menu_item;
1310 g_return_if_fail (GTK_IS_MENU_ITEM (widget));
1312 gtk_widget_hide (widget);
1314 menu_item = GTK_MENU_ITEM (widget);
1316 /* hide children including submenu */
1317 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_hide_all, NULL);
1318 if (menu_item->submenu)
1319 gtk_widget_hide_all (menu_item->submenu);
1323 gtk_menu_item_can_activate_accel (GtkWidget *widget,
1326 /* Chain to the parent GtkMenu for further checks */
1327 return (GTK_WIDGET_IS_SENSITIVE (widget) && GTK_WIDGET_VISIBLE (widget) &&
1328 widget->parent && gtk_widget_can_activate_accel (widget->parent, signal_id));
1332 gtk_menu_item_accel_name_foreach (GtkWidget *widget,
1335 const gchar **path_p = data;
1339 if (GTK_IS_LABEL (widget))
1341 *path_p = gtk_label_get_text (GTK_LABEL (widget));
1342 if (*path_p && (*path_p)[0] == 0)
1345 else if (GTK_IS_CONTAINER (widget))
1346 gtk_container_foreach (GTK_CONTAINER (widget),
1347 gtk_menu_item_accel_name_foreach,
1353 gtk_menu_item_parent_set (GtkWidget *widget,
1354 GtkWidget *previous_parent)
1356 GtkMenuItem *menu_item = GTK_MENU_ITEM (widget);
1357 GtkMenu *menu = GTK_IS_MENU (widget->parent) ? GTK_MENU (widget->parent) : NULL;
1360 _gtk_menu_item_refresh_accel_path (menu_item,
1365 if (GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->parent_set)
1366 GTK_WIDGET_CLASS (gtk_menu_item_parent_class)->parent_set (widget, previous_parent);
1370 _gtk_menu_item_refresh_accel_path (GtkMenuItem *menu_item,
1371 const gchar *prefix,
1372 GtkAccelGroup *accel_group,
1373 gboolean group_changed)
1378 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1379 g_return_if_fail (!accel_group || GTK_IS_ACCEL_GROUP (accel_group));
1381 widget = GTK_WIDGET (menu_item);
1385 gtk_widget_set_accel_path (widget, NULL, NULL);
1389 path = _gtk_widget_get_accel_path (widget, NULL);
1390 if (!path) /* no active accel_path yet */
1392 path = menu_item->accel_path;
1393 if (!path && prefix)
1395 gchar *postfix = NULL;
1397 /* try to construct one from label text */
1398 gtk_container_foreach (GTK_CONTAINER (menu_item),
1399 gtk_menu_item_accel_name_foreach,
1401 menu_item->accel_path = postfix ? g_strconcat (prefix, "/", postfix, NULL) : NULL;
1402 path = menu_item->accel_path;
1405 gtk_widget_set_accel_path (widget, path, accel_group);
1407 else if (group_changed) /* reinstall accelerators */
1408 gtk_widget_set_accel_path (widget, path, accel_group);
1412 * gtk_menu_item_set_accel_path
1413 * @menu_item: a valid #GtkMenuItem
1414 * @accel_path: accelerator path, corresponding to this menu item's
1415 * functionality, or %NULL to unset the current path.
1417 * Set the accelerator path on @menu_item, through which runtime changes of the
1418 * menu item's accelerator caused by the user can be identified and saved to
1419 * persistant storage (see gtk_accel_map_save() on this).
1420 * To setup a default accelerator for this menu item, call
1421 * gtk_accel_map_add_entry() with the same @accel_path.
1422 * See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
1423 * and gtk_menu_set_accel_path() for a more convenient variant of this function.
1425 * This function is basically a convenience wrapper that handles calling
1426 * gtk_widget_set_accel_path() with the appropriate accelerator group for
1429 * Note that you do need to set an accelerator on the parent menu with
1430 * gtk_menu_set_accel_group() for this to work.
1433 gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,
1434 const gchar *accel_path)
1438 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1439 g_return_if_fail (accel_path == NULL ||
1440 (accel_path[0] == '<' && strchr (accel_path, '/')));
1442 widget = GTK_WIDGET (menu_item);
1444 /* store new path */
1445 g_free (menu_item->accel_path);
1446 menu_item->accel_path = g_strdup (accel_path);
1448 /* forget accelerators associated with old path */
1449 gtk_widget_set_accel_path (widget, NULL, NULL);
1451 /* install accelerators associated with new path */
1452 if (widget->parent && GTK_IS_MENU (widget->parent))
1454 GtkMenu *menu = GTK_MENU (widget->parent);
1456 if (menu->accel_group)
1457 _gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
1465 gtk_menu_item_forall (GtkContainer *container,
1466 gboolean include_internals,
1467 GtkCallback callback,
1468 gpointer callback_data)
1472 g_return_if_fail (GTK_IS_MENU_ITEM (container));
1473 g_return_if_fail (callback != NULL);
1475 bin = GTK_BIN (container);
1478 callback (bin->child, callback_data);
1482 _gtk_menu_item_is_selectable (GtkWidget *menu_item)
1484 if ((!GTK_BIN (menu_item)->child &&
1485 G_OBJECT_TYPE (menu_item) == GTK_TYPE_MENU_ITEM) ||
1486 GTK_IS_SEPARATOR_MENU_ITEM (menu_item) ||
1487 !GTK_WIDGET_IS_SENSITIVE (menu_item) ||
1488 !GTK_WIDGET_VISIBLE (menu_item))
1494 #define __GTK_MENU_ITEM_C__
1495 #include "gtkaliasdef.c"