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/.
29 * @Short_description: A menu widget
32 * A #GtkMenu is a #GtkMenuShell that implements a drop down menu
33 * consisting of a list of #GtkMenuItem objects which can be navigated
34 * and activated by the user to perform application functions.
36 * A #GtkMenu is most commonly dropped down by activating a
37 * #GtkMenuItem in a #GtkMenuBar or popped up by activating a
38 * #GtkMenuItem in another #GtkMenu.
40 * A #GtkMenu can also be popped up by activating a #GtkOptionMenu.
41 * Other composite widgets such as the #GtkNotebook can pop up a
44 * Applications can display a #GtkMenu as a popup menu by calling the
45 * gtk_menu_popup() function. The example below shows how an application
46 * can pop up a menu when the 3rd mouse button is pressed.
49 * <title>Connecting the popup signal handler.</title>
51 * /<!---->* connect our handler which will popup the menu *<!---->/
52 * g_signal_connect_swapped (window, "button_press_event",
53 * G_CALLBACK (my_popup_handler), menu);
58 * <title>Signal handler which displays a popup menu.</title>
61 * my_popup_handler (GtkWidget *widget, GdkEvent *event)
64 * GdkEventButton *event_button;
66 * g_return_val_if_fail (widget != NULL, FALSE);
67 * g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
68 * g_return_val_if_fail (event != NULL, FALSE);
70 * /<!---->* The "widget" is the menu that was supplied when
71 * * g_signal_connect_swapped() was called.
73 * menu = GTK_MENU (widget);
75 * if (event->type == GDK_BUTTON_PRESS)
77 * event_button = (GdkEventButton *) event;
78 * if (event_button->button == 3)
80 * gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
81 * event_button->button, event_button->time);
96 #include <gobject/gvaluecollector.h>
98 #include "gtkaccellabel.h"
99 #include "gtkaccelmap.h"
100 #include "gtkbindings.h"
101 #include "gtkcheckmenuitem.h"
103 #include "gtkmarshalers.h"
104 #include "gtkmenuprivate.h"
105 #include "gtkmenuitemprivate.h"
106 #include "gtkmenushellprivate.h"
107 #include "gtktearoffmenuitem.h"
108 #include "gtkwindow.h"
110 #include "gtkvscrollbar.h"
111 #include "gtksettings.h"
112 #include "gtkprivate.h"
114 #include "gtktypebuiltins.h"
116 #define NAVIGATION_REGION_OVERSHOOT 50 /* How much the navigation region
117 * extends below the submenu
120 #define MENU_SCROLL_STEP1 8
121 #define MENU_SCROLL_STEP2 15
122 #define MENU_SCROLL_FAST_ZONE 8
123 #define MENU_SCROLL_TIMEOUT1 50
124 #define MENU_SCROLL_TIMEOUT2 20
126 #define ATTACH_INFO_KEY "gtk-menu-child-attach-info-key"
127 #define ATTACHED_MENUS "gtk-attached-menus"
129 typedef struct _GtkMenuAttachData GtkMenuAttachData;
130 typedef struct _GtkMenuPopdownData GtkMenuPopdownData;
132 struct _GtkMenuAttachData
134 GtkWidget *attach_widget;
135 GtkMenuDetachFunc detacher;
138 struct _OldGtkMenuPrivate
142 gboolean initially_pushed_in;
144 GDestroyNotify position_func_data_destroy;
146 /* info used for the table */
149 gint requested_height;
153 /* Cached layout information */
162 GtkStateFlags lower_arrow_state;
163 GtkStateFlags upper_arrow_state;
165 /* navigation region */
168 int navigation_width;
169 int navigation_height;
171 guint have_layout : 1;
172 guint seen_item_enter : 1;
173 guint have_position : 1;
174 guint ignore_button_release : 1;
175 guint no_toggle_size : 1;
178 struct _GtkMenuPopdownData
190 gint effective_left_attach;
191 gint effective_right_attach;
192 gint effective_top_attach;
193 gint effective_bottom_attach;
210 PROP_RESERVE_TOGGLE_SIZE
215 CHILD_PROP_LEFT_ATTACH,
216 CHILD_PROP_RIGHT_ATTACH,
217 CHILD_PROP_TOP_ATTACH,
218 CHILD_PROP_BOTTOM_ATTACH
221 static void gtk_menu_set_property (GObject *object,
225 static void gtk_menu_get_property (GObject *object,
229 static void gtk_menu_set_child_property(GtkContainer *container,
234 static void gtk_menu_get_child_property(GtkContainer *container,
239 static void gtk_menu_destroy (GtkWidget *widget);
240 static void gtk_menu_realize (GtkWidget *widget);
241 static void gtk_menu_unrealize (GtkWidget *widget);
242 static void gtk_menu_size_allocate (GtkWidget *widget,
243 GtkAllocation *allocation);
244 static void gtk_menu_show (GtkWidget *widget);
245 static gboolean gtk_menu_draw (GtkWidget *widget,
247 static gboolean gtk_menu_key_press (GtkWidget *widget,
249 static gboolean gtk_menu_scroll (GtkWidget *widget,
250 GdkEventScroll *event);
251 static gboolean gtk_menu_button_press (GtkWidget *widget,
252 GdkEventButton *event);
253 static gboolean gtk_menu_button_release (GtkWidget *widget,
254 GdkEventButton *event);
255 static gboolean gtk_menu_motion_notify (GtkWidget *widget,
256 GdkEventMotion *event);
257 static gboolean gtk_menu_enter_notify (GtkWidget *widget,
258 GdkEventCrossing *event);
259 static gboolean gtk_menu_leave_notify (GtkWidget *widget,
260 GdkEventCrossing *event);
261 static void gtk_menu_scroll_to (GtkMenu *menu,
263 static void gtk_menu_grab_notify (GtkWidget *widget,
264 gboolean was_grabbed);
266 static void gtk_menu_stop_scrolling (GtkMenu *menu);
267 static void gtk_menu_remove_scroll_timeout (GtkMenu *menu);
268 static gboolean gtk_menu_scroll_timeout (gpointer data);
269 static gboolean gtk_menu_scroll_timeout_initial (gpointer data);
270 static void gtk_menu_start_scrolling (GtkMenu *menu);
272 static void gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
273 GtkWidget *menu_item);
274 static void gtk_menu_select_item (GtkMenuShell *menu_shell,
275 GtkWidget *menu_item);
276 static void gtk_menu_real_insert (GtkMenuShell *menu_shell,
279 static void gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
281 static void gtk_menu_handle_scrolling (GtkMenu *menu,
286 static void gtk_menu_set_tearoff_hints (GtkMenu *menu,
288 static void gtk_menu_style_updated (GtkWidget *widget);
289 static gboolean gtk_menu_focus (GtkWidget *widget,
290 GtkDirectionType direction);
291 static gint gtk_menu_get_popup_delay (GtkMenuShell *menu_shell);
292 static void gtk_menu_move_current (GtkMenuShell *menu_shell,
293 GtkMenuDirectionType direction);
294 static void gtk_menu_real_move_scroll (GtkMenu *menu,
297 static void gtk_menu_stop_navigating_submenu (GtkMenu *menu);
298 static gboolean gtk_menu_stop_navigating_submenu_cb (gpointer user_data);
299 static gboolean gtk_menu_navigating_submenu (GtkMenu *menu,
302 static void gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
303 GtkMenuItem *menu_item,
304 GdkEventCrossing *event);
306 static void gtk_menu_deactivate (GtkMenuShell *menu_shell);
307 static void gtk_menu_show_all (GtkWidget *widget);
308 static void gtk_menu_position (GtkMenu *menu,
309 gboolean set_scroll_offset);
310 static void gtk_menu_reparent (GtkMenu *menu,
311 GtkWidget *new_parent,
313 static void gtk_menu_remove (GtkContainer *menu,
316 static void gtk_menu_update_title (GtkMenu *menu);
318 static void menu_grab_transfer_window_destroy (GtkMenu *menu);
319 static GdkWindow *menu_grab_transfer_window_get (GtkMenu *menu);
321 static gboolean gtk_menu_real_can_activate_accel (GtkWidget *widget,
323 static void _gtk_menu_refresh_accel_paths (GtkMenu *menu,
324 gboolean group_changed);
326 static void gtk_menu_get_preferred_width (GtkWidget *widget,
329 static void gtk_menu_get_preferred_height (GtkWidget *widget,
332 static void gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
338 static const gchar attach_data_key[] = "gtk-menu-attach-data";
340 static guint menu_signals[LAST_SIGNAL] = { 0 };
342 G_DEFINE_TYPE (GtkMenu, gtk_menu, GTK_TYPE_MENU_SHELL)
345 menu_queue_resize (GtkMenu *menu)
347 GtkMenuPrivate *priv = menu->priv;
349 priv->have_layout = FALSE;
350 gtk_widget_queue_resize (GTK_WIDGET (menu));
354 attach_info_free (AttachInfo *info)
356 g_slice_free (AttachInfo, info);
360 get_attach_info (GtkWidget *child)
362 GObject *object = G_OBJECT (child);
363 AttachInfo *ai = g_object_get_data (object, ATTACH_INFO_KEY);
367 ai = g_slice_new0 (AttachInfo);
368 g_object_set_data_full (object, I_(ATTACH_INFO_KEY), ai,
369 (GDestroyNotify) attach_info_free);
376 is_grid_attached (AttachInfo *ai)
378 return (ai->left_attach >= 0 &&
379 ai->right_attach >= 0 &&
380 ai->top_attach >= 0 &&
381 ai->bottom_attach >= 0);
385 menu_ensure_layout (GtkMenu *menu)
387 GtkMenuPrivate *priv = menu->priv;
389 if (!priv->have_layout)
391 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
395 gint max_right_attach;
396 gint max_bottom_attach;
398 /* Find extents of gridded portion
400 max_right_attach = 1;
401 max_bottom_attach = 0;
403 for (l = menu_shell->priv->children; l; l = l->next)
405 GtkWidget *child = l->data;
406 AttachInfo *ai = get_attach_info (child);
408 if (is_grid_attached (ai))
410 max_bottom_attach = MAX (max_bottom_attach, ai->bottom_attach);
411 max_right_attach = MAX (max_right_attach, ai->right_attach);
415 /* Find empty rows */
416 row_occupied = g_malloc0 (max_bottom_attach);
418 for (l = menu_shell->priv->children; l; l = l->next)
420 GtkWidget *child = l->data;
421 AttachInfo *ai = get_attach_info (child);
423 if (is_grid_attached (ai))
427 for (i = ai->top_attach; i < ai->bottom_attach; i++)
428 row_occupied[i] = TRUE;
432 /* Lay non-grid-items out in those rows
435 for (l = menu_shell->priv->children; l; l = l->next)
437 GtkWidget *child = l->data;
438 AttachInfo *ai = get_attach_info (child);
440 if (!is_grid_attached (ai))
442 while (current_row < max_bottom_attach && row_occupied[current_row])
445 ai->effective_left_attach = 0;
446 ai->effective_right_attach = max_right_attach;
447 ai->effective_top_attach = current_row;
448 ai->effective_bottom_attach = current_row + 1;
454 ai->effective_left_attach = ai->left_attach;
455 ai->effective_right_attach = ai->right_attach;
456 ai->effective_top_attach = ai->top_attach;
457 ai->effective_bottom_attach = ai->bottom_attach;
461 g_free (row_occupied);
463 priv->n_rows = MAX (current_row, max_bottom_attach);
464 priv->n_columns = max_right_attach;
465 priv->have_layout = TRUE;
471 gtk_menu_get_n_columns (GtkMenu *menu)
473 GtkMenuPrivate *priv = menu->priv;
475 menu_ensure_layout (menu);
477 return priv->n_columns;
481 gtk_menu_get_n_rows (GtkMenu *menu)
483 GtkMenuPrivate *priv = menu->priv;
485 menu_ensure_layout (menu);
491 get_effective_child_attach (GtkWidget *child,
497 GtkMenu *menu = GTK_MENU (gtk_widget_get_parent (child));
500 menu_ensure_layout (menu);
502 ai = get_attach_info (child);
505 *l = ai->effective_left_attach;
507 *r = ai->effective_right_attach;
509 *t = ai->effective_top_attach;
511 *b = ai->effective_bottom_attach;
516 gtk_menu_class_init (GtkMenuClass *class)
518 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
519 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
520 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
521 GtkMenuShellClass *menu_shell_class = GTK_MENU_SHELL_CLASS (class);
522 GtkBindingSet *binding_set;
524 gobject_class->set_property = gtk_menu_set_property;
525 gobject_class->get_property = gtk_menu_get_property;
527 widget_class->destroy = gtk_menu_destroy;
528 widget_class->realize = gtk_menu_realize;
529 widget_class->unrealize = gtk_menu_unrealize;
530 widget_class->size_allocate = gtk_menu_size_allocate;
531 widget_class->show = gtk_menu_show;
532 widget_class->draw = gtk_menu_draw;
533 widget_class->scroll_event = gtk_menu_scroll;
534 widget_class->key_press_event = gtk_menu_key_press;
535 widget_class->button_press_event = gtk_menu_button_press;
536 widget_class->button_release_event = gtk_menu_button_release;
537 widget_class->motion_notify_event = gtk_menu_motion_notify;
538 widget_class->show_all = gtk_menu_show_all;
539 widget_class->enter_notify_event = gtk_menu_enter_notify;
540 widget_class->leave_notify_event = gtk_menu_leave_notify;
541 widget_class->style_updated = gtk_menu_style_updated;
542 widget_class->focus = gtk_menu_focus;
543 widget_class->can_activate_accel = gtk_menu_real_can_activate_accel;
544 widget_class->grab_notify = gtk_menu_grab_notify;
545 widget_class->get_preferred_width = gtk_menu_get_preferred_width;
546 widget_class->get_preferred_height = gtk_menu_get_preferred_height;
547 widget_class->get_preferred_height_for_width = gtk_menu_get_preferred_height_for_width;
549 container_class->remove = gtk_menu_remove;
550 container_class->get_child_property = gtk_menu_get_child_property;
551 container_class->set_child_property = gtk_menu_set_child_property;
553 menu_shell_class->submenu_placement = GTK_LEFT_RIGHT;
554 menu_shell_class->deactivate = gtk_menu_deactivate;
555 menu_shell_class->select_item = gtk_menu_select_item;
556 menu_shell_class->insert = gtk_menu_real_insert;
557 menu_shell_class->get_popup_delay = gtk_menu_get_popup_delay;
558 menu_shell_class->move_current = gtk_menu_move_current;
561 * GtkMenu::move-scroll:
563 * @scroll_type: a #GtkScrollType
565 menu_signals[MOVE_SCROLL] =
566 g_signal_new_class_handler (I_("move-scroll"),
567 G_OBJECT_CLASS_TYPE (gobject_class),
568 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
569 G_CALLBACK (gtk_menu_real_move_scroll),
571 _gtk_marshal_VOID__ENUM,
573 GTK_TYPE_SCROLL_TYPE);
578 * The index of the currently selected menu item, or -1 if no
579 * menu item is selected.
583 g_object_class_install_property (gobject_class,
585 g_param_spec_int ("active",
587 P_("The currently selected menu item"),
589 GTK_PARAM_READWRITE));
592 * GtkMenu:accel-group:
594 * The accel group holding accelerators for the menu.
598 g_object_class_install_property (gobject_class,
600 g_param_spec_object ("accel-group",
602 P_("The accel group holding accelerators for the menu"),
603 GTK_TYPE_ACCEL_GROUP,
604 GTK_PARAM_READWRITE));
607 * GtkMenu:accel-path:
609 * An accel path used to conveniently construct accel paths of child items.
613 g_object_class_install_property (gobject_class,
615 g_param_spec_string ("accel-path",
617 P_("An accel path used to conveniently construct accel paths of child items"),
619 GTK_PARAM_READWRITE));
622 * GtkMenu:attach-widget:
624 * The widget the menu is attached to. Setting this property attaches
625 * the menu without a #GtkMenuDetachFunc. If you need to use a detacher,
626 * use gtk_menu_attach_to_widget() directly.
630 g_object_class_install_property (gobject_class,
632 g_param_spec_object ("attach-widget",
634 P_("The widget the menu is attached to"),
636 GTK_PARAM_READWRITE));
638 g_object_class_install_property (gobject_class,
640 g_param_spec_string ("tearoff-title",
642 P_("A title that may be displayed by the window manager when this menu is torn-off"),
644 GTK_PARAM_READWRITE));
647 * GtkMenu:tearoff-state:
649 * A boolean that indicates whether the menu is torn-off.
653 g_object_class_install_property (gobject_class,
655 g_param_spec_boolean ("tearoff-state",
657 P_("A boolean that indicates whether the menu is torn-off"),
659 GTK_PARAM_READWRITE));
664 * The monitor the menu will be popped up on.
668 g_object_class_install_property (gobject_class,
670 g_param_spec_int ("monitor",
672 P_("The monitor the menu will be popped up on"),
674 GTK_PARAM_READWRITE));
676 gtk_widget_class_install_style_property (widget_class,
677 g_param_spec_int ("vertical-padding",
678 P_("Vertical Padding"),
679 P_("Extra space at the top and bottom of the menu"),
683 GTK_PARAM_READABLE));
686 * GtkMenu:reserve-toggle-size:
688 * A boolean that indicates whether the menu reserves space for
689 * toggles and icons, regardless of their actual presence.
691 * This property should only be changed from its default value
692 * for special-purposes such as tabular menus. Regular menus that
693 * are connected to a menu bar or context menus should reserve
694 * toggle space for consistency.
698 g_object_class_install_property (gobject_class,
699 PROP_RESERVE_TOGGLE_SIZE,
700 g_param_spec_boolean ("reserve-toggle-size",
701 P_("Reserve Toggle Size"),
702 P_("A boolean that indicates whether the menu reserves space for toggles and icons"),
704 GTK_PARAM_READWRITE));
706 gtk_widget_class_install_style_property (widget_class,
707 g_param_spec_int ("horizontal-padding",
708 P_("Horizontal Padding"),
709 P_("Extra space at the left and right edges of the menu"),
713 GTK_PARAM_READABLE));
715 gtk_widget_class_install_style_property (widget_class,
716 g_param_spec_int ("vertical-offset",
717 P_("Vertical Offset"),
718 P_("When the menu is a submenu, position it this number of pixels offset vertically"),
722 GTK_PARAM_READABLE));
724 gtk_widget_class_install_style_property (widget_class,
725 g_param_spec_int ("horizontal-offset",
726 P_("Horizontal Offset"),
727 P_("When the menu is a submenu, position it this number of pixels offset horizontally"),
731 GTK_PARAM_READABLE));
733 gtk_widget_class_install_style_property (widget_class,
734 g_param_spec_boolean ("double-arrows",
736 P_("When scrolling, always show both arrows."),
738 GTK_PARAM_READABLE));
741 * GtkMenu:arrow-placement:
743 * Indicates where scroll arrows should be placed.
747 gtk_widget_class_install_style_property (widget_class,
748 g_param_spec_enum ("arrow-placement",
749 P_("Arrow Placement"),
750 P_("Indicates where scroll arrows should be placed"),
751 GTK_TYPE_ARROW_PLACEMENT,
753 GTK_PARAM_READABLE));
755 gtk_container_class_install_child_property (container_class,
756 CHILD_PROP_LEFT_ATTACH,
757 g_param_spec_int ("left-attach",
759 P_("The column number to attach the left side of the child to"),
761 GTK_PARAM_READWRITE));
763 gtk_container_class_install_child_property (container_class,
764 CHILD_PROP_RIGHT_ATTACH,
765 g_param_spec_int ("right-attach",
767 P_("The column number to attach the right side of the child to"),
769 GTK_PARAM_READWRITE));
771 gtk_container_class_install_child_property (container_class,
772 CHILD_PROP_TOP_ATTACH,
773 g_param_spec_int ("top-attach",
775 P_("The row number to attach the top of the child to"),
777 GTK_PARAM_READWRITE));
779 gtk_container_class_install_child_property (container_class,
780 CHILD_PROP_BOTTOM_ATTACH,
781 g_param_spec_int ("bottom-attach",
783 P_("The row number to attach the bottom of the child to"),
785 GTK_PARAM_READWRITE));
788 * GtkMenu:arrow-scaling
790 * Arbitrary constant to scale down the size of the scroll arrow.
794 gtk_widget_class_install_style_property (widget_class,
795 g_param_spec_float ("arrow-scaling",
797 P_("Arbitrary constant to scale down the size of the scroll arrow"),
799 GTK_PARAM_READABLE));
801 binding_set = gtk_binding_set_by_class (class);
802 gtk_binding_entry_add_signal (binding_set,
804 I_("move-current"), 1,
805 GTK_TYPE_MENU_DIRECTION_TYPE,
807 gtk_binding_entry_add_signal (binding_set,
810 GTK_TYPE_MENU_DIRECTION_TYPE,
812 gtk_binding_entry_add_signal (binding_set,
815 GTK_TYPE_MENU_DIRECTION_TYPE,
817 gtk_binding_entry_add_signal (binding_set,
820 GTK_TYPE_MENU_DIRECTION_TYPE,
822 gtk_binding_entry_add_signal (binding_set,
825 GTK_TYPE_MENU_DIRECTION_TYPE,
826 GTK_MENU_DIR_PARENT);
827 gtk_binding_entry_add_signal (binding_set,
830 GTK_TYPE_MENU_DIRECTION_TYPE,
831 GTK_MENU_DIR_PARENT);
832 gtk_binding_entry_add_signal (binding_set,
835 GTK_TYPE_MENU_DIRECTION_TYPE,
837 gtk_binding_entry_add_signal (binding_set,
840 GTK_TYPE_MENU_DIRECTION_TYPE,
842 gtk_binding_entry_add_signal (binding_set,
845 GTK_TYPE_SCROLL_TYPE,
847 gtk_binding_entry_add_signal (binding_set,
850 GTK_TYPE_SCROLL_TYPE,
852 gtk_binding_entry_add_signal (binding_set,
855 GTK_TYPE_SCROLL_TYPE,
857 gtk_binding_entry_add_signal (binding_set,
860 GTK_TYPE_SCROLL_TYPE,
862 gtk_binding_entry_add_signal (binding_set,
865 GTK_TYPE_SCROLL_TYPE,
867 gtk_binding_entry_add_signal (binding_set,
868 GDK_KEY_KP_Page_Up, 0,
870 GTK_TYPE_SCROLL_TYPE,
872 gtk_binding_entry_add_signal (binding_set,
873 GDK_KEY_Page_Down, 0,
875 GTK_TYPE_SCROLL_TYPE,
876 GTK_SCROLL_PAGE_DOWN);
877 gtk_binding_entry_add_signal (binding_set,
878 GDK_KEY_KP_Page_Down, 0,
880 GTK_TYPE_SCROLL_TYPE,
881 GTK_SCROLL_PAGE_DOWN);
883 g_type_class_add_private (gobject_class, sizeof (GtkMenuPrivate));
888 gtk_menu_set_property (GObject *object,
893 GtkMenu *menu = GTK_MENU (object);
898 gtk_menu_set_active (menu, g_value_get_int (value));
900 case PROP_ACCEL_GROUP:
901 gtk_menu_set_accel_group (menu, g_value_get_object (value));
903 case PROP_ACCEL_PATH:
904 gtk_menu_set_accel_path (menu, g_value_get_string (value));
906 case PROP_ATTACH_WIDGET:
910 widget = gtk_menu_get_attach_widget (menu);
912 gtk_menu_detach (menu);
914 widget = (GtkWidget*) g_value_get_object (value);
916 gtk_menu_attach_to_widget (menu, widget, NULL);
919 case PROP_TEAROFF_STATE:
920 gtk_menu_set_tearoff_state (menu, g_value_get_boolean (value));
922 case PROP_TEAROFF_TITLE:
923 gtk_menu_set_title (menu, g_value_get_string (value));
926 gtk_menu_set_monitor (menu, g_value_get_int (value));
928 case PROP_RESERVE_TOGGLE_SIZE:
929 gtk_menu_set_reserve_toggle_size (menu, g_value_get_boolean (value));
932 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
938 gtk_menu_get_property (GObject *object,
943 GtkMenu *menu = GTK_MENU (object);
948 g_value_set_int (value, g_list_index (GTK_MENU_SHELL (menu)->priv->children, gtk_menu_get_active (menu)));
950 case PROP_ACCEL_GROUP:
951 g_value_set_object (value, gtk_menu_get_accel_group (menu));
953 case PROP_ACCEL_PATH:
954 g_value_set_string (value, gtk_menu_get_accel_path (menu));
956 case PROP_ATTACH_WIDGET:
957 g_value_set_object (value, gtk_menu_get_attach_widget (menu));
959 case PROP_TEAROFF_STATE:
960 g_value_set_boolean (value, gtk_menu_get_tearoff_state (menu));
962 case PROP_TEAROFF_TITLE:
963 g_value_set_string (value, gtk_menu_get_title (menu));
966 g_value_set_int (value, gtk_menu_get_monitor (menu));
968 case PROP_RESERVE_TOGGLE_SIZE:
969 g_value_set_boolean (value, gtk_menu_get_reserve_toggle_size (menu));
972 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
978 gtk_menu_set_child_property (GtkContainer *container,
984 GtkMenu *menu = GTK_MENU (container);
985 AttachInfo *ai = get_attach_info (child);
989 case CHILD_PROP_LEFT_ATTACH:
990 ai->left_attach = g_value_get_int (value);
992 case CHILD_PROP_RIGHT_ATTACH:
993 ai->right_attach = g_value_get_int (value);
995 case CHILD_PROP_TOP_ATTACH:
996 ai->top_attach = g_value_get_int (value);
998 case CHILD_PROP_BOTTOM_ATTACH:
999 ai->bottom_attach = g_value_get_int (value);
1003 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1007 menu_queue_resize (menu);
1011 gtk_menu_get_child_property (GtkContainer *container,
1017 AttachInfo *ai = get_attach_info (child);
1019 switch (property_id)
1021 case CHILD_PROP_LEFT_ATTACH:
1022 g_value_set_int (value, ai->left_attach);
1024 case CHILD_PROP_RIGHT_ATTACH:
1025 g_value_set_int (value, ai->right_attach);
1027 case CHILD_PROP_TOP_ATTACH:
1028 g_value_set_int (value, ai->top_attach);
1030 case CHILD_PROP_BOTTOM_ATTACH:
1031 g_value_set_int (value, ai->bottom_attach);
1035 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1041 gtk_menu_window_event (GtkWidget *window,
1045 gboolean handled = FALSE;
1047 g_object_ref (window);
1048 g_object_ref (menu);
1050 switch (event->type)
1053 case GDK_KEY_RELEASE:
1054 handled = gtk_widget_event (menu, event);
1060 g_object_unref (window);
1061 g_object_unref (menu);
1067 gtk_menu_init (GtkMenu *menu)
1069 GtkMenuPrivate *priv;
1070 GtkStyleContext *context;
1072 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu, GTK_TYPE_MENU, GtkMenuPrivate);
1076 priv->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
1077 "type", GTK_WINDOW_POPUP,
1080 "signal::event", gtk_menu_window_event, menu,
1081 "signal::destroy", gtk_widget_destroyed, &priv->toplevel,
1083 gtk_window_set_resizable (GTK_WINDOW (priv->toplevel), FALSE);
1084 gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->toplevel), 0);
1086 /* Refloat the menu, so that reference counting for the menu isn't
1087 * affected by it being a child of the toplevel
1089 g_object_force_floating (G_OBJECT (menu));
1090 priv->needs_destruction_ref = TRUE;
1092 priv->monitor_num = -1;
1094 context = gtk_widget_get_style_context (GTK_WIDGET (menu));
1095 gtk_style_context_add_class (context, GTK_STYLE_CLASS_MENU);
1099 gtk_menu_destroy (GtkWidget *widget)
1101 GtkMenu *menu = GTK_MENU (widget);
1102 GtkMenuPrivate *priv = menu->priv;
1103 GtkMenuAttachData *data;
1105 gtk_menu_remove_scroll_timeout (menu);
1107 data = g_object_get_data (G_OBJECT (widget), attach_data_key);
1109 gtk_menu_detach (menu);
1111 gtk_menu_stop_navigating_submenu (menu);
1113 if (priv->old_active_menu_item)
1114 g_clear_object (&priv->old_active_menu_item);
1116 /* Add back the reference count for being a child */
1117 if (priv->needs_destruction_ref)
1119 priv->needs_destruction_ref = FALSE;
1120 g_object_ref (widget);
1123 if (priv->accel_group)
1124 g_clear_object (&priv->accel_group);
1127 gtk_widget_destroy (priv->toplevel);
1129 if (priv->tearoff_window)
1130 gtk_widget_destroy (priv->tearoff_window);
1134 g_free (priv->heights);
1135 priv->heights = NULL;
1140 g_free (priv->title);
1144 if (priv->position_func_data_destroy)
1146 priv->position_func_data_destroy (priv->position_func_data);
1147 priv->position_func_data = NULL;
1148 priv->position_func_data_destroy = NULL;
1151 GTK_WIDGET_CLASS (gtk_menu_parent_class)->destroy (widget);
1155 menu_change_screen (GtkMenu *menu,
1156 GdkScreen *new_screen)
1158 GtkMenuPrivate *priv = menu->priv;
1160 if (gtk_widget_has_screen (GTK_WIDGET (menu)))
1162 if (new_screen == gtk_widget_get_screen (GTK_WIDGET (menu)))
1168 gtk_window_set_screen (GTK_WINDOW (priv->tearoff_window), new_screen);
1169 gtk_menu_position (menu, TRUE);
1172 gtk_window_set_screen (GTK_WINDOW (priv->toplevel), new_screen);
1173 priv->monitor_num = -1;
1177 attach_widget_screen_changed (GtkWidget *attach_widget,
1178 GdkScreen *previous_screen,
1181 if (gtk_widget_has_screen (attach_widget) &&
1182 !g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1183 menu_change_screen (menu, gtk_widget_get_screen (attach_widget));
1187 * gtk_menu_attach_to_widget:
1189 * @attach_widget: the #GtkWidget that the menu will be attached to
1190 * @detacher: (scope async)(allow-none): the user supplied callback function
1191 * that will be called when the menu calls gtk_menu_detach()
1193 * Attaches the menu to the widget and provides a callback function
1194 * that will be invoked when the menu calls gtk_menu_detach() during
1198 gtk_menu_attach_to_widget (GtkMenu *menu,
1199 GtkWidget *attach_widget,
1200 GtkMenuDetachFunc detacher)
1202 GtkMenuAttachData *data;
1205 g_return_if_fail (GTK_IS_MENU (menu));
1206 g_return_if_fail (GTK_IS_WIDGET (attach_widget));
1208 /* keep this function in sync with gtk_widget_set_parent() */
1209 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1212 g_warning ("gtk_menu_attach_to_widget(): menu already attached to %s",
1213 g_type_name (G_TYPE_FROM_INSTANCE (data->attach_widget)));
1217 g_object_ref_sink (menu);
1219 data = g_slice_new (GtkMenuAttachData);
1220 data->attach_widget = attach_widget;
1222 g_signal_connect (attach_widget, "screen-changed",
1223 G_CALLBACK (attach_widget_screen_changed), menu);
1224 attach_widget_screen_changed (attach_widget, NULL, menu);
1226 data->detacher = detacher;
1227 g_object_set_data (G_OBJECT (menu), I_(attach_data_key), data);
1228 list = g_object_steal_data (G_OBJECT (attach_widget), ATTACHED_MENUS);
1229 if (!g_list_find (list, menu))
1230 list = g_list_prepend (list, menu);
1232 g_object_set_data_full (G_OBJECT (attach_widget), I_(ATTACHED_MENUS), list,
1233 (GDestroyNotify) g_list_free);
1235 if (gtk_widget_get_state_flags (GTK_WIDGET (menu)) != 0)
1236 gtk_widget_set_state_flags (GTK_WIDGET (menu), 0, TRUE);
1238 /* we don't need to set the style here, since
1239 * we are a toplevel widget.
1242 /* Fallback title for menu comes from attach widget */
1243 gtk_menu_update_title (menu);
1245 g_object_notify (G_OBJECT (menu), "attach-widget");
1249 * gtk_menu_get_attach_widget:
1252 * Returns the #GtkWidget that the menu is attached to.
1254 * Returns: (transfer none): the #GtkWidget that the menu is attached to
1257 gtk_menu_get_attach_widget (GtkMenu *menu)
1259 GtkMenuAttachData *data;
1261 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1263 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1265 return data->attach_widget;
1273 * Detaches the menu from the widget to which it had been attached.
1274 * This function will call the callback function, @detacher, provided
1275 * when the gtk_menu_attach_to_widget() function was called.
1278 gtk_menu_detach (GtkMenu *menu)
1280 GtkMenuAttachData *data;
1283 g_return_if_fail (GTK_IS_MENU (menu));
1285 /* keep this function in sync with gtk_widget_unparent() */
1286 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1289 g_warning ("gtk_menu_detach(): menu is not attached");
1292 g_object_set_data (G_OBJECT (menu), I_(attach_data_key), NULL);
1294 g_signal_handlers_disconnect_by_func (data->attach_widget,
1295 (gpointer) attach_widget_screen_changed,
1299 data->detacher (data->attach_widget, menu);
1300 list = g_object_steal_data (G_OBJECT (data->attach_widget), ATTACHED_MENUS);
1301 list = g_list_remove (list, menu);
1303 g_object_set_data_full (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), list,
1304 (GDestroyNotify) g_list_free);
1306 g_object_set_data (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), NULL);
1308 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
1309 gtk_widget_unrealize (GTK_WIDGET (menu));
1311 g_slice_free (GtkMenuAttachData, data);
1313 /* Fallback title for menu comes from attach widget */
1314 gtk_menu_update_title (menu);
1316 g_object_unref (menu);
1320 gtk_menu_remove (GtkContainer *container,
1323 GtkMenu *menu = GTK_MENU (container);
1324 GtkMenuPrivate *priv = menu->priv;
1326 /* Clear out old_active_menu_item if it matches the item we are removing */
1327 if (priv->old_active_menu_item == widget)
1328 g_clear_object (&priv->old_active_menu_item);
1330 GTK_CONTAINER_CLASS (gtk_menu_parent_class)->remove (container, widget);
1332 g_object_set_data (G_OBJECT (widget), I_(ATTACH_INFO_KEY), NULL);
1334 menu_queue_resize (menu);
1340 * Creates a new #GtkMenu
1342 * Returns: a new #GtkMenu
1347 return g_object_new (GTK_TYPE_MENU, NULL);
1351 gtk_menu_real_insert (GtkMenuShell *menu_shell,
1355 GtkMenu *menu = GTK_MENU (menu_shell);
1356 GtkMenuPrivate *priv = menu->priv;
1357 AttachInfo *ai = get_attach_info (child);
1359 ai->left_attach = -1;
1360 ai->right_attach = -1;
1361 ai->top_attach = -1;
1362 ai->bottom_attach = -1;
1364 if (gtk_widget_get_realized (GTK_WIDGET (menu_shell)))
1365 gtk_widget_set_parent_window (child, priv->bin_window);
1367 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->insert (menu_shell, child, position);
1369 menu_queue_resize (menu);
1373 gtk_menu_tearoff_bg_copy (GtkMenu *menu)
1375 GtkMenuPrivate *priv = menu->priv;
1381 cairo_surface_t *surface;
1382 cairo_pattern_t *pattern;
1385 priv->tearoff_active = FALSE;
1386 priv->saved_scroll_offset = priv->scroll_offset;
1388 window = gtk_widget_get_window (priv->tearoff_window);
1389 width = gdk_window_get_width (window);
1390 height = gdk_window_get_height (window);
1392 surface = gdk_window_create_similar_surface (window,
1393 CAIRO_CONTENT_COLOR,
1397 cr = cairo_create (surface);
1398 gdk_cairo_set_source_window (cr, window, 0, 0);
1402 gtk_widget_set_size_request (priv->tearoff_window, width, height);
1404 pattern = cairo_pattern_create_for_surface (surface);
1405 gdk_window_set_background_pattern (window, pattern);
1407 cairo_pattern_destroy (pattern);
1408 cairo_surface_destroy (surface);
1413 popup_grab_on_window (GdkWindow *window,
1414 GdkDevice *keyboard,
1416 guint32 activate_time)
1419 gdk_device_grab (keyboard, window,
1420 GDK_OWNERSHIP_WINDOW, TRUE,
1421 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
1422 NULL, activate_time) != GDK_GRAB_SUCCESS)
1426 gdk_device_grab (pointer, window,
1427 GDK_OWNERSHIP_WINDOW, TRUE,
1428 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1429 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1430 GDK_POINTER_MOTION_MASK,
1431 NULL, activate_time) != GDK_GRAB_SUCCESS)
1434 gdk_device_ungrab (keyboard, activate_time);
1443 * gtk_menu_popup_for_device:
1445 * @device: (allow-none): a #GdkDevice
1446 * @parent_menu_shell: (allow-none): the menu shell containing the triggering
1447 * menu item, or %NULL
1448 * @parent_menu_item: (allow-none): the menu item whose activation triggered
1449 * the popup, or %NULL
1450 * @func: (allow-none): a user supplied function used to position the menu,
1452 * @data: (allow-none): user supplied data to be passed to @func
1453 * @destroy: (allow-none): destroy notify for @data
1454 * @button: the mouse button which was pressed to initiate the event
1455 * @activate_time: the time at which the activation event occurred
1457 * Displays a menu and makes it available for selection.
1459 * Applications can use this function to display context-sensitive menus,
1460 * and will typically supply %NULL for the @parent_menu_shell,
1461 * @parent_menu_item, @func, @data and @destroy parameters. The default
1462 * menu positioning function will position the menu at the current position
1463 * of @device (or its corresponding pointer).
1465 * The @button parameter should be the mouse button pressed to initiate
1466 * the menu popup. If the menu popup was initiated by something other than
1467 * a mouse button press, such as a mouse button release or a keypress,
1468 * @button should be 0.
1470 * The @activate_time parameter is used to conflict-resolve initiation of
1471 * concurrent requests for mouse/keyboard grab requests. To function
1472 * properly, this needs to be the time stamp of the user event (such as
1473 * a mouse click or key press) that caused the initiation of the popup.
1474 * Only if no such event is available, gtk_get_current_event_time() can
1480 gtk_menu_popup_for_device (GtkMenu *menu,
1482 GtkWidget *parent_menu_shell,
1483 GtkWidget *parent_menu_item,
1484 GtkMenuPositionFunc func,
1486 GDestroyNotify destroy,
1488 guint32 activate_time)
1490 GtkMenuPrivate *priv = menu->priv;
1492 GtkWidget *xgrab_shell;
1494 GdkEvent *current_event;
1495 GtkMenuShell *menu_shell;
1496 gboolean grab_keyboard;
1497 GtkWidget *parent_toplevel;
1498 GdkDevice *keyboard, *pointer;
1500 g_return_if_fail (GTK_IS_MENU (menu));
1501 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1504 device = gtk_get_current_event_device ();
1508 GdkDisplay *display;
1509 GdkDeviceManager *device_manager;
1512 display = gtk_widget_get_display (GTK_WIDGET (menu));
1513 device_manager = gdk_display_get_device_manager (display);
1514 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1516 device = devices->data;
1518 g_list_free (devices);
1521 widget = GTK_WIDGET (menu);
1522 menu_shell = GTK_MENU_SHELL (menu);
1524 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1527 pointer = gdk_device_get_associated_device (device);
1532 keyboard = gdk_device_get_associated_device (device);
1535 menu_shell->priv->parent_menu_shell = parent_menu_shell;
1537 priv->seen_item_enter = FALSE;
1539 /* Find the last viewable ancestor, and make an X grab on it
1541 parent = GTK_WIDGET (menu);
1545 gboolean viewable = TRUE;
1546 GtkWidget *tmp = parent;
1550 if (!gtk_widget_get_mapped (tmp))
1555 tmp = gtk_widget_get_parent (tmp);
1559 xgrab_shell = parent;
1561 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1564 /* We want to receive events generated when we map the menu;
1565 * unfortunately, since there is probably already an implicit
1566 * grab in place from the button that the user used to pop up
1567 * the menu, we won't receive then -- in particular, the EnterNotify
1568 * when the menu pops up under the pointer.
1570 * If we are grabbing on a parent menu shell, no problem; just grab
1571 * on that menu shell first before popping up the window with
1572 * owner_events = TRUE.
1574 * When grabbing on the menu itself, things get more convoluted --
1575 * we do an explicit grab on a specially created window with
1576 * owner_events = TRUE, which we override further down with a
1577 * grab on the menu. (We can't grab on the menu until it is mapped;
1578 * we probably could just leave the grab on the other window,
1579 * with a little reorganization of the code in gtkmenu*).
1581 grab_keyboard = gtk_menu_shell_get_take_focus (menu_shell);
1582 gtk_window_set_accept_focus (GTK_WINDOW (priv->toplevel), grab_keyboard);
1587 if (xgrab_shell && xgrab_shell != widget)
1589 if (popup_grab_on_window (gtk_widget_get_window (xgrab_shell), keyboard, pointer, activate_time))
1591 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1592 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1597 GdkWindow *transfer_window;
1599 xgrab_shell = widget;
1600 transfer_window = menu_grab_transfer_window_get (menu);
1601 if (popup_grab_on_window (transfer_window, keyboard, pointer, activate_time))
1603 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1604 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1608 if (!GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab)
1610 /* We failed to make our pointer/keyboard grab.
1611 * Rather than leaving the user with a stuck up window,
1612 * we just abort here. Presumably the user will try again.
1614 menu_shell->priv->parent_menu_shell = NULL;
1615 menu_grab_transfer_window_destroy (menu);
1619 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (menu), pointer);
1620 menu_shell->priv->active = TRUE;
1621 menu_shell->priv->button = button;
1623 /* If we are popping up the menu from something other than, a button
1624 * press then, as a heuristic, we ignore enter events for the menu
1625 * until we get a MOTION_NOTIFY.
1628 current_event = gtk_get_current_event ();
1631 if ((current_event->type != GDK_BUTTON_PRESS) &&
1632 (current_event->type != GDK_ENTER_NOTIFY))
1633 menu_shell->priv->ignore_enter = TRUE;
1635 gdk_event_free (current_event);
1638 menu_shell->priv->ignore_enter = TRUE;
1642 gtk_menu_tearoff_bg_copy (menu);
1644 gtk_menu_reparent (menu, priv->toplevel, FALSE);
1647 parent_toplevel = NULL;
1648 if (parent_menu_shell)
1649 parent_toplevel = gtk_widget_get_toplevel (parent_menu_shell);
1650 else if (!g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1652 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
1654 parent_toplevel = gtk_widget_get_toplevel (attach_widget);
1657 /* Set transient for to get the right window group and parent */
1658 if (GTK_IS_WINDOW (parent_toplevel))
1659 gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel),
1660 GTK_WINDOW (parent_toplevel));
1662 priv->parent_menu_item = parent_menu_item;
1663 priv->position_func = func;
1664 priv->position_func_data = data;
1665 priv->position_func_data_destroy = destroy;
1666 menu_shell->priv->activate_time = activate_time;
1668 /* We need to show the menu here rather in the init function
1669 * because code expects to be able to tell if the menu is onscreen
1670 * by looking at gtk_widget_get_visible (menu)
1672 gtk_widget_show (GTK_WIDGET (menu));
1674 /* Position the menu, possibly changing the size request
1676 gtk_menu_position (menu, TRUE);
1678 /* Compute the size of the toplevel and realize it so we
1679 * can scroll correctly.
1681 if (!gtk_widget_get_realized (GTK_WIDGET (menu)))
1683 GtkRequisition tmp_request;
1684 GtkAllocation tmp_allocation = { 0, };
1686 /* Instead of trusting the menu position function to queue a
1687 * resize when the menu goes out of bounds, invalidate the cached
1690 gtk_widget_queue_resize (GTK_WIDGET (menu));
1691 gtk_widget_get_preferred_size (priv->toplevel, &tmp_request, NULL);
1693 tmp_allocation.width = tmp_request.width;
1694 tmp_allocation.height = tmp_request.height;
1696 gtk_widget_size_allocate (priv->toplevel, &tmp_allocation);
1698 gtk_widget_realize (GTK_WIDGET (menu));
1701 gtk_menu_scroll_to (menu, priv->scroll_offset);
1703 /* if no item is selected, select the first one */
1704 if (!menu_shell->priv->active_menu_item)
1706 gboolean touchscreen_mode;
1708 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
1709 "gtk-touchscreen-mode", &touchscreen_mode,
1712 if (touchscreen_mode)
1713 gtk_menu_shell_select_first (menu_shell, TRUE);
1716 /* Once everything is set up correctly, map the toplevel */
1717 gtk_widget_show (priv->toplevel);
1719 if (xgrab_shell == widget)
1720 popup_grab_on_window (gtk_widget_get_window (widget), keyboard, pointer, activate_time); /* Should always succeed */
1722 gtk_device_grab_add (GTK_WIDGET (menu), pointer, TRUE);
1724 if (parent_menu_shell)
1726 gboolean keyboard_mode;
1728 keyboard_mode = _gtk_menu_shell_get_keyboard_mode (GTK_MENU_SHELL (parent_menu_shell));
1729 _gtk_menu_shell_set_keyboard_mode (menu_shell, keyboard_mode);
1731 else if (menu_shell->priv->button == 0) /* a keynav-activated context menu */
1732 _gtk_menu_shell_set_keyboard_mode (menu_shell, TRUE);
1734 _gtk_menu_shell_update_mnemonics (menu_shell);
1738 * gtk_menu_popup: (skip)
1740 * @parent_menu_shell: (allow-none): the menu shell containing the
1741 * triggering menu item, or %NULL
1742 * @parent_menu_item: (allow-none): the menu item whose activation
1743 * triggered the popup, or %NULL
1744 * @func: (allow-none): a user supplied function used to position
1745 * the menu, or %NULL
1746 * @data: user supplied data to be passed to @func.
1747 * @button: the mouse button which was pressed to initiate the event.
1748 * @activate_time: the time at which the activation event occurred.
1750 * Displays a menu and makes it available for selection.
1752 * Applications can use this function to display context-sensitive
1753 * menus, and will typically supply %NULL for the @parent_menu_shell,
1754 * @parent_menu_item, @func and @data parameters. The default menu
1755 * positioning function will position the menu at the current mouse
1758 * The @button parameter should be the mouse button pressed to initiate
1759 * the menu popup. If the menu popup was initiated by something other
1760 * than a mouse button press, such as a mouse button release or a keypress,
1761 * @button should be 0.
1763 * The @activate_time parameter is used to conflict-resolve initiation
1764 * of concurrent requests for mouse/keyboard grab requests. To function
1765 * properly, this needs to be the timestamp of the user event (such as
1766 * a mouse click or key press) that caused the initiation of the popup.
1767 * Only if no such event is available, gtk_get_current_event_time() can
1771 gtk_menu_popup (GtkMenu *menu,
1772 GtkWidget *parent_menu_shell,
1773 GtkWidget *parent_menu_item,
1774 GtkMenuPositionFunc func,
1777 guint32 activate_time)
1779 g_return_if_fail (GTK_IS_MENU (menu));
1781 gtk_menu_popup_for_device (menu,
1786 button, activate_time);
1793 * Removes the menu from the screen.
1796 gtk_menu_popdown (GtkMenu *menu)
1798 GtkMenuPrivate *priv;
1799 GtkMenuShell *menu_shell;
1802 g_return_if_fail (GTK_IS_MENU (menu));
1804 menu_shell = GTK_MENU_SHELL (menu);
1807 menu_shell->priv->parent_menu_shell = NULL;
1808 menu_shell->priv->active = FALSE;
1809 menu_shell->priv->ignore_enter = FALSE;
1811 priv->have_position = FALSE;
1813 gtk_menu_stop_scrolling (menu);
1814 gtk_menu_stop_navigating_submenu (menu);
1816 if (menu_shell->priv->active_menu_item)
1818 if (priv->old_active_menu_item)
1819 g_object_unref (priv->old_active_menu_item);
1820 priv->old_active_menu_item = menu_shell->priv->active_menu_item;
1821 g_object_ref (priv->old_active_menu_item);
1824 gtk_menu_shell_deselect (menu_shell);
1826 /* The X Grab, if present, will automatically be removed
1827 * when we hide the window
1831 gtk_widget_hide (priv->toplevel);
1832 gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel), NULL);
1835 pointer = _gtk_menu_shell_get_grab_device (menu_shell);
1839 gtk_widget_set_size_request (priv->tearoff_window, -1, -1);
1841 if (gtk_bin_get_child (GTK_BIN (priv->toplevel)))
1843 gtk_menu_reparent (menu, priv->tearoff_hbox, TRUE);
1847 /* We popped up the menu from the tearoff, so we need to
1848 * release the grab - we aren't actually hiding the menu.
1850 if (menu_shell->priv->have_xgrab && pointer)
1852 GdkDevice *keyboard;
1854 gdk_device_ungrab (pointer, GDK_CURRENT_TIME);
1855 keyboard = gdk_device_get_associated_device (pointer);
1858 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1862 /* gtk_menu_popdown is called each time a menu item is selected from
1863 * a torn off menu. Only scroll back to the saved position if the
1864 * non-tearoff menu was popped down.
1866 if (!priv->tearoff_active)
1867 gtk_menu_scroll_to (menu, priv->saved_scroll_offset);
1868 priv->tearoff_active = TRUE;
1871 gtk_widget_hide (GTK_WIDGET (menu));
1873 menu_shell->priv->have_xgrab = FALSE;
1876 gtk_device_grab_remove (GTK_WIDGET (menu), pointer);
1878 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1880 menu_grab_transfer_window_destroy (menu);
1884 * gtk_menu_get_active:
1887 * Returns the selected menu item from the menu. This is used by the
1890 * Returns: (transfer none): the #GtkMenuItem that was last selected
1891 * in the menu. If a selection has not yet been made, the
1892 * first menu item is selected.
1895 gtk_menu_get_active (GtkMenu *menu)
1897 GtkMenuPrivate *priv = menu->priv;
1901 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1903 if (!priv->old_active_menu_item)
1906 children = GTK_MENU_SHELL (menu)->priv->children;
1910 child = children->data;
1911 children = children->next;
1913 if (gtk_bin_get_child (GTK_BIN (child)))
1918 priv->old_active_menu_item = child;
1919 if (priv->old_active_menu_item)
1920 g_object_ref (priv->old_active_menu_item);
1923 return priv->old_active_menu_item;
1927 * gtk_menu_set_active:
1929 * @index: the index of the menu item to select. Iindex values are
1932 * Selects the specified menu item within the menu. This is used by
1933 * the #GtkOptionMenu and should not be used by anyone else.
1936 gtk_menu_set_active (GtkMenu *menu,
1939 GtkMenuPrivate *priv = menu->priv;
1943 g_return_if_fail (GTK_IS_MENU (menu));
1945 tmp_list = g_list_nth (GTK_MENU_SHELL (menu)->priv->children, index);
1948 child = tmp_list->data;
1949 if (gtk_bin_get_child (GTK_BIN (child)))
1951 if (priv->old_active_menu_item)
1952 g_object_unref (priv->old_active_menu_item);
1953 priv->old_active_menu_item = child;
1954 g_object_ref (priv->old_active_menu_item);
1960 * gtk_menu_set_accel_group:
1962 * @accel_group: (allow-none): the #GtkAccelGroup to be associated
1965 * Set the #GtkAccelGroup which holds global accelerators for the
1966 * menu. This accelerator group needs to also be added to all windows
1967 * that this menu is being used in with gtk_window_add_accel_group(),
1968 * in order for those windows to support all the accelerators
1969 * contained in this group.
1972 gtk_menu_set_accel_group (GtkMenu *menu,
1973 GtkAccelGroup *accel_group)
1975 GtkMenuPrivate *priv = menu->priv;
1976 g_return_if_fail (GTK_IS_MENU (menu));
1978 if (priv->accel_group != accel_group)
1980 if (priv->accel_group)
1981 g_object_unref (priv->accel_group);
1982 priv->accel_group = accel_group;
1983 if (priv->accel_group)
1984 g_object_ref (priv->accel_group);
1985 _gtk_menu_refresh_accel_paths (menu, TRUE);
1990 * gtk_menu_get_accel_group:
1993 * Gets the #GtkAccelGroup which holds global accelerators for the
1994 * menu. See gtk_menu_set_accel_group().
1996 * Returns: (transfer none): the #GtkAccelGroup associated with the menu
1999 gtk_menu_get_accel_group (GtkMenu *menu)
2001 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2003 return menu->priv->accel_group;
2007 gtk_menu_real_can_activate_accel (GtkWidget *widget,
2010 /* Menu items chain here to figure whether they can activate their
2011 * accelerators. Unlike ordinary widgets, menus allow accel
2012 * activation even if invisible since that's the usual case for
2013 * submenus/popup-menus. however, the state of the attach widget
2014 * affects the "activeness" of the menu.
2016 GtkWidget *awidget = gtk_menu_get_attach_widget (GTK_MENU (widget));
2019 return gtk_widget_can_activate_accel (awidget, signal_id);
2021 return gtk_widget_is_sensitive (widget);
2025 * gtk_menu_set_accel_path
2026 * @menu: a valid #GtkMenu
2027 * @accel_path: (allow-none): a valid accelerator path
2029 * Sets an accelerator path for this menu from which accelerator paths
2030 * for its immediate children, its menu items, can be constructed.
2031 * The main purpose of this function is to spare the programmer the
2032 * inconvenience of having to call gtk_menu_item_set_accel_path() on
2033 * each menu item that should support runtime user changable accelerators.
2034 * Instead, by just calling gtk_menu_set_accel_path() on their parent,
2035 * each menu item of this menu, that contains a label describing its
2036 * purpose, automatically gets an accel path assigned.
2038 * For example, a menu containing menu items "New" and "Exit", will, after
2039 * <literal>gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");</literal>
2040 * has been called, assign its items the accel paths:
2041 * <literal>"<Gnumeric-Sheet>/File/New"</literal> and <literal>"<Gnumeric-Sheet>/File/Exit"</literal>.
2043 * Assigning accel paths to menu items then enables the user to change
2044 * their accelerators at runtime. More details about accelerator paths
2045 * and their default setups can be found at gtk_accel_map_add_entry().
2047 * Note that @accel_path string will be stored in a #GQuark. Therefore,
2048 * if you pass a static string, you can save some memory by interning
2049 * it first with g_intern_static_string().
2052 gtk_menu_set_accel_path (GtkMenu *menu,
2053 const gchar *accel_path)
2055 GtkMenuPrivate *priv = menu->priv;
2056 g_return_if_fail (GTK_IS_MENU (menu));
2059 g_return_if_fail (accel_path[0] == '<' && strchr (accel_path, '/')); /* simplistic check */
2061 /* FIXME: accel_path should be defined as const gchar* */
2062 priv->accel_path = (gchar*)g_intern_string (accel_path);
2063 if (priv->accel_path)
2064 _gtk_menu_refresh_accel_paths (menu, FALSE);
2068 * gtk_menu_get_accel_path
2069 * @menu: a valid #GtkMenu
2071 * Retrieves the accelerator path set on the menu.
2073 * Returns: the accelerator path set on the menu.
2078 gtk_menu_get_accel_path (GtkMenu *menu)
2080 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2082 return menu->priv->accel_path;
2087 gboolean group_changed;
2091 refresh_accel_paths_foreach (GtkWidget *widget,
2094 GtkMenuPrivate *priv;
2095 AccelPropagation *prop = data;
2097 if (GTK_IS_MENU_ITEM (widget)) /* should always be true */
2099 priv = prop->menu->priv;
2100 _gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
2103 prop->group_changed);
2108 _gtk_menu_refresh_accel_paths (GtkMenu *menu,
2109 gboolean group_changed)
2111 GtkMenuPrivate *priv = menu->priv;
2112 g_return_if_fail (GTK_IS_MENU (menu));
2114 if (priv->accel_path && priv->accel_group)
2116 AccelPropagation prop;
2119 prop.group_changed = group_changed;
2120 gtk_container_foreach (GTK_CONTAINER (menu),
2121 refresh_accel_paths_foreach,
2127 * gtk_menu_reposition:
2130 * Repositions the menu according to its position function.
2133 gtk_menu_reposition (GtkMenu *menu)
2135 g_return_if_fail (GTK_IS_MENU (menu));
2137 if (!menu->priv->torn_off && gtk_widget_is_drawable (GTK_WIDGET (menu)))
2138 gtk_menu_position (menu, FALSE);
2142 gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
2147 value = gtk_adjustment_get_value (adjustment);
2148 if (menu->priv->scroll_offset != value)
2149 gtk_menu_scroll_to (menu, value);
2153 gtk_menu_set_tearoff_hints (GtkMenu *menu,
2156 GtkMenuPrivate *priv = menu->priv;
2157 GdkGeometry geometry_hints;
2159 if (!priv->tearoff_window)
2162 if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2164 GtkRequisition requisition;
2166 gtk_widget_get_preferred_size (priv->tearoff_scrollbar,
2167 &requisition, NULL);
2168 width += requisition.width;
2171 geometry_hints.min_width = width;
2172 geometry_hints.max_width = width;
2174 geometry_hints.min_height = 0;
2175 geometry_hints.max_height = priv->requested_height;
2177 gtk_window_set_geometry_hints (GTK_WINDOW (priv->tearoff_window),
2180 GDK_HINT_MAX_SIZE|GDK_HINT_MIN_SIZE);
2184 gtk_menu_update_title (GtkMenu *menu)
2186 GtkMenuPrivate *priv = menu->priv;
2188 if (priv->tearoff_window)
2191 GtkWidget *attach_widget;
2193 title = gtk_menu_get_title (menu);
2196 attach_widget = gtk_menu_get_attach_widget (menu);
2197 if (GTK_IS_MENU_ITEM (attach_widget))
2199 GtkWidget *child = gtk_bin_get_child (GTK_BIN (attach_widget));
2200 if (GTK_IS_LABEL (child))
2201 title = gtk_label_get_text (GTK_LABEL (child));
2206 gtk_window_set_title (GTK_WINDOW (priv->tearoff_window), title);
2211 gtk_menu_get_toplevel (GtkWidget *menu)
2213 GtkWidget *attach, *toplevel;
2215 attach = gtk_menu_get_attach_widget (GTK_MENU (menu));
2217 if (GTK_IS_MENU_ITEM (attach))
2218 attach = gtk_widget_get_parent (attach);
2220 if (GTK_IS_MENU (attach))
2221 return gtk_menu_get_toplevel (attach);
2222 else if (GTK_IS_WIDGET (attach))
2224 toplevel = gtk_widget_get_toplevel (attach);
2225 if (gtk_widget_is_toplevel (toplevel))
2233 tearoff_window_destroyed (GtkWidget *widget,
2236 gtk_menu_set_tearoff_state (menu, FALSE);
2240 * gtk_menu_set_tearoff_state:
2242 * @torn_off: If %TRUE, menu is displayed as a tearoff menu.
2244 * Changes the tearoff state of the menu. A menu is normally
2245 * displayed as drop down menu which persists as long as the menu is
2246 * active. It can also be displayed as a tearoff menu which persists
2247 * until it is closed or reattached.
2250 gtk_menu_set_tearoff_state (GtkMenu *menu,
2253 GtkMenuPrivate *priv = menu->priv;
2256 g_return_if_fail (GTK_IS_MENU (menu));
2258 if (priv->torn_off != torn_off)
2260 priv->torn_off = torn_off;
2261 priv->tearoff_active = torn_off;
2265 if (gtk_widget_get_visible (GTK_WIDGET (menu)))
2266 gtk_menu_popdown (menu);
2268 if (!priv->tearoff_window)
2270 GtkWidget *toplevel;
2272 priv->tearoff_window = g_object_new (GTK_TYPE_WINDOW,
2273 "type", GTK_WINDOW_TOPLEVEL,
2274 "screen", gtk_widget_get_screen (priv->toplevel),
2275 "app-paintable", TRUE,
2278 gtk_window_set_type_hint (GTK_WINDOW (priv->tearoff_window),
2279 GDK_WINDOW_TYPE_HINT_MENU);
2280 gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->tearoff_window), 0);
2281 g_signal_connect (priv->tearoff_window, "destroy",
2282 G_CALLBACK (tearoff_window_destroyed), menu);
2283 g_signal_connect (priv->tearoff_window, "event",
2284 G_CALLBACK (gtk_menu_window_event), menu);
2286 gtk_menu_update_title (menu);
2288 gtk_widget_realize (priv->tearoff_window);
2290 toplevel = gtk_menu_get_toplevel (GTK_WIDGET (menu));
2291 if (toplevel != NULL)
2292 gtk_window_set_transient_for (GTK_WINDOW (priv->tearoff_window),
2293 GTK_WINDOW (toplevel));
2295 priv->tearoff_hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2296 gtk_container_add (GTK_CONTAINER (priv->tearoff_window),
2297 priv->tearoff_hbox);
2299 height = gdk_window_get_height (gtk_widget_get_window (GTK_WIDGET (menu)));
2300 priv->tearoff_adjustment = gtk_adjustment_new (0,
2301 0, priv->requested_height,
2305 g_object_connect (priv->tearoff_adjustment,
2306 "signal::value-changed", gtk_menu_scrollbar_changed, menu,
2308 priv->tearoff_scrollbar = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, priv->tearoff_adjustment);
2310 gtk_box_pack_end (GTK_BOX (priv->tearoff_hbox),
2311 priv->tearoff_scrollbar,
2314 if (gtk_adjustment_get_upper (priv->tearoff_adjustment) > height)
2315 gtk_widget_show (priv->tearoff_scrollbar);
2317 gtk_widget_show (priv->tearoff_hbox);
2320 gtk_menu_reparent (menu, priv->tearoff_hbox, FALSE);
2322 /* Update menu->requisition */
2323 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, NULL);
2325 gtk_menu_set_tearoff_hints (menu, gdk_window_get_width (gtk_widget_get_window (GTK_WIDGET (menu))));
2327 gtk_widget_realize (priv->tearoff_window);
2328 gtk_menu_position (menu, TRUE);
2330 gtk_widget_show (GTK_WIDGET (menu));
2331 gtk_widget_show (priv->tearoff_window);
2333 gtk_menu_scroll_to (menu, 0);
2338 gtk_widget_hide (GTK_WIDGET (menu));
2339 gtk_widget_hide (priv->tearoff_window);
2340 if (GTK_IS_CONTAINER (priv->toplevel))
2341 gtk_menu_reparent (menu, priv->toplevel, FALSE);
2342 gtk_widget_destroy (priv->tearoff_window);
2344 priv->tearoff_window = NULL;
2345 priv->tearoff_hbox = NULL;
2346 priv->tearoff_scrollbar = NULL;
2347 priv->tearoff_adjustment = NULL;
2350 g_object_notify (G_OBJECT (menu), "tearoff-state");
2355 * gtk_menu_get_tearoff_state:
2358 * Returns whether the menu is torn off.
2359 * See gtk_menu_set_tearoff_state().
2361 * Return value: %TRUE if the menu is currently torn off.
2364 gtk_menu_get_tearoff_state (GtkMenu *menu)
2366 g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
2368 return menu->priv->torn_off;
2372 * gtk_menu_set_title:
2374 * @title: a string containing the title for the menu
2376 * Sets the title string for the menu.
2378 * The title is displayed when the menu is shown as a tearoff
2379 * menu. If @title is %NULL, the menu will see if it is attached
2380 * to a parent menu item, and if so it will try to use the same
2381 * text as that menu item's label.
2384 gtk_menu_set_title (GtkMenu *menu,
2387 GtkMenuPrivate *priv = menu->priv;
2390 g_return_if_fail (GTK_IS_MENU (menu));
2392 old_title = priv->title;
2393 priv->title = g_strdup (title);
2396 gtk_menu_update_title (menu);
2397 g_object_notify (G_OBJECT (menu), "tearoff-title");
2401 * gtk_menu_get_title:
2404 * Returns the title of the menu. See gtk_menu_set_title().
2406 * Return value: the title of the menu, or %NULL if the menu
2407 * has no title set on it. This string is owned by GTK+
2408 * and should not be modified or freed.
2410 G_CONST_RETURN gchar *
2411 gtk_menu_get_title (GtkMenu *menu)
2413 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2415 return menu->priv->title;
2419 * gtk_menu_reorder_child:
2421 * @child: the #GtkMenuItem to move
2422 * @position: the new position to place @child.
2423 * Positions are numbered from 0 to n - 1
2425 * Moves @child to a new @position in the list of @menu
2429 gtk_menu_reorder_child (GtkMenu *menu,
2433 GtkMenuShell *menu_shell;
2435 g_return_if_fail (GTK_IS_MENU (menu));
2436 g_return_if_fail (GTK_IS_MENU_ITEM (child));
2438 menu_shell = GTK_MENU_SHELL (menu);
2440 if (g_list_find (menu_shell->priv->children, child))
2442 menu_shell->priv->children = g_list_remove (menu_shell->priv->children, child);
2443 menu_shell->priv->children = g_list_insert (menu_shell->priv->children, child, position);
2445 menu_queue_resize (menu);
2450 gtk_menu_style_updated (GtkWidget *widget)
2452 GTK_WIDGET_CLASS (gtk_menu_parent_class)->style_updated (widget);
2454 if (gtk_widget_get_realized (widget))
2456 GtkMenu *menu = GTK_MENU (widget);
2457 GtkMenuPrivate *priv = menu->priv;
2458 GtkStyleContext *context;
2460 context = gtk_widget_get_style_context (widget);
2462 gtk_style_context_set_background (context, priv->bin_window);
2463 gtk_style_context_set_background (context, priv->view_window);
2464 gtk_style_context_set_background (context, gtk_widget_get_window (widget));
2469 get_arrows_border (GtkMenu *menu,
2472 GtkMenuPrivate *priv = menu->priv;
2473 guint scroll_arrow_height;
2474 GtkArrowPlacement arrow_placement;
2476 gtk_widget_style_get (GTK_WIDGET (menu),
2477 "scroll-arrow-vlength", &scroll_arrow_height,
2478 "arrow_placement", &arrow_placement,
2481 switch (arrow_placement)
2483 case GTK_ARROWS_BOTH:
2484 border->top = priv->upper_arrow_visible ? scroll_arrow_height : 0;
2485 border->bottom = priv->lower_arrow_visible ? scroll_arrow_height : 0;
2488 case GTK_ARROWS_START:
2489 border->top = (priv->upper_arrow_visible ||
2490 priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2494 case GTK_ARROWS_END:
2496 border->bottom = (priv->upper_arrow_visible ||
2497 priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2501 border->left = border->right = 0;
2505 get_menu_padding (GtkWidget *widget,
2508 GtkStyleContext *context;
2509 GtkStateFlags state;
2511 context = gtk_widget_get_style_context (widget);
2512 state = gtk_widget_get_state_flags (widget);
2514 gtk_style_context_get_padding (context, state, padding);
2518 gtk_menu_realize (GtkWidget *widget)
2520 GtkMenu *menu = GTK_MENU (widget);
2521 GtkMenuPrivate *priv = menu->priv;
2522 GtkAllocation allocation;
2523 GtkStyleContext *context;
2525 GdkWindowAttr attributes;
2526 gint attributes_mask;
2530 guint vertical_padding;
2531 guint horizontal_padding;
2532 GtkBorder arrow_border, padding;
2534 g_return_if_fail (GTK_IS_MENU (widget));
2536 gtk_widget_set_realized (widget, TRUE);
2538 gtk_widget_get_allocation (widget, &allocation);
2540 attributes.window_type = GDK_WINDOW_CHILD;
2541 attributes.x = allocation.x;
2542 attributes.y = allocation.y;
2543 attributes.width = allocation.width;
2544 attributes.height = allocation.height;
2545 attributes.wclass = GDK_INPUT_OUTPUT;
2546 attributes.visual = gtk_widget_get_visual (widget);
2547 attributes.event_mask = gtk_widget_get_events (widget);
2548 attributes.event_mask |= (GDK_EXPOSURE_MASK | GDK_KEY_PRESS_MASK |
2549 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK );
2551 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
2553 window = gdk_window_new (gtk_widget_get_parent_window (widget),
2554 &attributes, attributes_mask);
2555 gtk_widget_set_window (widget, window);
2556 gdk_window_set_user_data (window, widget);
2558 get_menu_padding (widget, &padding);
2559 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2560 context = gtk_widget_get_style_context (widget);
2562 gtk_widget_style_get (GTK_WIDGET (menu),
2563 "vertical-padding", &vertical_padding,
2564 "horizontal-padding", &horizontal_padding,
2567 gtk_widget_get_allocation (widget, &allocation);
2569 attributes.x = border_width + padding.left + horizontal_padding;
2570 attributes.y = border_width + padding.top + vertical_padding;
2571 attributes.width = allocation.width -
2572 (2 * (border_width + horizontal_padding)) - padding.left - padding.right;
2573 attributes.height = allocation.height -
2574 (2 * (border_width + vertical_padding)) - padding.top - padding.bottom;
2576 get_arrows_border (menu, &arrow_border);
2577 attributes.y += arrow_border.top;
2578 attributes.height -= arrow_border.top;
2579 attributes.height -= arrow_border.bottom;
2581 attributes.width = MAX (1, attributes.width);
2582 attributes.height = MAX (1, attributes.height);
2584 priv->view_window = gdk_window_new (window,
2585 &attributes, attributes_mask);
2586 gdk_window_set_user_data (priv->view_window, menu);
2588 gtk_widget_get_allocation (widget, &allocation);
2592 attributes.width = allocation.width + (2 * (border_width + horizontal_padding)) +
2593 padding.left + padding.right;
2594 attributes.height = priv->requested_height - (2 * (border_width + vertical_padding)) +
2595 padding.top + padding.bottom;
2597 attributes.width = MAX (1, attributes.width);
2598 attributes.height = MAX (1, attributes.height);
2600 priv->bin_window = gdk_window_new (priv->view_window,
2601 &attributes, attributes_mask);
2602 gdk_window_set_user_data (priv->bin_window, menu);
2604 children = GTK_MENU_SHELL (menu)->priv->children;
2607 child = children->data;
2608 children = children->next;
2610 gtk_widget_set_parent_window (child, priv->bin_window);
2613 gtk_style_context_set_background (context, priv->bin_window);
2614 gtk_style_context_set_background (context, priv->view_window);
2615 gtk_style_context_set_background (context, window);
2617 if (GTK_MENU_SHELL (widget)->priv->active_menu_item)
2618 gtk_menu_scroll_item_visible (GTK_MENU_SHELL (widget),
2619 GTK_MENU_SHELL (widget)->priv->active_menu_item);
2621 gdk_window_show (priv->bin_window);
2622 gdk_window_show (priv->view_window);
2626 gtk_menu_focus (GtkWidget *widget,
2627 GtkDirectionType direction)
2629 /* A menu or its menu items cannot have focus */
2633 /* See notes in gtk_menu_popup() for information
2634 * about the "grab transfer window"
2637 menu_grab_transfer_window_get (GtkMenu *menu)
2639 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2642 GdkWindowAttr attributes;
2643 gint attributes_mask;
2645 attributes.x = -100;
2646 attributes.y = -100;
2647 attributes.width = 10;
2648 attributes.height = 10;
2649 attributes.window_type = GDK_WINDOW_TEMP;
2650 attributes.wclass = GDK_INPUT_ONLY;
2651 attributes.override_redirect = TRUE;
2652 attributes.event_mask = 0;
2654 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
2656 window = gdk_window_new (gtk_widget_get_root_window (GTK_WIDGET (menu)),
2657 &attributes, attributes_mask);
2658 gdk_window_set_user_data (window, menu);
2660 gdk_window_show (window);
2662 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), window);
2669 menu_grab_transfer_window_destroy (GtkMenu *menu)
2671 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2674 gdk_window_set_user_data (window, NULL);
2675 gdk_window_destroy (window);
2676 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), NULL);
2681 gtk_menu_unrealize (GtkWidget *widget)
2683 GtkMenu *menu = GTK_MENU (widget);
2684 GtkMenuPrivate *priv = menu->priv;
2686 menu_grab_transfer_window_destroy (menu);
2688 gdk_window_set_user_data (priv->view_window, NULL);
2689 gdk_window_destroy (priv->view_window);
2690 priv->view_window = NULL;
2692 gdk_window_set_user_data (priv->bin_window, NULL);
2693 gdk_window_destroy (priv->bin_window);
2694 priv->bin_window = NULL;
2696 GTK_WIDGET_CLASS (gtk_menu_parent_class)->unrealize (widget);
2700 calculate_line_heights (GtkMenu *menu,
2702 guint **ret_min_heights,
2703 guint **ret_nat_heights)
2706 GtkMenuPrivate *priv;
2707 GtkMenuShell *menu_shell;
2708 GtkWidget *child, *widget;
2710 guint horizontal_padding;
2719 widget = GTK_WIDGET (menu);
2720 menu_shell = GTK_MENU_SHELL (widget);
2722 min_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2723 nat_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2724 n_heights = gtk_menu_get_n_rows (menu);
2725 n_columns = gtk_menu_get_n_columns (menu);
2726 avail_width = for_width - (2 * priv->toggle_size + priv->accel_size) * n_columns;
2728 gtk_widget_style_get (GTK_WIDGET (menu),
2729 "horizontal-padding", &horizontal_padding,
2731 get_menu_padding (widget, &padding);
2733 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2734 avail_width -= (border_width + horizontal_padding) * 2 + padding.left + padding.right;
2736 for (children = menu_shell->priv->children; children; children = children->next)
2741 gint child_min, child_nat;
2743 child = children->data;
2745 if (!gtk_widget_get_visible (child))
2748 get_effective_child_attach (child, &l, &r, &t, &b);
2750 part = avail_width / (r - l);
2752 gtk_widget_get_preferred_height_for_width (child, part,
2753 &child_min, &child_nat);
2755 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
2757 part = MAX (child_min, toggle_size) / (b - t);
2758 min_heights[t] = MAX (min_heights[t], part);
2760 part = MAX (child_nat, toggle_size) / (b - t);
2761 nat_heights[t] = MAX (nat_heights[t], part);
2764 if (ret_min_heights)
2765 *ret_min_heights = min_heights;
2767 g_free (min_heights);
2769 if (ret_nat_heights)
2770 *ret_nat_heights = nat_heights;
2772 g_free (nat_heights);
2778 gtk_menu_size_allocate (GtkWidget *widget,
2779 GtkAllocation *allocation)
2782 GtkMenuPrivate *priv;
2783 GtkMenuShell *menu_shell;
2785 GtkAllocation child_allocation;
2790 guint vertical_padding;
2791 guint horizontal_padding;
2794 g_return_if_fail (GTK_IS_MENU (widget));
2795 g_return_if_fail (allocation != NULL);
2797 menu = GTK_MENU (widget);
2798 menu_shell = GTK_MENU_SHELL (widget);
2801 gtk_widget_set_allocation (widget, allocation);
2803 gtk_widget_style_get (GTK_WIDGET (menu),
2804 "vertical-padding", &vertical_padding,
2805 "horizontal-padding", &horizontal_padding,
2808 get_menu_padding (widget, &padding);
2809 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2811 g_free (priv->heights);
2812 priv->heights_length = calculate_line_heights (menu,
2817 /* refresh our cached height request */
2818 priv->requested_height = (2 * (border_width + vertical_padding)) +
2819 padding.top + padding.bottom;
2820 for (i = 0; i < priv->heights_length; i++)
2821 priv->requested_height += priv->heights[i];
2823 x = border_width + padding.left + horizontal_padding;
2824 y = border_width + padding.top + vertical_padding;
2825 width = allocation->width - (2 * (border_width + horizontal_padding)) -
2826 padding.left - padding.right;
2827 height = allocation->height - (2 * (border_width + vertical_padding)) -
2828 padding.top - padding.bottom;
2830 if (menu_shell->priv->active)
2831 gtk_menu_scroll_to (menu, priv->scroll_offset);
2833 if (!priv->tearoff_active)
2835 GtkBorder arrow_border;
2837 get_arrows_border (menu, &arrow_border);
2838 y += arrow_border.top;
2839 height -= arrow_border.top;
2840 height -= arrow_border.bottom;
2843 width = MAX (1, width);
2844 height = MAX (1, height);
2846 if (gtk_widget_get_realized (widget))
2848 gdk_window_move_resize (gtk_widget_get_window (widget),
2849 allocation->x, allocation->y,
2850 allocation->width, allocation->height);
2852 gdk_window_move_resize (priv->view_window, x, y, width, height);
2855 if (menu_shell->priv->children)
2857 gint base_width = width / gtk_menu_get_n_columns (menu);
2859 children = menu_shell->priv->children;
2862 child = children->data;
2863 children = children->next;
2865 if (gtk_widget_get_visible (child))
2870 get_effective_child_attach (child, &l, &r, &t, &b);
2872 if (gtk_widget_get_direction (GTK_WIDGET (menu)) == GTK_TEXT_DIR_RTL)
2875 tmp = gtk_menu_get_n_columns (menu) - l;
2876 l = gtk_menu_get_n_columns (menu) - r;
2880 child_allocation.width = (r - l) * base_width;
2881 child_allocation.height = 0;
2882 child_allocation.x = l * base_width;
2883 child_allocation.y = 0;
2885 for (i = 0; i < b; i++)
2888 child_allocation.y += priv->heights[i];
2890 child_allocation.height += priv->heights[i];
2893 gtk_menu_item_toggle_size_allocate (GTK_MENU_ITEM (child),
2896 gtk_widget_size_allocate (child, &child_allocation);
2897 gtk_widget_queue_draw (child);
2901 /* Resize the item window */
2902 if (gtk_widget_get_realized (widget))
2908 for (i = 0; i < gtk_menu_get_n_rows (menu); i++)
2909 height += priv->heights[i];
2911 width = gtk_menu_get_n_columns (menu) * base_width;
2912 gdk_window_resize (priv->bin_window, width, height);
2915 if (priv->tearoff_active)
2917 if (height >= priv->requested_height)
2919 if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2921 gtk_widget_hide (priv->tearoff_scrollbar);
2922 gtk_menu_set_tearoff_hints (menu, allocation->width);
2924 gtk_menu_scroll_to (menu, 0);
2929 gtk_adjustment_configure (priv->tearoff_adjustment,
2930 gtk_adjustment_get_value (priv->tearoff_adjustment),
2932 priv->requested_height,
2933 gtk_adjustment_get_step_increment (priv->tearoff_adjustment),
2934 gtk_adjustment_get_page_increment (priv->tearoff_adjustment),
2935 allocation->height);
2937 if (!gtk_widget_get_visible (priv->tearoff_scrollbar))
2939 gtk_widget_show (priv->tearoff_scrollbar);
2940 gtk_menu_set_tearoff_hints (menu, allocation->width);
2948 get_arrows_visible_area (GtkMenu *menu,
2949 GdkRectangle *border,
2950 GdkRectangle *upper,
2951 GdkRectangle *lower,
2954 GtkArrowPlacement arrow_placement;
2955 GtkWidget *widget = GTK_WIDGET (menu);
2957 guint vertical_padding;
2958 guint horizontal_padding;
2959 gint scroll_arrow_height;
2960 GtkBorder menu_padding;
2962 gtk_widget_style_get (widget,
2963 "vertical-padding", &vertical_padding,
2964 "horizontal-padding", &horizontal_padding,
2965 "scroll-arrow-vlength", &scroll_arrow_height,
2966 "arrow-placement", &arrow_placement,
2969 get_menu_padding (widget, &menu_padding);
2970 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2971 border->x = border_width + menu_padding.left + horizontal_padding;
2972 border->y = border_width + menu_padding.top + vertical_padding;
2973 border->width = gdk_window_get_width (gtk_widget_get_window (widget));
2974 border->height = gdk_window_get_height (gtk_widget_get_window (widget));
2976 switch (arrow_placement)
2978 case GTK_ARROWS_BOTH:
2979 upper->x = border->x;
2980 upper->y = border->y;
2981 upper->width = border->width - 2 * border->x;
2982 upper->height = scroll_arrow_height;
2984 lower->x = border->x;
2985 lower->y = border->height - border->y - scroll_arrow_height;
2986 lower->width = border->width - 2 * border->x;
2987 lower->height = scroll_arrow_height;
2990 case GTK_ARROWS_START:
2991 upper->x = border->x;
2992 upper->y = border->y;
2993 upper->width = (border->width - 2 * border->x) / 2;
2994 upper->height = scroll_arrow_height;
2996 lower->x = border->x + upper->width;
2997 lower->y = border->y;
2998 lower->width = (border->width - 2 * border->x) / 2;
2999 lower->height = scroll_arrow_height;
3002 case GTK_ARROWS_END:
3003 upper->x = border->x;
3004 upper->y = border->height - border->y - scroll_arrow_height;
3005 upper->width = (border->width - 2 * border->x) / 2;
3006 upper->height = scroll_arrow_height;
3008 lower->x = border->x + upper->width;
3009 lower->y = border->height - border->y - scroll_arrow_height;
3010 lower->width = (border->width - 2 * border->x) / 2;
3011 lower->height = scroll_arrow_height;
3015 g_assert_not_reached();
3016 upper->x = upper->y = upper->width = upper->height = 0;
3017 lower->x = lower->y = lower->width = lower->height = 0;
3020 *arrow_space = scroll_arrow_height - menu_padding.top - menu_padding.bottom;
3024 gtk_menu_draw (GtkWidget *widget,
3028 GtkMenuPrivate *priv;
3029 GtkStyleContext *context;
3030 GdkRectangle border;
3034 GtkBorder menu_padding;
3036 menu = GTK_MENU (widget);
3038 context = gtk_widget_get_style_context (widget);
3040 get_arrows_visible_area (menu, &border, &upper, &lower, &arrow_space);
3041 get_menu_padding (widget, &menu_padding);
3043 if (gtk_cairo_should_draw_window (cr, gtk_widget_get_window (widget)))
3045 gfloat arrow_scaling;
3048 gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
3049 arrow_size = arrow_scaling * arrow_space;
3051 gtk_render_background (context, cr, 0, 0,
3052 gtk_widget_get_allocated_width (widget),
3053 gtk_widget_get_allocated_height (widget));
3054 gtk_render_frame (context, cr, 0, 0,
3055 gtk_widget_get_allocated_width (widget),
3056 gtk_widget_get_allocated_height (widget));
3058 gtk_style_context_save (context);
3059 gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
3061 if (priv->upper_arrow_visible && !priv->tearoff_active)
3063 gtk_style_context_save (context);
3064 gtk_style_context_set_state (context, priv->upper_arrow_state);
3066 gtk_render_background (context, cr,
3068 upper.width, upper.height);
3069 gtk_render_frame (context, cr,
3071 upper.width, upper.height);
3073 gtk_render_arrow (context, cr, 0,
3074 upper.x + (upper.width - arrow_size) / 2,
3075 upper.y + menu_padding.top + (arrow_space - arrow_size) / 2,
3078 gtk_style_context_restore (context);
3081 if (priv->lower_arrow_visible && !priv->tearoff_active)
3083 gtk_style_context_save (context);
3084 gtk_style_context_set_state (context, priv->lower_arrow_state);
3086 gtk_render_background (context, cr,
3088 lower.width, lower.height);
3089 gtk_render_frame (context, cr,
3091 lower.width, lower.height);
3093 gtk_render_arrow (context, cr, G_PI,
3094 lower.x + (lower.width - arrow_size) / 2,
3095 lower.y + menu_padding.bottom + (arrow_space - arrow_size) / 2,
3098 gtk_style_context_restore (context);
3101 gtk_style_context_restore (context);
3104 if (gtk_cairo_should_draw_window (cr, priv->bin_window))
3106 gint y = -border.y + priv->scroll_offset;
3109 gtk_cairo_transform_to_window (cr, widget, priv->bin_window);
3111 if (!priv->tearoff_active)
3113 GtkBorder arrow_border;
3115 get_arrows_border (menu, &arrow_border);
3116 y -= arrow_border.top;
3119 gtk_render_background (context, cr,
3121 border.width, border.height);
3122 gtk_render_frame (context, cr,
3124 border.width, border.height);
3129 GTK_WIDGET_CLASS (gtk_menu_parent_class)->draw (widget, cr);
3135 gtk_menu_show (GtkWidget *widget)
3137 GtkMenu *menu = GTK_MENU (widget);
3139 _gtk_menu_refresh_accel_paths (menu, FALSE);
3141 GTK_WIDGET_CLASS (gtk_menu_parent_class)->show (widget);
3146 gtk_menu_get_preferred_width (GtkWidget *widget,
3151 GtkMenuShell *menu_shell;
3152 GtkMenuPrivate *priv;
3155 guint max_toggle_size;
3156 guint max_accel_width;
3157 guint horizontal_padding;
3159 gint child_min, child_nat;
3160 gint min_width, nat_width;
3163 menu = GTK_MENU (widget);
3164 menu_shell = GTK_MENU_SHELL (widget);
3167 min_width = nat_width = 0;
3169 max_toggle_size = 0;
3170 max_accel_width = 0;
3172 children = menu_shell->priv->children;
3179 child = children->data;
3180 children = children->next;
3182 if (! gtk_widget_get_visible (child))
3185 get_effective_child_attach (child, &l, &r, &t, &b);
3187 /* It's important to size_request the child
3188 * before doing the toggle size request, in
3189 * case the toggle size request depends on the size
3190 * request of a child of the child (e.g. for ImageMenuItem)
3192 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
3194 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
3195 max_toggle_size = MAX (max_toggle_size, toggle_size);
3196 max_accel_width = MAX (max_accel_width,
3197 GTK_MENU_ITEM (child)->priv->accelerator_width);
3199 part = child_min / (r - l);
3200 min_width = MAX (min_width, part);
3202 part = child_nat / (r - l);
3203 nat_width = MAX (nat_width, part);
3206 /* If the menu doesn't include any images or check items
3207 * reserve the space so that all menus are consistent.
3208 * We only do this for 'ordinary' menus, not for combobox
3209 * menus or multi-column menus
3211 if (max_toggle_size == 0 &&
3212 gtk_menu_get_n_columns (menu) == 1 &&
3213 !priv->no_toggle_size)
3215 GtkStyleContext *context;
3216 GtkWidgetPath *menu_path, *check_path;
3217 guint toggle_spacing;
3218 guint indicator_size;
3220 context = gtk_widget_get_style_context (widget);
3221 menu_path = gtk_widget_path_copy (gtk_style_context_get_path (context));
3223 /* Create a GtkCheckMenuItem path, only to query indicator spacing */
3224 check_path = gtk_widget_path_copy (menu_path);
3225 gtk_widget_path_append_type (check_path, GTK_TYPE_CHECK_MENU_ITEM);
3227 gtk_style_context_set_path (context, check_path);
3228 gtk_widget_path_free (check_path);
3230 gtk_style_context_get_style (context,
3231 "toggle-spacing", &toggle_spacing,
3232 "indicator-size", &indicator_size,
3235 max_toggle_size = indicator_size + toggle_spacing;
3237 /* Restore real widget path */
3238 gtk_style_context_set_path (context, menu_path);
3239 gtk_widget_path_free (menu_path);
3242 min_width += 2 * max_toggle_size + max_accel_width;
3243 min_width *= gtk_menu_get_n_columns (menu);
3245 nat_width += 2 * max_toggle_size + max_accel_width;
3246 nat_width *= gtk_menu_get_n_columns (menu);
3248 gtk_widget_style_get (GTK_WIDGET (menu),
3249 "horizontal-padding", &horizontal_padding,
3252 get_menu_padding (widget, &padding);
3253 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3254 min_width += (2 * (border_width + horizontal_padding)) +
3255 padding.left + padding.right;
3256 nat_width += (2 * (border_width + horizontal_padding)) +
3257 padding.left + padding.right;
3259 priv->toggle_size = max_toggle_size;
3260 priv->accel_size = max_accel_width;
3263 *minimum_size = min_width;
3266 *natural_size = nat_width;
3268 /* Don't resize the tearoff if it is not active,
3269 * because it won't redraw (it is only a background pixmap).
3271 if (priv->tearoff_active)
3272 gtk_menu_set_tearoff_hints (menu, min_width);
3276 gtk_menu_get_preferred_height (GtkWidget *widget,
3282 /* Menus are height-for-width only, just return the height
3283 * for the minimum width
3285 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
3286 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
3290 gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
3296 GtkMenu *menu = GTK_MENU (widget);
3297 GtkMenuPrivate *priv = menu->priv;
3298 guint *min_heights, *nat_heights;
3299 guint vertical_padding, border_width;
3301 gint min_height, nat_height;
3303 gtk_widget_style_get (widget, "vertical-padding", &vertical_padding, NULL);
3304 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3305 get_menu_padding (widget, &padding);
3307 min_height = nat_height = (border_width + vertical_padding) * 2 +
3308 padding.top + padding.bottom;
3311 calculate_line_heights (menu, for_size, &min_heights, &nat_heights);
3313 for (i = 0; i < n_heights; i++)
3315 min_height += min_heights[i];
3316 nat_height += nat_heights[i];
3319 if (priv->have_position)
3321 GdkScreen *screen = gtk_widget_get_screen (priv->toplevel);
3322 GdkRectangle monitor;
3324 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
3326 if (priv->position_y + min_height > monitor.y + monitor.height)
3327 min_height = monitor.y + monitor.height - priv->position_y;
3329 if (priv->position_y + nat_height > monitor.y + monitor.height)
3330 nat_height = monitor.y + monitor.height - priv->position_y;
3332 if (priv->position_y < monitor.y)
3334 min_height -= monitor.y - priv->position_y;
3335 nat_height -= monitor.y - priv->position_y;
3340 *minimum_size = min_height;
3343 *natural_size = nat_height;
3345 g_free (min_heights);
3346 g_free (nat_heights);
3352 gtk_menu_button_scroll (GtkMenu *menu,
3353 GdkEventButton *event)
3355 GtkMenuPrivate *priv = menu->priv;
3357 if (priv->upper_arrow_prelight || priv->lower_arrow_prelight)
3359 gboolean touchscreen_mode;
3361 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3362 "gtk-touchscreen-mode", &touchscreen_mode,
3365 if (touchscreen_mode)
3366 gtk_menu_handle_scrolling (menu,
3367 event->x_root, event->y_root,
3368 event->type == GDK_BUTTON_PRESS,
3378 pointer_in_menu_window (GtkWidget *widget,
3382 GtkMenu *menu = GTK_MENU (widget);
3383 GtkMenuPrivate *priv = menu->priv;
3384 GtkAllocation allocation;
3386 if (gtk_widget_get_mapped (priv->toplevel))
3388 GtkMenuShell *menu_shell;
3389 gint window_x, window_y;
3391 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
3392 &window_x, &window_y);
3394 gtk_widget_get_allocation (widget, &allocation);
3395 if (x_root >= window_x && x_root < window_x + allocation.width &&
3396 y_root >= window_y && y_root < window_y + allocation.height)
3399 menu_shell = GTK_MENU_SHELL (widget);
3401 if (GTK_IS_MENU (menu_shell->priv->parent_menu_shell))
3402 return pointer_in_menu_window (menu_shell->priv->parent_menu_shell,
3410 gtk_menu_button_press (GtkWidget *widget,
3411 GdkEventButton *event)
3413 if (event->type != GDK_BUTTON_PRESS)
3416 /* Don't pass down to menu shell for presses over scroll arrows
3418 if (gtk_menu_button_scroll (GTK_MENU (widget), event))
3421 /* Don't pass down to menu shell if a non-menuitem part of the menu
3422 * was clicked. The check for the event_widget being a GtkMenuShell
3423 * works because we have the pointer grabbed on menu_shell->window
3424 * with owner_events=TRUE, so all events that are either outside
3425 * the menu or on its border are delivered relative to
3426 * menu_shell->window.
3428 if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3429 pointer_in_menu_window (widget, event->x_root, event->y_root))
3432 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_press_event (widget, event);
3436 gtk_menu_button_release (GtkWidget *widget,
3437 GdkEventButton *event)
3439 GtkMenuPrivate *priv = GTK_MENU (widget)->priv;
3441 if (priv->ignore_button_release)
3443 priv->ignore_button_release = FALSE;
3447 if (event->type != GDK_BUTTON_RELEASE)
3450 /* Don't pass down to menu shell for releases over scroll arrows
3452 if (gtk_menu_button_scroll (GTK_MENU (widget), event))
3455 /* Don't pass down to menu shell if a non-menuitem part of the menu
3456 * was clicked (see comment in button_press()).
3458 if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3459 pointer_in_menu_window (widget, event->x_root, event->y_root))
3461 /* Ugly: make sure menu_shell->button gets reset to 0 when we
3462 * bail out early here so it is in a consistent state for the
3463 * next button_press/button_release in GtkMenuShell.
3466 if (GTK_MENU_SHELL (widget)->priv->active)
3467 GTK_MENU_SHELL (widget)->priv->button = 0;
3472 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_release_event (widget, event);
3475 static const gchar *
3476 get_accel_path (GtkWidget *menu_item,
3481 GClosure *accel_closure;
3482 GtkAccelGroup *accel_group;
3484 path = _gtk_widget_get_accel_path (menu_item, locked);
3487 path = GTK_MENU_ITEM (menu_item)->priv->accel_path;
3493 label = gtk_bin_get_child (GTK_BIN (menu_item));
3495 if (GTK_IS_ACCEL_LABEL (label))
3497 g_object_get (label,
3498 "accel-closure", &accel_closure,
3502 accel_group = gtk_accel_group_from_accel_closure (accel_closure);
3504 *locked = gtk_accel_group_get_is_locked (accel_group);
3514 gtk_menu_key_press (GtkWidget *widget,
3517 GtkMenuShell *menu_shell;
3519 gboolean delete = FALSE;
3520 gboolean can_change_accels;
3521 gchar *accel = NULL;
3522 guint accel_key, accel_mods;
3523 GdkModifierType consumed_modifiers;
3524 GdkDisplay *display;
3526 g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
3527 g_return_val_if_fail (event != NULL, FALSE);
3529 menu_shell = GTK_MENU_SHELL (widget);
3530 menu = GTK_MENU (widget);
3532 gtk_menu_stop_navigating_submenu (menu);
3534 if (GTK_WIDGET_CLASS (gtk_menu_parent_class)->key_press_event (widget, event))
3537 display = gtk_widget_get_display (widget);
3539 g_object_get (gtk_widget_get_settings (widget),
3540 "gtk-menu-bar-accel", &accel,
3541 "gtk-can-change-accels", &can_change_accels,
3544 if (accel && *accel)
3547 GdkModifierType mods = 0;
3549 gtk_accelerator_parse (accel, &keyval, &mods);
3552 g_warning ("Failed to parse menu bar accelerator '%s'\n", accel);
3554 /* FIXME this is wrong, needs to be in the global accel resolution
3555 * thing, to properly consider i18n etc., but that probably requires
3556 * AccelGroup changes etc.
3558 if (event->keyval == keyval && (mods & event->state) == mods)
3560 gtk_menu_shell_cancel (menu_shell);
3568 switch (event->keyval)
3570 case GDK_KEY_Delete:
3571 case GDK_KEY_KP_Delete:
3572 case GDK_KEY_BackSpace:
3579 /* Figure out what modifiers went into determining the key symbol */
3580 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
3581 event->hardware_keycode,
3582 event->state, event->group,
3583 NULL, NULL, NULL, &consumed_modifiers);
3585 accel_key = gdk_keyval_to_lower (event->keyval);
3586 accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
3588 /* If lowercasing affects the keysym, then we need to include SHIFT
3589 * in the modifiers, we re-uppercase when we match against the keyval,
3590 * but display and save in caseless form.
3592 if (accel_key != event->keyval)
3593 accel_mods |= GDK_SHIFT_MASK;
3595 /* Modify the accelerators */
3596 if (can_change_accels &&
3597 menu_shell->priv->active_menu_item &&
3598 gtk_bin_get_child (GTK_BIN (menu_shell->priv->active_menu_item)) && /* no separators */
3599 GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu == NULL && /* no submenus */
3600 (delete || gtk_accelerator_valid (accel_key, accel_mods)))
3602 GtkWidget *menu_item = menu_shell->priv->active_menu_item;
3603 gboolean locked, replace_accels = TRUE;
3606 path = get_accel_path (menu_item, &locked);
3607 if (!path || locked)
3609 /* Can't change accelerators on menu_items without paths
3610 * (basically, those items are accelerator-locked).
3612 gtk_widget_error_bell (widget);
3618 /* For the keys that act to delete the current setting,
3619 * we delete the current setting if there is one, otherwise,
3620 * we set the key as the accelerator.
3626 if (gtk_accel_map_lookup_entry (path, &key) &&
3627 (key.accel_key || key.accel_mods))
3633 changed = gtk_accel_map_change_entry (path, accel_key, accel_mods, replace_accels);
3637 /* We failed, probably because this key is in use
3638 * and locked already.
3640 gtk_widget_error_bell (widget);
3649 check_threshold (GtkWidget *widget,
3658 ABS (start_x - x) > THRESHOLD ||
3659 ABS (start_y - y) > THRESHOLD;
3663 definitely_within_item (GtkWidget *widget,
3667 GdkWindow *window = GTK_MENU_ITEM (widget)->priv->event_window;
3670 w = gdk_window_get_width (window);
3671 h = gdk_window_get_height (window);
3674 check_threshold (widget, 0, 0, x, y) &&
3675 check_threshold (widget, w - 1, 0, x, y) &&
3676 check_threshold (widget, w - 1, h - 1, x, y) &&
3677 check_threshold (widget, 0, h - 1, x, y);
3681 gtk_menu_has_navigation_triangle (GtkMenu *menu)
3683 GtkMenuPrivate *priv = menu->priv;
3685 return priv->navigation_height && priv->navigation_width;
3689 gtk_menu_motion_notify (GtkWidget *widget,
3690 GdkEventMotion *event)
3692 GtkWidget *menu_item;
3694 GtkMenuShell *menu_shell;
3697 gboolean need_enter;
3699 if (GTK_IS_MENU (widget))
3701 GtkMenuPrivate *priv = GTK_MENU(widget)->priv;
3703 if (priv->ignore_button_release)
3704 priv->ignore_button_release = FALSE;
3706 gtk_menu_handle_scrolling (GTK_MENU (widget), event->x_root, event->y_root,
3710 /* We received the event for one of two reasons:
3712 * a) We are the active menu, and did gtk_grab_add()
3713 * b) The widget is a child of ours, and the event was propagated
3715 * Since for computation of navigation regions, we want the menu which
3716 * is the parent of the menu item, for a), we need to find that menu,
3717 * which may be different from 'widget'.
3719 menu_item = gtk_get_event_widget ((GdkEvent*) event);
3720 parent = gtk_widget_get_parent (menu_item);
3721 if (!GTK_IS_MENU_ITEM (menu_item) ||
3722 !GTK_IS_MENU (parent))
3725 menu_shell = GTK_MENU_SHELL (parent);
3726 menu = GTK_MENU (menu_shell);
3728 if (definitely_within_item (menu_item, event->x, event->y))
3729 menu_shell->priv->activate_time = 0;
3731 need_enter = (gtk_menu_has_navigation_triangle (menu) || menu_shell->priv->ignore_enter);
3733 /* Check to see if we are within an active submenu's navigation region
3735 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
3738 /* Make sure we pop down if we enter a non-selectable menu item, so we
3739 * don't show a submenu when the cursor is outside the stay-up triangle.
3741 if (!_gtk_menu_item_is_selectable (menu_item))
3743 /* We really want to deselect, but this gives the menushell code
3744 * a chance to do some bookkeeping about the menuitem.
3746 gtk_menu_shell_select_item (menu_shell, menu_item);
3752 /* The menu is now sensitive to enter events on its items, but
3753 * was previously sensitive. So we fake an enter event.
3755 menu_shell->priv->ignore_enter = FALSE;
3757 if (event->x >= 0 && event->x < gdk_window_get_width (event->window) &&
3758 event->y >= 0 && event->y < gdk_window_get_height (event->window))
3760 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
3763 send_event->crossing.window = g_object_ref (event->window);
3764 send_event->crossing.time = event->time;
3765 send_event->crossing.send_event = TRUE;
3766 send_event->crossing.x_root = event->x_root;
3767 send_event->crossing.y_root = event->y_root;
3768 send_event->crossing.x = event->x;
3769 send_event->crossing.y = event->y;
3770 send_event->crossing.state = event->state;
3771 gdk_event_set_device (send_event, gdk_event_get_device ((GdkEvent *) event));
3773 /* We send the event to 'widget', the currently active menu,
3774 * instead of 'menu', the menu that the pointer is in. This
3775 * will ensure that the event will be ignored unless the
3776 * menuitem is a child of the active menu or some parent
3777 * menu of the active menu.
3779 result = gtk_widget_event (widget, send_event);
3780 gdk_event_free (send_event);
3790 get_double_arrows (GtkMenu *menu)
3792 GtkMenuPrivate *priv = menu->priv;
3793 gboolean double_arrows;
3794 GtkArrowPlacement arrow_placement;
3796 gtk_widget_style_get (GTK_WIDGET (menu),
3797 "double-arrows", &double_arrows,
3798 "arrow-placement", &arrow_placement,
3801 if (arrow_placement != GTK_ARROWS_BOTH)
3804 return double_arrows || (priv->initially_pushed_in &&
3805 priv->scroll_offset != 0);
3809 gtk_menu_scroll_by (GtkMenu *menu,
3812 GtkMenuPrivate *priv = menu->priv;
3813 GtkBorder arrow_border;
3817 gboolean double_arrows;
3819 widget = GTK_WIDGET (menu);
3820 offset = priv->scroll_offset + step;
3822 get_arrows_border (menu, &arrow_border);
3824 double_arrows = get_double_arrows (menu);
3826 /* If we scroll upward and the non-visible top part
3827 * is smaller than the scroll arrow it would be
3828 * pretty stupid to show the arrow and taking more
3829 * screen space than just scrolling to the top.
3832 if ((step < 0) && (offset < arrow_border.top))
3835 /* Don't scroll over the top if we weren't before: */
3836 if ((priv->scroll_offset >= 0) && (offset < 0))
3839 view_height = gdk_window_get_height (gtk_widget_get_window (widget));
3841 if (priv->scroll_offset == 0 &&
3842 view_height >= priv->requested_height)
3845 /* Don't scroll past the bottom if we weren't before: */
3846 if (priv->scroll_offset > 0)
3847 view_height -= arrow_border.top;
3849 /* When both arrows are always shown,
3850 * reduce view height even more.
3853 view_height -= arrow_border.bottom;
3855 if ((priv->scroll_offset + view_height <= priv->requested_height) &&
3856 (offset + view_height > priv->requested_height))
3857 offset = priv->requested_height - view_height;
3859 if (offset != priv->scroll_offset)
3860 gtk_menu_scroll_to (menu, offset);
3864 gtk_menu_do_timeout_scroll (GtkMenu *menu,
3865 gboolean touchscreen_mode)
3867 GtkMenuPrivate *priv = menu->priv;
3868 gboolean upper_visible;
3869 gboolean lower_visible;
3871 upper_visible = priv->upper_arrow_visible;
3872 lower_visible = priv->lower_arrow_visible;
3874 gtk_menu_scroll_by (menu, priv->scroll_step);
3876 if (touchscreen_mode &&
3877 (upper_visible != priv->upper_arrow_visible ||
3878 lower_visible != priv->lower_arrow_visible))
3880 /* We are about to hide a scroll arrow while the mouse is pressed,
3881 * this would cause the uncovered menu item to be activated on button
3882 * release. Therefore we need to ignore button release here
3884 GTK_MENU_SHELL (menu)->priv->ignore_enter = TRUE;
3885 priv->ignore_button_release = TRUE;
3890 gtk_menu_scroll_timeout (gpointer data)
3893 gboolean touchscreen_mode;
3895 menu = GTK_MENU (data);
3897 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3898 "gtk-touchscreen-mode", &touchscreen_mode,
3901 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3907 gtk_menu_scroll_timeout_initial (gpointer data)
3911 gboolean touchscreen_mode;
3913 menu = GTK_MENU (data);
3915 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3916 "gtk-timeout-repeat", &timeout,
3917 "gtk-touchscreen-mode", &touchscreen_mode,
3920 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3922 gtk_menu_remove_scroll_timeout (menu);
3924 menu->priv->scroll_timeout =
3925 gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout, menu);
3931 gtk_menu_start_scrolling (GtkMenu *menu)
3934 gboolean touchscreen_mode;
3936 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3937 "gtk-timeout-repeat", &timeout,
3938 "gtk-touchscreen-mode", &touchscreen_mode,
3941 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3943 menu->priv->scroll_timeout =
3944 gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout_initial, menu);
3948 gtk_menu_scroll (GtkWidget *widget,
3949 GdkEventScroll *event)
3951 GtkMenu *menu = GTK_MENU (widget);
3953 switch (event->direction)
3955 case GDK_SCROLL_RIGHT:
3956 case GDK_SCROLL_DOWN:
3957 gtk_menu_scroll_by (menu, MENU_SCROLL_STEP2);
3959 case GDK_SCROLL_LEFT:
3961 gtk_menu_scroll_by (menu, - MENU_SCROLL_STEP2);
3969 get_arrows_sensitive_area (GtkMenu *menu,
3970 GdkRectangle *upper,
3971 GdkRectangle *lower)
3973 GtkArrowPlacement arrow_placement;
3974 GtkWidget *widget = GTK_WIDGET (menu);
3978 guint vertical_padding;
3980 gint scroll_arrow_height;
3983 window = gtk_widget_get_window (widget);
3984 width = gdk_window_get_width (window);
3985 height = gdk_window_get_height (window);
3987 gtk_widget_style_get (widget,
3988 "vertical-padding", &vertical_padding,
3989 "scroll-arrow-vlength", &scroll_arrow_height,
3990 "arrow-placement", &arrow_placement,
3993 border = gtk_container_get_border_width (GTK_CONTAINER (menu)) + vertical_padding;
3994 get_menu_padding (widget, &padding);
3996 gdk_window_get_position (window, &win_x, &win_y);
3998 switch (arrow_placement)
4000 case GTK_ARROWS_BOTH:
4005 upper->width = width;
4006 upper->height = scroll_arrow_height + border + padding.top;
4012 lower->y = win_y + height - border - padding.bottom - scroll_arrow_height;
4013 lower->width = width;
4014 lower->height = scroll_arrow_height + border + padding.bottom;
4018 case GTK_ARROWS_START:
4023 upper->width = width / 2;
4024 upper->height = scroll_arrow_height + border + padding.top;
4029 lower->x = win_x + width / 2;
4031 lower->width = width / 2;
4032 lower->height = scroll_arrow_height + border + padding.bottom;
4036 case GTK_ARROWS_END:
4040 upper->y = win_y + height - border - scroll_arrow_height;
4041 upper->width = width / 2;
4042 upper->height = scroll_arrow_height + border + padding.top;
4047 lower->x = win_x + width / 2;
4048 lower->y = win_y + height - border - scroll_arrow_height;
4049 lower->width = width / 2;
4050 lower->height = scroll_arrow_height + border + padding.bottom;
4058 gtk_menu_handle_scrolling (GtkMenu *menu,
4064 GtkMenuPrivate *priv = menu->priv;
4065 GtkMenuShell *menu_shell;
4068 gboolean scroll_fast = FALSE;
4070 gboolean touchscreen_mode;
4072 menu_shell = GTK_MENU_SHELL (menu);
4074 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4075 "gtk-touchscreen-mode", &touchscreen_mode,
4078 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
4083 /* upper arrow handling */
4085 get_arrows_sensitive_area (menu, &rect, NULL);
4088 if (priv->upper_arrow_visible && !priv->tearoff_active &&
4089 (x >= rect.x) && (x < rect.x + rect.width) &&
4090 (y >= rect.y) && (y < rect.y + rect.height))
4095 if (touchscreen_mode)
4096 priv->upper_arrow_prelight = in_arrow;
4098 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4100 gboolean arrow_pressed = FALSE;
4102 if (priv->upper_arrow_visible && !priv->tearoff_active)
4104 if (touchscreen_mode)
4106 if (enter && priv->upper_arrow_prelight)
4108 if (priv->scroll_timeout == 0)
4110 /* Deselect the active item so that
4111 * any submenus are popped down
4113 gtk_menu_shell_deselect (menu_shell);
4115 gtk_menu_remove_scroll_timeout (menu);
4116 priv->scroll_step = -MENU_SCROLL_STEP2; /* always fast */
4120 /* Only do stuff on click. */
4121 gtk_menu_start_scrolling (menu);
4122 arrow_pressed = TRUE;
4127 arrow_pressed = TRUE;
4132 gtk_menu_stop_scrolling (menu);
4135 else /* !touchscreen_mode */
4137 scroll_fast = (y < rect.y + MENU_SCROLL_FAST_ZONE);
4139 if (enter && in_arrow &&
4140 (!priv->upper_arrow_prelight ||
4141 priv->scroll_fast != scroll_fast))
4143 priv->upper_arrow_prelight = TRUE;
4144 priv->scroll_fast = scroll_fast;
4146 /* Deselect the active item so that
4147 * any submenus are popped down
4149 gtk_menu_shell_deselect (menu_shell);
4151 gtk_menu_remove_scroll_timeout (menu);
4152 priv->scroll_step = scroll_fast
4153 ? -MENU_SCROLL_STEP2
4154 : -MENU_SCROLL_STEP1;
4156 priv->scroll_timeout =
4157 gdk_threads_add_timeout (scroll_fast
4158 ? MENU_SCROLL_TIMEOUT2
4159 : MENU_SCROLL_TIMEOUT1,
4160 gtk_menu_scroll_timeout, menu);
4162 else if (!enter && !in_arrow && priv->upper_arrow_prelight)
4164 gtk_menu_stop_scrolling (menu);
4169 /* gtk_menu_start_scrolling() might have hit the top of the
4170 * menu, so check if the button isn't insensitive before
4171 * changing it to something else.
4173 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4175 GtkStateFlags arrow_state = 0;
4178 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4180 if (priv->upper_arrow_prelight)
4181 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4183 if (arrow_state != priv->upper_arrow_state)
4185 priv->upper_arrow_state = arrow_state;
4187 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4193 /* lower arrow handling */
4195 get_arrows_sensitive_area (menu, NULL, &rect);
4198 if (priv->lower_arrow_visible && !priv->tearoff_active &&
4199 (x >= rect.x) && (x < rect.x + rect.width) &&
4200 (y >= rect.y) && (y < rect.y + rect.height))
4205 if (touchscreen_mode)
4206 priv->lower_arrow_prelight = in_arrow;
4208 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4210 gboolean arrow_pressed = FALSE;
4212 if (priv->lower_arrow_visible && !priv->tearoff_active)
4214 if (touchscreen_mode)
4216 if (enter && priv->lower_arrow_prelight)
4218 if (priv->scroll_timeout == 0)
4220 /* Deselect the active item so that
4221 * any submenus are popped down
4223 gtk_menu_shell_deselect (menu_shell);
4225 gtk_menu_remove_scroll_timeout (menu);
4226 priv->scroll_step = MENU_SCROLL_STEP2; /* always fast */
4230 /* Only do stuff on click. */
4231 gtk_menu_start_scrolling (menu);
4232 arrow_pressed = TRUE;
4237 arrow_pressed = TRUE;
4242 gtk_menu_stop_scrolling (menu);
4245 else /* !touchscreen_mode */
4247 scroll_fast = (y > rect.y + rect.height - MENU_SCROLL_FAST_ZONE);
4249 if (enter && in_arrow &&
4250 (!priv->lower_arrow_prelight ||
4251 priv->scroll_fast != scroll_fast))
4253 priv->lower_arrow_prelight = TRUE;
4254 priv->scroll_fast = scroll_fast;
4256 /* Deselect the active item so that
4257 * any submenus are popped down
4259 gtk_menu_shell_deselect (menu_shell);
4261 gtk_menu_remove_scroll_timeout (menu);
4262 priv->scroll_step = scroll_fast
4264 : MENU_SCROLL_STEP1;
4266 priv->scroll_timeout =
4267 gdk_threads_add_timeout (scroll_fast
4268 ? MENU_SCROLL_TIMEOUT2
4269 : MENU_SCROLL_TIMEOUT1,
4270 gtk_menu_scroll_timeout, menu);
4272 else if (!enter && !in_arrow && priv->lower_arrow_prelight)
4274 gtk_menu_stop_scrolling (menu);
4279 /* gtk_menu_start_scrolling() might have hit the bottom of the
4280 * menu, so check if the button isn't insensitive before
4281 * changing it to something else.
4283 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4285 GtkStateFlags arrow_state = 0;
4288 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4290 if (priv->lower_arrow_prelight)
4291 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4293 if (arrow_state != priv->lower_arrow_state)
4295 priv->lower_arrow_state = arrow_state;
4297 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4305 gtk_menu_enter_notify (GtkWidget *widget,
4306 GdkEventCrossing *event)
4308 GtkWidget *menu_item;
4310 gboolean touchscreen_mode;
4312 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4313 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4314 event->mode == GDK_CROSSING_STATE_CHANGED)
4317 g_object_get (gtk_widget_get_settings (widget),
4318 "gtk-touchscreen-mode", &touchscreen_mode,
4321 menu_item = gtk_get_event_widget ((GdkEvent*) event);
4322 if (GTK_IS_MENU (widget))
4324 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
4326 if (!menu_shell->priv->ignore_enter)
4327 gtk_menu_handle_scrolling (GTK_MENU (widget),
4328 event->x_root, event->y_root, TRUE, TRUE);
4331 if (!touchscreen_mode && GTK_IS_MENU_ITEM (menu_item))
4333 GtkWidget *menu = gtk_widget_get_parent (menu_item);
4335 if (GTK_IS_MENU (menu))
4337 GtkMenuPrivate *priv = (GTK_MENU (menu))->priv;
4338 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
4340 if (priv->seen_item_enter)
4342 /* This is the second enter we see for an item
4343 * on this menu. This means a release should always
4346 menu_shell->priv->activate_time = 0;
4348 else if ((event->detail != GDK_NOTIFY_NONLINEAR &&
4349 event->detail != GDK_NOTIFY_NONLINEAR_VIRTUAL))
4351 if (definitely_within_item (menu_item, event->x, event->y))
4353 /* This is an actual user-enter (ie. not a pop-under)
4354 * In this case, the user must either have entered
4355 * sufficiently far enough into the item, or he must move
4356 * far enough away from the enter point. (see
4357 * gtk_menu_motion_notify())
4359 menu_shell->priv->activate_time = 0;
4363 priv->seen_item_enter = TRUE;
4367 /* If this is a faked enter (see gtk_menu_motion_notify), 'widget'
4368 * will not correspond to the event widget's parent. Check to see
4369 * if we are in the parent's navigation region.
4371 parent = gtk_widget_get_parent (menu_item);
4372 if (GTK_IS_MENU_ITEM (menu_item) && GTK_IS_MENU (parent) &&
4373 gtk_menu_navigating_submenu (GTK_MENU (parent),
4374 event->x_root, event->y_root))
4377 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (widget, event);
4381 gtk_menu_leave_notify (GtkWidget *widget,
4382 GdkEventCrossing *event)
4384 GtkMenuShell *menu_shell;
4386 GtkMenuItem *menu_item;
4387 GtkWidget *event_widget;
4389 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4390 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4391 event->mode == GDK_CROSSING_STATE_CHANGED)
4394 menu = GTK_MENU (widget);
4395 menu_shell = GTK_MENU_SHELL (widget);
4397 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
4400 gtk_menu_handle_scrolling (menu, event->x_root, event->y_root, FALSE, TRUE);
4402 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4404 if (!GTK_IS_MENU_ITEM (event_widget))
4407 menu_item = GTK_MENU_ITEM (event_widget);
4409 /* Here we check to see if we're leaving an active menu item
4410 * with a submenu, in which case we enter submenu navigation mode.
4412 if (menu_shell->priv->active_menu_item != NULL
4413 && menu_item->priv->submenu != NULL
4414 && menu_item->priv->submenu_placement == GTK_LEFT_RIGHT)
4416 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active)
4418 gtk_menu_set_submenu_navigation_region (menu, menu_item, event);
4421 else if (menu_item == GTK_MENU_ITEM (menu_shell->priv->active_menu_item))
4423 /* We are leaving an active menu item with nonactive submenu.
4424 * Deselect it so we don't surprise the user with by popping
4425 * up a submenu _after_ he left the item.
4427 gtk_menu_shell_deselect (menu_shell);
4432 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->leave_notify_event (widget, event);
4436 gtk_menu_stop_navigating_submenu (GtkMenu *menu)
4438 GtkMenuPrivate *priv = menu->priv;
4440 priv->navigation_x = 0;
4441 priv->navigation_y = 0;
4442 priv->navigation_width = 0;
4443 priv->navigation_height = 0;
4445 if (priv->navigation_timeout)
4447 g_source_remove (priv->navigation_timeout);
4448 priv->navigation_timeout = 0;
4452 /* When the timeout is elapsed, the navigation region is destroyed
4453 * and the menuitem under the pointer (if any) is selected.
4456 gtk_menu_stop_navigating_submenu_cb (gpointer user_data)
4458 GtkMenuPopdownData *popdown_data = user_data;
4459 GtkMenu *menu = popdown_data->menu;
4460 GtkMenuPrivate *priv = menu->priv;
4461 GdkWindow *child_window;
4463 gtk_menu_stop_navigating_submenu (menu);
4465 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
4467 child_window = gdk_window_get_device_position (priv->bin_window,
4468 popdown_data->device,
4473 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
4475 send_event->crossing.window = g_object_ref (child_window);
4476 send_event->crossing.time = GDK_CURRENT_TIME; /* Bogus */
4477 send_event->crossing.send_event = TRUE;
4478 gdk_event_set_device (send_event, popdown_data->device);
4480 GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (GTK_WIDGET (menu), (GdkEventCrossing *)send_event);
4482 gdk_event_free (send_event);
4490 gtk_menu_navigating_submenu (GtkMenu *menu,
4494 GtkMenuPrivate *priv = menu->priv;
4497 if (!gtk_menu_has_navigation_triangle (menu))
4500 width = priv->navigation_width;
4501 height = priv->navigation_height;
4503 /* Check if x/y are in the triangle spanned by the navigation parameters */
4505 /* 1) Move the coordinates so the triangle starts at 0,0 */
4506 event_x -= priv->navigation_x;
4507 event_y -= priv->navigation_y;
4509 /* 2) Ensure both legs move along the positive axis */
4521 /* 3) Check that the given coordinate is inside the triangle. The formula
4522 * is a transformed form of this formula: x/w + y/h <= 1
4524 if (event_x >= 0 && event_y >= 0 &&
4525 event_x * height + event_y * width <= width * height)
4531 gtk_menu_stop_navigating_submenu (menu);
4537 gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
4538 GtkMenuItem *menu_item,
4539 GdkEventCrossing *event)
4541 GtkMenuPrivate *priv = menu->priv;
4542 gint submenu_left = 0;
4543 gint submenu_right = 0;
4544 gint submenu_top = 0;
4545 gint submenu_bottom = 0;
4547 GtkWidget *event_widget;
4548 GtkMenuPopdownData *popdown_data;
4551 g_return_if_fail (menu_item->priv->submenu != NULL);
4552 g_return_if_fail (event != NULL);
4554 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4556 window = gtk_widget_get_window (menu_item->priv->submenu);
4557 gdk_window_get_origin (window, &submenu_left, &submenu_top);
4559 submenu_right = submenu_left + gdk_window_get_width (window);
4560 submenu_bottom = submenu_top + gdk_window_get_height (window);
4562 width = gdk_window_get_width (gtk_widget_get_window (event_widget));
4564 if (event->x >= 0 && event->x < width)
4568 gtk_menu_stop_navigating_submenu (menu);
4570 /* The navigation region is the triangle closest to the x/y
4571 * location of the rectangle. This is why the width or height
4574 if (menu_item->priv->submenu_direction == GTK_DIRECTION_RIGHT)
4577 priv->navigation_x = submenu_left;
4578 priv->navigation_width = event->x_root - submenu_left;
4583 priv->navigation_x = submenu_right;
4584 priv->navigation_width = event->x_root - submenu_right;
4590 priv->navigation_y = event->y_root;
4591 priv->navigation_height = submenu_top - event->y_root - NAVIGATION_REGION_OVERSHOOT;
4593 if (priv->navigation_height >= 0)
4599 priv->navigation_y = event->y_root;
4600 priv->navigation_height = submenu_bottom - event->y_root + NAVIGATION_REGION_OVERSHOOT;
4602 if (priv->navigation_height <= 0)
4606 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4607 "gtk-menu-popdown-delay", &popdown_delay,
4610 popdown_data = g_new (GtkMenuPopdownData, 1);
4611 popdown_data->menu = menu;
4612 popdown_data->device = gdk_event_get_device ((GdkEvent *) event);
4614 priv->navigation_timeout = gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
4616 gtk_menu_stop_navigating_submenu_cb,
4618 (GDestroyNotify) g_free);
4623 gtk_menu_deactivate (GtkMenuShell *menu_shell)
4627 g_return_if_fail (GTK_IS_MENU (menu_shell));
4629 parent = menu_shell->priv->parent_menu_shell;
4631 menu_shell->priv->activate_time = 0;
4632 gtk_menu_popdown (GTK_MENU (menu_shell));
4635 gtk_menu_shell_deactivate (GTK_MENU_SHELL (parent));
4639 gtk_menu_position (GtkMenu *menu,
4640 gboolean set_scroll_offset)
4642 GtkMenuPrivate *priv = menu->priv;
4644 GtkRequisition requisition;
4649 GdkScreen *pointer_screen;
4650 GdkRectangle monitor;
4653 widget = GTK_WIDGET (menu);
4655 screen = gtk_widget_get_screen (widget);
4656 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (menu));
4657 gdk_device_get_position (pointer, &pointer_screen, &x, &y);
4659 /* Get the minimum height for minimum width to figure out
4660 * the right place to popup the menu.
4662 gtk_widget_get_preferred_size (widget, &requisition, NULL);
4664 if (pointer_screen != screen)
4666 /* Pointer is on a different screen; roughly center the
4667 * menu on the screen. If someone was using multiscreen
4668 * + Xinerama together they'd probably want something
4669 * fancier; but that is likely to be vanishingly rare.
4671 x = MAX (0, (gdk_screen_get_width (screen) - requisition.width) / 2);
4672 y = MAX (0, (gdk_screen_get_height (screen) - requisition.height) / 2);
4675 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4676 priv->initially_pushed_in = FALSE;
4678 /* Set the type hint here to allow custom position functions
4679 * to set a different hint
4681 if (!gtk_widget_get_visible (priv->toplevel))
4682 gtk_window_set_type_hint (GTK_WINDOW (priv->toplevel), GDK_WINDOW_TYPE_HINT_POPUP_MENU);
4684 if (priv->position_func)
4686 (* priv->position_func) (menu, &x, &y, &priv->initially_pushed_in,
4687 priv->position_func_data);
4689 if (priv->monitor_num < 0)
4690 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4692 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
4696 gint space_left, space_right, space_above, space_below;
4700 gboolean rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
4702 get_menu_padding (widget, &padding);
4704 /* The placement of popup menus horizontally works like this (with
4705 * RTL in parentheses)
4707 * - If there is enough room to the right (left) of the mouse cursor,
4708 * position the menu there.
4710 * - Otherwise, if if there is enough room to the left (right) of the
4711 * mouse cursor, position the menu there.
4713 * - Otherwise if the menu is smaller than the monitor, position it
4714 * on the side of the mouse cursor that has the most space available
4716 * - Otherwise (if there is simply not enough room for the menu on the
4717 * monitor), position it as far left (right) as possible.
4719 * Positioning in the vertical direction is similar: first try below
4720 * mouse cursor, then above.
4722 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
4724 space_left = x - monitor.x;
4725 space_right = monitor.x + monitor.width - x - 1;
4726 space_above = y - monitor.y;
4727 space_below = monitor.y + monitor.height - y - 1;
4729 /* Position horizontally. */
4731 /* the amount of space we need to position the menu.
4732 * Note the menu is offset "thickness" pixels
4734 needed_width = requisition.width - padding.left;
4736 if (needed_width <= space_left ||
4737 needed_width <= space_right)
4739 if ((rtl && needed_width <= space_left) ||
4740 (!rtl && needed_width > space_right))
4743 x = x + padding.left - requisition.width + 1;
4747 /* position right */
4748 x = x - padding.right;
4751 /* x is clamped on-screen further down */
4753 else if (requisition.width <= monitor.width)
4755 /* the menu is too big to fit on either side of the mouse
4756 * cursor, but smaller than the monitor. Position it on
4757 * the side that has the most space
4759 if (space_left > space_right)
4767 x = monitor.x + monitor.width - requisition.width;
4770 else /* menu is simply too big for the monitor */
4775 x = monitor.x + monitor.width - requisition.width;
4784 /* Position vertically.
4785 * The algorithm is the same as above, but simpler
4786 * because we don't have to take RTL into account.
4788 needed_height = requisition.height - padding.top;
4790 if (needed_height <= space_above ||
4791 needed_height <= space_below)
4793 if (needed_height <= space_below)
4794 y = y - padding.top;
4796 y = y + padding.bottom - requisition.height + 1;
4798 y = CLAMP (y, monitor.y,
4799 monitor.y + monitor.height - requisition.height);
4801 else if (needed_height > space_below && needed_height > space_above)
4803 if (space_below >= space_above)
4804 y = monitor.y + monitor.height - requisition.height;
4816 if (priv->initially_pushed_in)
4818 menu_height = requisition.height;
4820 if (y + menu_height > monitor.y + monitor.height)
4822 scroll_offset -= y + menu_height - (monitor.y + monitor.height);
4823 y = (monitor.y + monitor.height) - menu_height;
4828 scroll_offset += monitor.y - y;
4833 /* FIXME: should this be done in the various position_funcs ? */
4834 x = CLAMP (x, monitor.x, MAX (monitor.x, monitor.x + monitor.width - requisition.width));
4836 if (GTK_MENU_SHELL (menu)->priv->active)
4838 priv->have_position = TRUE;
4839 priv->position_x = x;
4840 priv->position_y = y;
4843 if (y + requisition.height > monitor.y + monitor.height)
4844 requisition.height = (monitor.y + monitor.height) - y;
4848 scroll_offset += monitor.y - y;
4849 requisition.height -= monitor.y - y;
4853 if (scroll_offset > 0)
4855 GtkBorder arrow_border;
4857 get_arrows_border (menu, &arrow_border);
4858 scroll_offset += arrow_border.top;
4861 gtk_window_move (GTK_WINDOW (GTK_MENU_SHELL (menu)->priv->active ? priv->toplevel : priv->tearoff_window),
4864 if (!GTK_MENU_SHELL (menu)->priv->active)
4866 gtk_window_resize (GTK_WINDOW (priv->tearoff_window),
4867 requisition.width, requisition.height);
4870 if (set_scroll_offset)
4871 priv->scroll_offset = scroll_offset;
4875 gtk_menu_remove_scroll_timeout (GtkMenu *menu)
4877 GtkMenuPrivate *priv = menu->priv;
4879 if (priv->scroll_timeout)
4881 g_source_remove (priv->scroll_timeout);
4882 priv->scroll_timeout = 0;
4887 gtk_menu_stop_scrolling (GtkMenu *menu)
4889 GtkMenuPrivate *priv = menu->priv;
4890 gboolean touchscreen_mode;
4892 gtk_menu_remove_scroll_timeout (menu);
4894 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4895 "gtk-touchscreen-mode", &touchscreen_mode,
4898 if (!touchscreen_mode)
4900 priv->upper_arrow_prelight = FALSE;
4901 priv->lower_arrow_prelight = FALSE;
4906 gtk_menu_scroll_to (GtkMenu *menu,
4909 GtkMenuPrivate *priv = menu->priv;
4910 GtkAllocation allocation;
4911 GtkBorder arrow_border, padding;
4914 gint view_width, view_height;
4917 guint vertical_padding;
4918 guint horizontal_padding;
4919 gboolean double_arrows;
4921 widget = GTK_WIDGET (menu);
4923 if (priv->tearoff_active && priv->tearoff_adjustment)
4924 gtk_adjustment_set_value (priv->tearoff_adjustment, offset);
4926 /* Move/resize the viewport according to arrows: */
4927 gtk_widget_get_allocation (widget, &allocation);
4928 view_width = allocation.width;
4929 view_height = allocation.height;
4931 gtk_widget_style_get (GTK_WIDGET (menu),
4932 "vertical-padding", &vertical_padding,
4933 "horizontal-padding", &horizontal_padding,
4936 get_menu_padding (widget, &padding);
4937 double_arrows = get_double_arrows (menu);
4939 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
4941 view_width -= (2 * (border_width + horizontal_padding)) + padding.left + padding.right;
4942 view_height -= (2 * (border_width + vertical_padding)) + padding.top + padding.bottom;
4943 menu_height = priv->requested_height - (2 * (border_width + vertical_padding)) -
4944 padding.top - padding.bottom;
4946 x = border_width + padding.left + horizontal_padding;
4947 y = border_width + padding.top + vertical_padding;
4949 if (double_arrows && !priv->tearoff_active)
4951 if (view_height < menu_height ||
4952 (offset > 0 && priv->scroll_offset > 0) ||
4953 (offset < 0 && priv->scroll_offset < 0))
4955 GtkStateFlags upper_arrow_previous_state = priv->upper_arrow_state;
4956 GtkStateFlags lower_arrow_previous_state = priv->lower_arrow_state;
4958 if (!priv->upper_arrow_visible || !priv->lower_arrow_visible)
4959 gtk_widget_queue_draw (GTK_WIDGET (menu));
4961 priv->upper_arrow_visible = priv->lower_arrow_visible = TRUE;
4963 get_arrows_border (menu, &arrow_border);
4964 y += arrow_border.top;
4965 view_height -= arrow_border.top;
4966 view_height -= arrow_border.bottom;
4969 priv->upper_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
4972 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
4974 if (priv->upper_arrow_prelight)
4975 priv->upper_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4977 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
4980 if (offset >= menu_height - view_height)
4981 priv->lower_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
4984 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
4986 if (priv->lower_arrow_prelight)
4987 priv->lower_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4989 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
4992 if ((priv->upper_arrow_state != upper_arrow_previous_state) ||
4993 (priv->lower_arrow_state != lower_arrow_previous_state))
4994 gtk_widget_queue_draw (GTK_WIDGET (menu));
4996 if ((upper_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
4997 (priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
4999 /* At the upper border, possibly remove timeout */
5000 if (priv->scroll_step < 0)
5002 gtk_menu_stop_scrolling (menu);
5003 gtk_widget_queue_draw (GTK_WIDGET (menu));
5007 if ((lower_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
5008 (priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
5010 /* At the lower border, possibly remove timeout */
5011 if (priv->scroll_step > 0)
5013 gtk_menu_stop_scrolling (menu);
5014 gtk_widget_queue_draw (GTK_WIDGET (menu));
5018 else if (priv->upper_arrow_visible || priv->lower_arrow_visible)
5022 priv->upper_arrow_visible = priv->lower_arrow_visible = FALSE;
5023 priv->upper_arrow_prelight = priv->lower_arrow_prelight = FALSE;
5025 gtk_menu_stop_scrolling (menu);
5026 gtk_widget_queue_draw (GTK_WIDGET (menu));
5029 else if (!priv->tearoff_active)
5031 gboolean last_visible;
5033 last_visible = priv->upper_arrow_visible;
5034 priv->upper_arrow_visible = offset > 0;
5036 /* upper_arrow_visible may have changed, so requery the border */
5037 get_arrows_border (menu, &arrow_border);
5038 view_height -= arrow_border.top;
5040 if ((last_visible != priv->upper_arrow_visible) &&
5041 !priv->upper_arrow_visible)
5043 priv->upper_arrow_prelight = FALSE;
5045 /* If we hide the upper arrow, possibly remove timeout */
5046 if (priv->scroll_step < 0)
5048 gtk_menu_stop_scrolling (menu);
5049 gtk_widget_queue_draw (GTK_WIDGET (menu));
5053 last_visible = priv->lower_arrow_visible;
5054 priv->lower_arrow_visible = offset < menu_height - view_height;
5056 /* lower_arrow_visible may have changed, so requery the border */
5057 get_arrows_border (menu, &arrow_border);
5058 view_height -= arrow_border.bottom;
5060 if ((last_visible != priv->lower_arrow_visible) &&
5061 !priv->lower_arrow_visible)
5063 priv->lower_arrow_prelight = FALSE;
5065 /* If we hide the lower arrow, possibly remove timeout */
5066 if (priv->scroll_step > 0)
5068 gtk_menu_stop_scrolling (menu);
5069 gtk_widget_queue_draw (GTK_WIDGET (menu));
5073 y += arrow_border.top;
5076 /* Scroll the menu: */
5077 if (gtk_widget_get_realized (widget))
5078 gdk_window_move (priv->bin_window, 0, -offset);
5080 if (gtk_widget_get_realized (widget))
5081 gdk_window_move_resize (priv->view_window, x, y, view_width, view_height);
5083 priv->scroll_offset = offset;
5087 compute_child_offset (GtkMenu *menu,
5088 GtkWidget *menu_item,
5091 gboolean *is_last_child)
5093 GtkMenuPrivate *priv = menu->priv;
5094 gint item_top_attach;
5095 gint item_bottom_attach;
5096 gint child_offset = 0;
5099 get_effective_child_attach (menu_item, NULL, NULL,
5100 &item_top_attach, &item_bottom_attach);
5102 /* there is a possibility that we get called before _size_request,
5103 * so check the height table for safety.
5105 if (!priv->heights || priv->heights_length < gtk_menu_get_n_rows (menu))
5108 /* when we have a row with only invisible children, its height will
5109 * be zero, so there's no need to check WIDGET_VISIBLE here
5111 for (i = 0; i < item_top_attach; i++)
5112 child_offset += priv->heights[i];
5115 *is_last_child = (item_bottom_attach == gtk_menu_get_n_rows (menu));
5117 *offset = child_offset;
5119 *height = priv->heights[item_top_attach];
5125 gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
5126 GtkWidget *menu_item)
5128 GtkMenu *menu = GTK_MENU (menu_shell);
5129 GtkMenuPrivate *priv = menu->priv;
5130 GtkWidget *widget = GTK_WIDGET (menu_shell);
5131 gint child_offset, child_height;
5135 gboolean last_child = 0;
5137 /* We need to check if the selected item fully visible.
5138 * If not we need to scroll the menu so that it becomes fully
5141 if (compute_child_offset (menu, menu_item,
5142 &child_offset, &child_height, &last_child))
5144 guint vertical_padding;
5145 gboolean double_arrows;
5148 y = priv->scroll_offset;
5149 height = gdk_window_get_height (gtk_widget_get_window (widget));
5151 gtk_widget_style_get (widget,
5152 "vertical-padding", &vertical_padding,
5155 double_arrows = get_double_arrows (menu);
5156 get_menu_padding (widget, &padding);
5158 height -= 2 * gtk_container_get_border_width (GTK_CONTAINER (menu)) +
5159 padding.top + padding.bottom +
5160 2 * vertical_padding;
5161 if (child_offset < y)
5163 /* Ignore the enter event we might get if the pointer
5166 menu_shell->priv->ignore_enter = TRUE;
5167 gtk_menu_scroll_to (menu, child_offset);
5171 GtkBorder arrow_border;
5175 get_arrows_border (menu, &arrow_border);
5176 if (!priv->tearoff_active)
5177 arrow_height = arrow_border.top + arrow_border.bottom;
5179 if (child_offset + child_height > y + height - arrow_height)
5182 if ((!last_child && !priv->tearoff_active) || double_arrows)
5183 arrow_height += arrow_border.bottom;
5185 y = child_offset + child_height - height + arrow_height;
5186 if (((y > 0) && !priv->tearoff_active) || double_arrows)
5188 /* Need upper arrow */
5189 arrow_height += arrow_border.top;
5190 y = child_offset + child_height - height + arrow_height;
5192 /* Ignore the enter event we might get if the pointer
5195 menu_shell->priv->ignore_enter = TRUE;
5196 gtk_menu_scroll_to (menu, y);
5203 gtk_menu_select_item (GtkMenuShell *menu_shell,
5204 GtkWidget *menu_item)
5206 GtkMenu *menu = GTK_MENU (menu_shell);
5208 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
5209 gtk_menu_scroll_item_visible (menu_shell, menu_item);
5211 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->select_item (menu_shell, menu_item);
5215 /* Reparent the menu, taking care of the refcounting
5217 * If unrealize is true we force a unrealize while reparenting the parent.
5218 * This can help eliminate flicker in some cases.
5220 * What happens is that when the menu is unrealized and then re-realized,
5221 * the allocations are as follows:
5223 * parent - 1x1 at (0,0)
5224 * child1 - 100x20 at (0,0)
5225 * child2 - 100x20 at (0,20)
5226 * child3 - 100x20 at (0,40)
5228 * That is, the parent is small but the children are full sized. Then,
5229 * when the queued_resize gets processed, the parent gets resized to
5232 * But in order to eliminate flicker when scrolling, gdkgeometry-x11.c
5233 * contains the following logic:
5235 * - if a move or resize operation on a window would change the clip
5236 * region on the children, then before the window is resized
5237 * the background for children is temporarily set to None, the
5238 * move/resize done, and the background for the children restored.
5240 * So, at the point where the parent is resized to final size, the
5241 * background for the children is temporarily None, and thus they
5242 * are not cleared to the background color and the previous background
5243 * (the image of the menu) is left in place.
5246 gtk_menu_reparent (GtkMenu *menu,
5247 GtkWidget *new_parent,
5250 GObject *object = G_OBJECT (menu);
5251 GtkWidget *widget = GTK_WIDGET (menu);
5252 gboolean was_floating = g_object_is_floating (object);
5254 g_object_ref_sink (object);
5258 g_object_ref (object);
5259 gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (widget)), widget);
5260 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5261 g_object_unref (object);
5264 gtk_widget_reparent (widget, new_parent);
5267 g_object_force_floating (object);
5269 g_object_unref (object);
5273 gtk_menu_show_all (GtkWidget *widget)
5275 /* Show children, but not self. */
5276 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
5280 * gtk_menu_set_screen:
5282 * @screen: (allow-none): a #GdkScreen, or %NULL if the screen should be
5283 * determined by the widget the menu is attached to
5285 * Sets the #GdkScreen on which the menu will be displayed.
5290 gtk_menu_set_screen (GtkMenu *menu,
5293 g_return_if_fail (GTK_IS_MENU (menu));
5294 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
5296 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-explicit-screen"), screen);
5300 menu_change_screen (menu, screen);
5304 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
5306 attach_widget_screen_changed (attach_widget, NULL, menu);
5313 * @child: a #GtkMenuItem
5314 * @left_attach: The column number to attach the left side of the item to
5315 * @right_attach: The column number to attach the right side of the item to
5316 * @top_attach: The row number to attach the top of the item to
5317 * @bottom_attach: The row number to attach the bottom of the item to
5319 * Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
5320 * an item will occupy is specified by @left_attach, @right_attach,
5321 * @top_attach and @bottom_attach. These each represent the leftmost,
5322 * rightmost, uppermost and lower column and row numbers of the table.
5323 * (Columns and rows are indexed from zero).
5325 * Note that this function is not related to gtk_menu_detach().
5330 gtk_menu_attach (GtkMenu *menu,
5335 guint bottom_attach)
5337 GtkMenuShell *menu_shell;
5340 g_return_if_fail (GTK_IS_MENU (menu));
5341 g_return_if_fail (GTK_IS_MENU_ITEM (child));
5342 parent = gtk_widget_get_parent (child);
5343 g_return_if_fail (parent == NULL || parent == GTK_WIDGET (menu));
5344 g_return_if_fail (left_attach < right_attach);
5345 g_return_if_fail (top_attach < bottom_attach);
5347 menu_shell = GTK_MENU_SHELL (menu);
5351 AttachInfo *ai = get_attach_info (child);
5353 ai->left_attach = left_attach;
5354 ai->right_attach = right_attach;
5355 ai->top_attach = top_attach;
5356 ai->bottom_attach = bottom_attach;
5358 menu_shell->priv->children = g_list_append (menu_shell->priv->children, child);
5360 gtk_widget_set_parent (child, GTK_WIDGET (menu));
5362 menu_queue_resize (menu);
5366 gtk_container_child_set (GTK_CONTAINER (parent), child,
5367 "left-attach", left_attach,
5368 "right-attach", right_attach,
5369 "top-attach", top_attach,
5370 "bottom-attach", bottom_attach,
5376 gtk_menu_get_popup_delay (GtkMenuShell *menu_shell)
5380 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
5381 "gtk-menu-popup-delay", &popup_delay,
5388 find_child_containing (GtkMenuShell *menu_shell,
5396 /* find a child which includes the area given by
5397 * left, right, top, bottom.
5399 for (list = menu_shell->priv->children; list; list = list->next)
5403 if (!_gtk_menu_item_is_selectable (list->data))
5406 get_effective_child_attach (list->data, &l, &r, &t, &b);
5408 if (l <= left && right <= r && t <= top && bottom <= b)
5409 return GTK_WIDGET (list->data);
5416 gtk_menu_move_current (GtkMenuShell *menu_shell,
5417 GtkMenuDirectionType direction)
5419 GtkMenu *menu = GTK_MENU (menu_shell);
5422 GtkWidget *match = NULL;
5424 if (gtk_widget_get_direction (GTK_WIDGET (menu_shell)) == GTK_TEXT_DIR_RTL)
5428 case GTK_MENU_DIR_CHILD:
5429 direction = GTK_MENU_DIR_PARENT;
5431 case GTK_MENU_DIR_PARENT:
5432 direction = GTK_MENU_DIR_CHILD;
5438 /* use special table menu key bindings */
5439 if (menu_shell->priv->active_menu_item && gtk_menu_get_n_columns (menu) > 1)
5441 get_effective_child_attach (menu_shell->priv->active_menu_item, &l, &r, &t, &b);
5443 if (direction == GTK_MENU_DIR_NEXT)
5445 for (i = b; i < gtk_menu_get_n_rows (menu); i++)
5447 match = find_child_containing (menu_shell, l, l + 1, i, i + 1);
5455 for (i = 0; i < t; i++)
5457 match = find_child_containing (menu_shell,
5458 l, l + 1, i, i + 1);
5464 else if (direction == GTK_MENU_DIR_PREV)
5466 for (i = t; i > 0; i--)
5468 match = find_child_containing (menu_shell,
5469 l, l + 1, i - 1, i);
5477 for (i = gtk_menu_get_n_rows (menu); i > b; i--)
5479 match = find_child_containing (menu_shell,
5480 l, l + 1, i - 1, i);
5486 else if (direction == GTK_MENU_DIR_PARENT)
5488 /* we go one left if possible */
5490 match = find_child_containing (menu_shell,
5491 l - 1, l, t, t + 1);
5495 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5498 || g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1)
5499 match = menu_shell->priv->active_menu_item;
5502 else if (direction == GTK_MENU_DIR_CHILD)
5504 /* we go one right if possible */
5505 if (r < gtk_menu_get_n_columns (menu))
5506 match = find_child_containing (menu_shell, r, r + 1, t, t + 1);
5510 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5512 if (! GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu &&
5514 g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1))
5515 match = menu_shell->priv->active_menu_item;
5521 gtk_menu_shell_select_item (menu_shell, match);
5526 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->move_current (menu_shell, direction);
5530 get_visible_size (GtkMenu *menu)
5532 GtkMenuPrivate *priv = menu->priv;
5533 GtkAllocation allocation;
5534 GtkWidget *widget = GTK_WIDGET (menu);
5535 GtkContainer *container = GTK_CONTAINER (menu);
5539 gtk_widget_get_allocation (widget, &allocation);
5540 get_menu_padding (widget, &padding);
5542 menu_height = (allocation.height -
5543 (2 * gtk_container_get_border_width (container)) -
5544 padding.top - padding.bottom);
5546 if (!priv->tearoff_active)
5548 GtkBorder arrow_border;
5550 get_arrows_border (menu, &arrow_border);
5551 menu_height -= arrow_border.top;
5552 menu_height -= arrow_border.bottom;
5558 /* Find the sensitive on-screen child containing @y, or if none,
5559 * the nearest selectable onscreen child. (%NULL if none)
5562 child_at (GtkMenu *menu,
5565 GtkMenuPrivate *priv = menu->priv;
5566 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5567 GtkWidget *child = NULL;
5568 gint child_offset = 0;
5571 gint lower, upper; /* Onscreen bounds */
5573 menu_height = get_visible_size (menu);
5574 lower = priv->scroll_offset;
5575 upper = priv->scroll_offset + menu_height;
5577 for (children = menu_shell->priv->children; children; children = children->next)
5579 if (gtk_widget_get_visible (children->data))
5581 GtkRequisition child_requisition;
5583 gtk_widget_get_preferred_size (children->data,
5584 &child_requisition, NULL);
5586 if (_gtk_menu_item_is_selectable (children->data) &&
5587 child_offset >= lower &&
5588 child_offset + child_requisition.height <= upper)
5590 child = children->data;
5592 if (child_offset + child_requisition.height > y &&
5593 !GTK_IS_TEAROFF_MENU_ITEM (child))
5597 child_offset += child_requisition.height;
5605 get_menu_height (GtkMenu *menu)
5607 GtkMenuPrivate *priv = menu->priv;
5608 GtkAllocation allocation;
5609 GtkWidget *widget = GTK_WIDGET (menu);
5613 gtk_widget_get_allocation (widget, &allocation);
5614 get_menu_padding (widget, &padding);
5616 height = allocation.height;
5617 height -= (gtk_container_get_border_width (GTK_CONTAINER (widget)) * 2) +
5618 padding.top + padding.bottom;
5620 if (!priv->tearoff_active)
5622 GtkBorder arrow_border;
5624 get_arrows_border (menu, &arrow_border);
5625 height -= arrow_border.top;
5626 height -= arrow_border.bottom;
5633 gtk_menu_real_move_scroll (GtkMenu *menu,
5636 GtkMenuPrivate *priv = menu->priv;
5637 gint page_size = get_visible_size (menu);
5638 gint end_position = get_menu_height (menu);
5639 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5643 case GTK_SCROLL_PAGE_UP:
5644 case GTK_SCROLL_PAGE_DOWN:
5648 gint child_offset = 0;
5649 gboolean old_upper_arrow_visible;
5652 if (type == GTK_SCROLL_PAGE_UP)
5657 if (menu_shell->priv->active_menu_item)
5661 compute_child_offset (menu, menu_shell->priv->active_menu_item,
5662 &child_offset, &child_height, NULL);
5663 child_offset += child_height / 2;
5666 menu_shell->priv->ignore_enter = TRUE;
5667 old_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5668 old_offset = priv->scroll_offset;
5670 new_offset = priv->scroll_offset + step;
5671 new_offset = CLAMP (new_offset, 0, end_position - page_size);
5673 gtk_menu_scroll_to (menu, new_offset);
5675 if (menu_shell->priv->active_menu_item)
5677 GtkWidget *new_child;
5678 gboolean new_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5679 GtkBorder arrow_border;
5680 get_arrows_border (menu, &arrow_border);
5682 if (priv->scroll_offset != old_offset)
5683 step = priv->scroll_offset - old_offset;
5685 step -= (new_upper_arrow_visible - old_upper_arrow_visible) * arrow_border.top;
5687 new_child = child_at (menu, child_offset + step);
5689 gtk_menu_shell_select_item (menu_shell, new_child);
5693 case GTK_SCROLL_START:
5694 /* Ignore the enter event we might get if the pointer is on the menu */
5695 menu_shell->priv->ignore_enter = TRUE;
5696 gtk_menu_scroll_to (menu, 0);
5697 gtk_menu_shell_select_first (menu_shell, TRUE);
5699 case GTK_SCROLL_END:
5700 /* Ignore the enter event we might get if the pointer is on the menu */
5701 menu_shell->priv->ignore_enter = TRUE;
5702 gtk_menu_scroll_to (menu, end_position - page_size);
5703 _gtk_menu_shell_select_last (menu_shell, TRUE);
5712 * gtk_menu_set_monitor:
5714 * @monitor_num: the number of the monitor on which the menu should
5717 * Informs GTK+ on which monitor a menu should be popped up.
5718 * See gdk_screen_get_monitor_geometry().
5720 * This function should be called from a #GtkMenuPositionFunc
5721 * if the menu should not appear on the same monitor as the pointer.
5722 * This information can't be reliably inferred from the coordinates
5723 * returned by a #GtkMenuPositionFunc, since, for very long menus,
5724 * these coordinates may extend beyond the monitor boundaries or even
5725 * the screen boundaries.
5730 gtk_menu_set_monitor (GtkMenu *menu,
5733 GtkMenuPrivate *priv = menu->priv;
5735 g_return_if_fail (GTK_IS_MENU (menu));
5737 priv->monitor_num = monitor_num;
5741 * gtk_menu_get_monitor:
5744 * Retrieves the number of the monitor on which to show the menu.
5746 * Returns: the number of the monitor on which the menu should
5747 * be popped up or -1, if no monitor has been set
5752 gtk_menu_get_monitor (GtkMenu *menu)
5754 g_return_val_if_fail (GTK_IS_MENU (menu), -1);
5756 return menu->priv->monitor_num;
5760 * gtk_menu_get_for_attach_widget:
5761 * @widget: a #GtkWidget
5763 * Returns a list of the menus which are attached to this widget.
5764 * This list is owned by GTK+ and must not be modified.
5766 * Return value: (element-type GtkWidget) (transfer none): the list
5767 * of menus attached to his widget.
5772 gtk_menu_get_for_attach_widget (GtkWidget *widget)
5776 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5778 list = g_object_get_data (G_OBJECT (widget), ATTACHED_MENUS);
5784 gtk_menu_grab_notify (GtkWidget *widget,
5785 gboolean was_grabbed)
5787 GtkWidget *toplevel;
5788 GtkWindowGroup *group;
5792 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (widget));
5795 !gtk_widget_device_is_shadowed (widget, pointer))
5798 toplevel = gtk_widget_get_toplevel (widget);
5800 if (!GTK_IS_WINDOW (toplevel))
5803 group = gtk_window_get_group (GTK_WINDOW (toplevel));
5804 grab = gtk_window_group_get_current_device_grab (group, pointer);
5806 if (GTK_MENU_SHELL (widget)->priv->active && !GTK_IS_MENU_SHELL (grab))
5807 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
5811 * gtk_menu_set_reserve_toggle_size:
5813 * @reserve_toggle_size: whether to reserve size for toggles
5815 * Sets whether the menu should reserve space for drawing toggles
5816 * or icons, regardless of their actual presence.
5821 gtk_menu_set_reserve_toggle_size (GtkMenu *menu,
5822 gboolean reserve_toggle_size)
5824 GtkMenuPrivate *priv = menu->priv;
5825 gboolean no_toggle_size;
5827 g_return_if_fail (GTK_IS_MENU (menu));
5829 no_toggle_size = !reserve_toggle_size;
5831 if (priv->no_toggle_size != no_toggle_size)
5833 priv->no_toggle_size = no_toggle_size;
5835 g_object_notify (G_OBJECT (menu), "reserve-toggle-size");
5840 * gtk_menu_get_reserve_toggle_size:
5843 * Returns whether the menu reserves space for toggles and
5844 * icons, regardless of their actual presence.
5846 * Returns: Whether the menu reserves toggle space
5851 gtk_menu_get_reserve_toggle_size (GtkMenu *menu)
5853 g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
5855 return !menu->priv->no_toggle_size;