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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 * @Short_description: A menu widget
30 * A #GtkMenu is a #GtkMenuShell that implements a drop down menu
31 * consisting of a list of #GtkMenuItem objects which can be navigated
32 * and activated by the user to perform application functions.
34 * A #GtkMenu is most commonly dropped down by activating a
35 * #GtkMenuItem in a #GtkMenuBar or popped up by activating a
36 * #GtkMenuItem in another #GtkMenu.
38 * A #GtkMenu can also be popped up by activating a #GtkComboBox.
39 * Other composite widgets such as the #GtkNotebook can pop up a
42 * Applications can display a #GtkMenu as a popup menu by calling the
43 * gtk_menu_popup() function. The example below shows how an application
44 * can pop up a menu when the 3rd mouse button is pressed.
47 * <title>Connecting the popup signal handler.</title>
49 * /<!---->* connect our handler which will popup the menu *<!---->/
50 * g_signal_connect_swapped (window, "button_press_event",
51 * G_CALLBACK (my_popup_handler), menu);
56 * <title>Signal handler which displays a popup menu.</title>
59 * my_popup_handler (GtkWidget *widget, GdkEvent *event)
62 * GdkEventButton *event_button;
64 * g_return_val_if_fail (widget != NULL, FALSE);
65 * g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
66 * g_return_val_if_fail (event != NULL, FALSE);
68 * /<!---->* The "widget" is the menu that was supplied when
69 * * g_signal_connect_swapped() was called.
71 * menu = GTK_MENU (widget);
73 * if (event->type == GDK_BUTTON_PRESS)
75 * event_button = (GdkEventButton *) event;
76 * if (event_button->button == GDK_BUTTON_SECONDARY)
78 * gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
79 * event_button->button, event_button->time);
94 #include <gobject/gvaluecollector.h>
96 #include "gtkaccellabel.h"
97 #include "gtkaccelmap.h"
98 #include "gtkadjustment.h"
99 #include "gtkbindings.h"
100 #include "gtkcheckmenuitem.h"
102 #include "gtkmarshalers.h"
103 #include "gtkmenuprivate.h"
104 #include "gtkmenuitemprivate.h"
105 #include "gtkmenushellprivate.h"
106 #include "gtkwindow.h"
108 #include "gtkscrollbar.h"
109 #include "gtksettings.h"
110 #include "gtkprivate.h"
111 #include "gtkwidgetpath.h"
112 #include "gtkwidgetprivate.h"
115 #include "gtktypebuiltins.h"
116 #include "gtkwidgetprivate.h"
118 #include "deprecated/gtktearoffmenuitem.h"
121 #include "a11y/gtkmenuaccessible.h"
123 #define NAVIGATION_REGION_OVERSHOOT 50 /* How much the navigation region
124 * extends below the submenu
127 #define MENU_SCROLL_STEP1 8
128 #define MENU_SCROLL_STEP2 15
129 #define MENU_SCROLL_FAST_ZONE 8
130 #define MENU_SCROLL_TIMEOUT1 50
131 #define MENU_SCROLL_TIMEOUT2 20
133 #define ATTACH_INFO_KEY "gtk-menu-child-attach-info-key"
134 #define ATTACHED_MENUS "gtk-attached-menus"
136 typedef struct _GtkMenuAttachData GtkMenuAttachData;
137 typedef struct _GtkMenuPopdownData GtkMenuPopdownData;
139 struct _GtkMenuAttachData
141 GtkWidget *attach_widget;
142 GtkMenuDetachFunc detacher;
145 struct _GtkMenuPopdownData
157 gint effective_left_attach;
158 gint effective_right_attach;
159 gint effective_top_attach;
160 gint effective_bottom_attach;
177 PROP_RESERVE_TOGGLE_SIZE
182 CHILD_PROP_LEFT_ATTACH,
183 CHILD_PROP_RIGHT_ATTACH,
184 CHILD_PROP_TOP_ATTACH,
185 CHILD_PROP_BOTTOM_ATTACH
188 static void gtk_menu_set_property (GObject *object,
192 static void gtk_menu_get_property (GObject *object,
196 static void gtk_menu_set_child_property(GtkContainer *container,
201 static void gtk_menu_get_child_property(GtkContainer *container,
206 static void gtk_menu_destroy (GtkWidget *widget);
207 static void gtk_menu_realize (GtkWidget *widget);
208 static void gtk_menu_unrealize (GtkWidget *widget);
209 static void gtk_menu_size_allocate (GtkWidget *widget,
210 GtkAllocation *allocation);
211 static void gtk_menu_show (GtkWidget *widget);
212 static gboolean gtk_menu_draw (GtkWidget *widget,
214 static gboolean gtk_menu_key_press (GtkWidget *widget,
216 static gboolean gtk_menu_scroll (GtkWidget *widget,
217 GdkEventScroll *event);
218 static gboolean gtk_menu_button_press (GtkWidget *widget,
219 GdkEventButton *event);
220 static gboolean gtk_menu_button_release (GtkWidget *widget,
221 GdkEventButton *event);
222 static gboolean gtk_menu_motion_notify (GtkWidget *widget,
223 GdkEventMotion *event);
224 static gboolean gtk_menu_enter_notify (GtkWidget *widget,
225 GdkEventCrossing *event);
226 static gboolean gtk_menu_leave_notify (GtkWidget *widget,
227 GdkEventCrossing *event);
228 static void gtk_menu_scroll_to (GtkMenu *menu,
230 static void gtk_menu_grab_notify (GtkWidget *widget,
231 gboolean was_grabbed);
232 static gboolean gtk_menu_captured_event (GtkWidget *widget,
236 static void gtk_menu_stop_scrolling (GtkMenu *menu);
237 static void gtk_menu_remove_scroll_timeout (GtkMenu *menu);
238 static gboolean gtk_menu_scroll_timeout (gpointer data);
240 static void gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
241 GtkWidget *menu_item);
242 static void gtk_menu_select_item (GtkMenuShell *menu_shell,
243 GtkWidget *menu_item);
244 static void gtk_menu_real_insert (GtkMenuShell *menu_shell,
247 static void gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
249 static void gtk_menu_handle_scrolling (GtkMenu *menu,
254 static void gtk_menu_set_tearoff_hints (GtkMenu *menu,
256 static void gtk_menu_style_updated (GtkWidget *widget);
257 static gboolean gtk_menu_focus (GtkWidget *widget,
258 GtkDirectionType direction);
259 static gint gtk_menu_get_popup_delay (GtkMenuShell *menu_shell);
260 static void gtk_menu_move_current (GtkMenuShell *menu_shell,
261 GtkMenuDirectionType direction);
262 static void gtk_menu_real_move_scroll (GtkMenu *menu,
265 static void gtk_menu_stop_navigating_submenu (GtkMenu *menu);
266 static gboolean gtk_menu_stop_navigating_submenu_cb (gpointer user_data);
267 static gboolean gtk_menu_navigating_submenu (GtkMenu *menu,
270 static void gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
271 GtkMenuItem *menu_item,
272 GdkEventCrossing *event);
274 static void gtk_menu_deactivate (GtkMenuShell *menu_shell);
275 static void gtk_menu_show_all (GtkWidget *widget);
276 static void gtk_menu_position (GtkMenu *menu,
277 gboolean set_scroll_offset);
278 static void gtk_menu_reparent (GtkMenu *menu,
279 GtkWidget *new_parent,
281 static void gtk_menu_remove (GtkContainer *menu,
284 static void gtk_menu_update_title (GtkMenu *menu);
286 static void menu_grab_transfer_window_destroy (GtkMenu *menu);
287 static GdkWindow *menu_grab_transfer_window_get (GtkMenu *menu);
289 static gboolean gtk_menu_real_can_activate_accel (GtkWidget *widget,
291 static void _gtk_menu_refresh_accel_paths (GtkMenu *menu,
292 gboolean group_changed);
294 static void gtk_menu_get_preferred_width (GtkWidget *widget,
297 static void gtk_menu_get_preferred_height (GtkWidget *widget,
300 static void gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
306 static const gchar attach_data_key[] = "gtk-menu-attach-data";
308 static guint menu_signals[LAST_SIGNAL] = { 0 };
310 G_DEFINE_TYPE (GtkMenu, gtk_menu, GTK_TYPE_MENU_SHELL)
313 menu_queue_resize (GtkMenu *menu)
315 GtkMenuPrivate *priv = menu->priv;
317 priv->have_layout = FALSE;
318 gtk_widget_queue_resize (GTK_WIDGET (menu));
322 attach_info_free (AttachInfo *info)
324 g_slice_free (AttachInfo, info);
328 get_attach_info (GtkWidget *child)
330 GObject *object = G_OBJECT (child);
331 AttachInfo *ai = g_object_get_data (object, ATTACH_INFO_KEY);
335 ai = g_slice_new0 (AttachInfo);
336 g_object_set_data_full (object, I_(ATTACH_INFO_KEY), ai,
337 (GDestroyNotify) attach_info_free);
344 is_grid_attached (AttachInfo *ai)
346 return (ai->left_attach >= 0 &&
347 ai->right_attach >= 0 &&
348 ai->top_attach >= 0 &&
349 ai->bottom_attach >= 0);
353 menu_ensure_layout (GtkMenu *menu)
355 GtkMenuPrivate *priv = menu->priv;
357 if (!priv->have_layout)
359 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
363 gint max_right_attach;
364 gint max_bottom_attach;
366 /* Find extents of gridded portion
368 max_right_attach = 1;
369 max_bottom_attach = 0;
371 for (l = menu_shell->priv->children; l; l = l->next)
373 GtkWidget *child = l->data;
374 AttachInfo *ai = get_attach_info (child);
376 if (is_grid_attached (ai))
378 max_bottom_attach = MAX (max_bottom_attach, ai->bottom_attach);
379 max_right_attach = MAX (max_right_attach, ai->right_attach);
383 /* Find empty rows */
384 row_occupied = g_malloc0 (max_bottom_attach);
386 for (l = menu_shell->priv->children; l; l = l->next)
388 GtkWidget *child = l->data;
389 AttachInfo *ai = get_attach_info (child);
391 if (is_grid_attached (ai))
395 for (i = ai->top_attach; i < ai->bottom_attach; i++)
396 row_occupied[i] = TRUE;
400 /* Lay non-grid-items out in those rows
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 while (current_row < max_bottom_attach && row_occupied[current_row])
413 ai->effective_left_attach = 0;
414 ai->effective_right_attach = max_right_attach;
415 ai->effective_top_attach = current_row;
416 ai->effective_bottom_attach = current_row + 1;
422 ai->effective_left_attach = ai->left_attach;
423 ai->effective_right_attach = ai->right_attach;
424 ai->effective_top_attach = ai->top_attach;
425 ai->effective_bottom_attach = ai->bottom_attach;
429 g_free (row_occupied);
431 priv->n_rows = MAX (current_row, max_bottom_attach);
432 priv->n_columns = max_right_attach;
433 priv->have_layout = TRUE;
439 gtk_menu_get_n_columns (GtkMenu *menu)
441 GtkMenuPrivate *priv = menu->priv;
443 menu_ensure_layout (menu);
445 return priv->n_columns;
449 gtk_menu_get_n_rows (GtkMenu *menu)
451 GtkMenuPrivate *priv = menu->priv;
453 menu_ensure_layout (menu);
459 get_effective_child_attach (GtkWidget *child,
465 GtkMenu *menu = GTK_MENU (gtk_widget_get_parent (child));
468 menu_ensure_layout (menu);
470 ai = get_attach_info (child);
473 *l = ai->effective_left_attach;
475 *r = ai->effective_right_attach;
477 *t = ai->effective_top_attach;
479 *b = ai->effective_bottom_attach;
484 gtk_menu_class_init (GtkMenuClass *class)
486 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
487 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
488 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
489 GtkMenuShellClass *menu_shell_class = GTK_MENU_SHELL_CLASS (class);
490 GtkBindingSet *binding_set;
492 gobject_class->set_property = gtk_menu_set_property;
493 gobject_class->get_property = gtk_menu_get_property;
495 widget_class->destroy = gtk_menu_destroy;
496 widget_class->realize = gtk_menu_realize;
497 widget_class->unrealize = gtk_menu_unrealize;
498 widget_class->size_allocate = gtk_menu_size_allocate;
499 widget_class->show = gtk_menu_show;
500 widget_class->draw = gtk_menu_draw;
501 widget_class->scroll_event = gtk_menu_scroll;
502 widget_class->key_press_event = gtk_menu_key_press;
503 widget_class->button_press_event = gtk_menu_button_press;
504 widget_class->button_release_event = gtk_menu_button_release;
505 widget_class->motion_notify_event = gtk_menu_motion_notify;
506 widget_class->show_all = gtk_menu_show_all;
507 widget_class->enter_notify_event = gtk_menu_enter_notify;
508 widget_class->leave_notify_event = gtk_menu_leave_notify;
509 widget_class->style_updated = gtk_menu_style_updated;
510 widget_class->focus = gtk_menu_focus;
511 widget_class->can_activate_accel = gtk_menu_real_can_activate_accel;
512 widget_class->grab_notify = gtk_menu_grab_notify;
513 widget_class->get_preferred_width = gtk_menu_get_preferred_width;
514 widget_class->get_preferred_height = gtk_menu_get_preferred_height;
515 widget_class->get_preferred_height_for_width = gtk_menu_get_preferred_height_for_width;
517 container_class->remove = gtk_menu_remove;
518 container_class->get_child_property = gtk_menu_get_child_property;
519 container_class->set_child_property = gtk_menu_set_child_property;
521 menu_shell_class->submenu_placement = GTK_LEFT_RIGHT;
522 menu_shell_class->deactivate = gtk_menu_deactivate;
523 menu_shell_class->select_item = gtk_menu_select_item;
524 menu_shell_class->insert = gtk_menu_real_insert;
525 menu_shell_class->get_popup_delay = gtk_menu_get_popup_delay;
526 menu_shell_class->move_current = gtk_menu_move_current;
529 * GtkMenu::move-scroll:
531 * @scroll_type: a #GtkScrollType
533 menu_signals[MOVE_SCROLL] =
534 g_signal_new_class_handler (I_("move-scroll"),
535 G_OBJECT_CLASS_TYPE (gobject_class),
536 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
537 G_CALLBACK (gtk_menu_real_move_scroll),
539 _gtk_marshal_VOID__ENUM,
541 GTK_TYPE_SCROLL_TYPE);
546 * The index of the currently selected menu item, or -1 if no
547 * menu item is selected.
551 g_object_class_install_property (gobject_class,
553 g_param_spec_int ("active",
555 P_("The currently selected menu item"),
557 GTK_PARAM_READWRITE));
560 * GtkMenu:accel-group:
562 * The accel group holding accelerators for the menu.
566 g_object_class_install_property (gobject_class,
568 g_param_spec_object ("accel-group",
570 P_("The accel group holding accelerators for the menu"),
571 GTK_TYPE_ACCEL_GROUP,
572 GTK_PARAM_READWRITE));
575 * GtkMenu:accel-path:
577 * An accel path used to conveniently construct accel paths of child items.
581 g_object_class_install_property (gobject_class,
583 g_param_spec_string ("accel-path",
585 P_("An accel path used to conveniently construct accel paths of child items"),
587 GTK_PARAM_READWRITE));
590 * GtkMenu:attach-widget:
592 * The widget the menu is attached to. Setting this property attaches
593 * the menu without a #GtkMenuDetachFunc. If you need to use a detacher,
594 * use gtk_menu_attach_to_widget() directly.
598 g_object_class_install_property (gobject_class,
600 g_param_spec_object ("attach-widget",
602 P_("The widget the menu is attached to"),
604 GTK_PARAM_READWRITE));
606 g_object_class_install_property (gobject_class,
608 g_param_spec_string ("tearoff-title",
610 P_("A title that may be displayed by the window manager when this menu is torn-off"),
612 GTK_PARAM_READWRITE));
615 * GtkMenu:tearoff-state:
617 * A boolean that indicates whether the menu is torn-off.
621 g_object_class_install_property (gobject_class,
623 g_param_spec_boolean ("tearoff-state",
625 P_("A boolean that indicates whether the menu is torn-off"),
627 GTK_PARAM_READWRITE));
632 * The monitor the menu will be popped up on.
636 g_object_class_install_property (gobject_class,
638 g_param_spec_int ("monitor",
640 P_("The monitor the menu will be popped up on"),
642 GTK_PARAM_READWRITE));
645 * GtkMenu:reserve-toggle-size:
647 * A boolean that indicates whether the menu reserves space for
648 * toggles and icons, regardless of their actual presence.
650 * This property should only be changed from its default value
651 * for special-purposes such as tabular menus. Regular menus that
652 * are connected to a menu bar or context menus should reserve
653 * toggle space for consistency.
657 g_object_class_install_property (gobject_class,
658 PROP_RESERVE_TOGGLE_SIZE,
659 g_param_spec_boolean ("reserve-toggle-size",
660 P_("Reserve Toggle Size"),
661 P_("A boolean that indicates whether the menu reserves space for toggles and icons"),
663 GTK_PARAM_READWRITE));
666 * GtkMenu:horizontal-padding:
668 * Extra space at the left and right edges of the menu.
670 * Deprecated: 3.8: use the standard padding CSS property (through objects
671 * like #GtkStyleContext and #GtkCssProvider); the value of this style
672 * property is ignored.
674 gtk_widget_class_install_style_property (widget_class,
675 g_param_spec_int ("horizontal-padding",
676 P_("Horizontal Padding"),
677 P_("Extra space at the left and right edges of the menu"),
682 G_PARAM_DEPRECATED));
685 * GtkMenu:vertical-padding:
687 * Extra space at the top and bottom of the menu.
689 * Deprecated: 3.8: use the standard padding CSS property (through objects
690 * like #GtkStyleContext and #GtkCssProvider); the value of this style
691 * property is ignored.
693 gtk_widget_class_install_style_property (widget_class,
694 g_param_spec_int ("vertical-padding",
695 P_("Vertical Padding"),
696 P_("Extra space at the top and bottom of the menu"),
701 G_PARAM_DEPRECATED));
703 gtk_widget_class_install_style_property (widget_class,
704 g_param_spec_int ("vertical-offset",
705 P_("Vertical Offset"),
706 P_("When the menu is a submenu, position it this number of pixels offset vertically"),
710 GTK_PARAM_READABLE));
712 gtk_widget_class_install_style_property (widget_class,
713 g_param_spec_int ("horizontal-offset",
714 P_("Horizontal Offset"),
715 P_("When the menu is a submenu, position it this number of pixels offset horizontally"),
719 GTK_PARAM_READABLE));
721 gtk_widget_class_install_style_property (widget_class,
722 g_param_spec_boolean ("double-arrows",
724 P_("When scrolling, always show both arrows."),
726 GTK_PARAM_READABLE));
729 * GtkMenu:arrow-placement:
731 * Indicates where scroll arrows should be placed.
735 gtk_widget_class_install_style_property (widget_class,
736 g_param_spec_enum ("arrow-placement",
737 P_("Arrow Placement"),
738 P_("Indicates where scroll arrows should be placed"),
739 GTK_TYPE_ARROW_PLACEMENT,
741 GTK_PARAM_READABLE));
743 gtk_container_class_install_child_property (container_class,
744 CHILD_PROP_LEFT_ATTACH,
745 g_param_spec_int ("left-attach",
747 P_("The column number to attach the left side of the child to"),
749 GTK_PARAM_READWRITE));
751 gtk_container_class_install_child_property (container_class,
752 CHILD_PROP_RIGHT_ATTACH,
753 g_param_spec_int ("right-attach",
755 P_("The column number to attach the right side of the child to"),
757 GTK_PARAM_READWRITE));
759 gtk_container_class_install_child_property (container_class,
760 CHILD_PROP_TOP_ATTACH,
761 g_param_spec_int ("top-attach",
763 P_("The row number to attach the top of the child to"),
765 GTK_PARAM_READWRITE));
767 gtk_container_class_install_child_property (container_class,
768 CHILD_PROP_BOTTOM_ATTACH,
769 g_param_spec_int ("bottom-attach",
771 P_("The row number to attach the bottom of the child to"),
773 GTK_PARAM_READWRITE));
776 * GtkMenu:arrow-scaling:
778 * Arbitrary constant to scale down the size of the scroll arrow.
782 gtk_widget_class_install_style_property (widget_class,
783 g_param_spec_float ("arrow-scaling",
785 P_("Arbitrary constant to scale down the size of the scroll arrow"),
787 GTK_PARAM_READABLE));
789 binding_set = gtk_binding_set_by_class (class);
790 gtk_binding_entry_add_signal (binding_set,
792 I_("move-current"), 1,
793 GTK_TYPE_MENU_DIRECTION_TYPE,
795 gtk_binding_entry_add_signal (binding_set,
798 GTK_TYPE_MENU_DIRECTION_TYPE,
800 gtk_binding_entry_add_signal (binding_set,
803 GTK_TYPE_MENU_DIRECTION_TYPE,
805 gtk_binding_entry_add_signal (binding_set,
808 GTK_TYPE_MENU_DIRECTION_TYPE,
810 gtk_binding_entry_add_signal (binding_set,
813 GTK_TYPE_MENU_DIRECTION_TYPE,
814 GTK_MENU_DIR_PARENT);
815 gtk_binding_entry_add_signal (binding_set,
818 GTK_TYPE_MENU_DIRECTION_TYPE,
819 GTK_MENU_DIR_PARENT);
820 gtk_binding_entry_add_signal (binding_set,
823 GTK_TYPE_MENU_DIRECTION_TYPE,
825 gtk_binding_entry_add_signal (binding_set,
828 GTK_TYPE_MENU_DIRECTION_TYPE,
830 gtk_binding_entry_add_signal (binding_set,
833 GTK_TYPE_SCROLL_TYPE,
835 gtk_binding_entry_add_signal (binding_set,
838 GTK_TYPE_SCROLL_TYPE,
840 gtk_binding_entry_add_signal (binding_set,
843 GTK_TYPE_SCROLL_TYPE,
845 gtk_binding_entry_add_signal (binding_set,
848 GTK_TYPE_SCROLL_TYPE,
850 gtk_binding_entry_add_signal (binding_set,
853 GTK_TYPE_SCROLL_TYPE,
855 gtk_binding_entry_add_signal (binding_set,
856 GDK_KEY_KP_Page_Up, 0,
858 GTK_TYPE_SCROLL_TYPE,
860 gtk_binding_entry_add_signal (binding_set,
861 GDK_KEY_Page_Down, 0,
863 GTK_TYPE_SCROLL_TYPE,
864 GTK_SCROLL_PAGE_DOWN);
865 gtk_binding_entry_add_signal (binding_set,
866 GDK_KEY_KP_Page_Down, 0,
868 GTK_TYPE_SCROLL_TYPE,
869 GTK_SCROLL_PAGE_DOWN);
871 g_type_class_add_private (gobject_class, sizeof (GtkMenuPrivate));
873 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_MENU_ACCESSIBLE);
878 gtk_menu_set_property (GObject *object,
883 GtkMenu *menu = GTK_MENU (object);
888 gtk_menu_set_active (menu, g_value_get_int (value));
890 case PROP_ACCEL_GROUP:
891 gtk_menu_set_accel_group (menu, g_value_get_object (value));
893 case PROP_ACCEL_PATH:
894 gtk_menu_set_accel_path (menu, g_value_get_string (value));
896 case PROP_ATTACH_WIDGET:
900 widget = gtk_menu_get_attach_widget (menu);
902 gtk_menu_detach (menu);
904 widget = (GtkWidget*) g_value_get_object (value);
906 gtk_menu_attach_to_widget (menu, widget, NULL);
909 case PROP_TEAROFF_STATE:
910 gtk_menu_set_tearoff_state (menu, g_value_get_boolean (value));
912 case PROP_TEAROFF_TITLE:
913 gtk_menu_set_title (menu, g_value_get_string (value));
916 gtk_menu_set_monitor (menu, g_value_get_int (value));
918 case PROP_RESERVE_TOGGLE_SIZE:
919 gtk_menu_set_reserve_toggle_size (menu, g_value_get_boolean (value));
922 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
928 gtk_menu_get_property (GObject *object,
933 GtkMenu *menu = GTK_MENU (object);
938 g_value_set_int (value, g_list_index (GTK_MENU_SHELL (menu)->priv->children, gtk_menu_get_active (menu)));
940 case PROP_ACCEL_GROUP:
941 g_value_set_object (value, gtk_menu_get_accel_group (menu));
943 case PROP_ACCEL_PATH:
944 g_value_set_string (value, gtk_menu_get_accel_path (menu));
946 case PROP_ATTACH_WIDGET:
947 g_value_set_object (value, gtk_menu_get_attach_widget (menu));
949 case PROP_TEAROFF_STATE:
950 g_value_set_boolean (value, gtk_menu_get_tearoff_state (menu));
952 case PROP_TEAROFF_TITLE:
953 g_value_set_string (value, gtk_menu_get_title (menu));
956 g_value_set_int (value, gtk_menu_get_monitor (menu));
958 case PROP_RESERVE_TOGGLE_SIZE:
959 g_value_set_boolean (value, gtk_menu_get_reserve_toggle_size (menu));
962 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
968 gtk_menu_set_child_property (GtkContainer *container,
974 GtkMenu *menu = GTK_MENU (container);
975 AttachInfo *ai = get_attach_info (child);
979 case CHILD_PROP_LEFT_ATTACH:
980 ai->left_attach = g_value_get_int (value);
982 case CHILD_PROP_RIGHT_ATTACH:
983 ai->right_attach = g_value_get_int (value);
985 case CHILD_PROP_TOP_ATTACH:
986 ai->top_attach = g_value_get_int (value);
988 case CHILD_PROP_BOTTOM_ATTACH:
989 ai->bottom_attach = g_value_get_int (value);
993 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
997 menu_queue_resize (menu);
1001 gtk_menu_get_child_property (GtkContainer *container,
1007 AttachInfo *ai = get_attach_info (child);
1009 switch (property_id)
1011 case CHILD_PROP_LEFT_ATTACH:
1012 g_value_set_int (value, ai->left_attach);
1014 case CHILD_PROP_RIGHT_ATTACH:
1015 g_value_set_int (value, ai->right_attach);
1017 case CHILD_PROP_TOP_ATTACH:
1018 g_value_set_int (value, ai->top_attach);
1020 case CHILD_PROP_BOTTOM_ATTACH:
1021 g_value_set_int (value, ai->bottom_attach);
1025 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1031 gtk_menu_window_event (GtkWidget *window,
1035 gboolean handled = FALSE;
1037 g_object_ref (window);
1038 g_object_ref (menu);
1040 switch (event->type)
1043 case GDK_KEY_RELEASE:
1044 handled = gtk_widget_event (menu, event);
1046 case GDK_WINDOW_STATE:
1047 /* Window for the menu has been closed by the display server or by GDK.
1048 * Update the internal state as if the user had clicked outside the
1051 if (event->window_state.new_window_state & GDK_WINDOW_STATE_WITHDRAWN &&
1052 event->window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1053 gtk_menu_shell_deactivate (GTK_MENU_SHELL(menu));
1059 g_object_unref (window);
1060 g_object_unref (menu);
1066 gtk_menu_init (GtkMenu *menu)
1068 GtkMenuPrivate *priv;
1069 GtkStyleContext *context;
1071 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu, GTK_TYPE_MENU, GtkMenuPrivate);
1075 priv->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
1076 "type", GTK_WINDOW_POPUP,
1079 "signal::event", gtk_menu_window_event, menu,
1080 "signal::destroy", gtk_widget_destroyed, &priv->toplevel,
1082 gtk_window_set_resizable (GTK_WINDOW (priv->toplevel), FALSE);
1083 gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->toplevel), 0);
1085 /* Refloat the menu, so that reference counting for the menu isn't
1086 * affected by it being a child of the toplevel
1088 g_object_force_floating (G_OBJECT (menu));
1089 priv->needs_destruction_ref = TRUE;
1091 priv->monitor_num = -1;
1092 priv->drag_start_y = -1;
1094 context = gtk_widget_get_style_context (GTK_WIDGET (menu));
1095 gtk_style_context_add_class (context, GTK_STYLE_CLASS_MENU);
1097 _gtk_widget_set_captured_event_handler (GTK_WIDGET (menu), gtk_menu_captured_event);
1101 gtk_menu_destroy (GtkWidget *widget)
1103 GtkMenu *menu = GTK_MENU (widget);
1104 GtkMenuPrivate *priv = menu->priv;
1105 GtkMenuAttachData *data;
1107 gtk_menu_remove_scroll_timeout (menu);
1109 data = g_object_get_data (G_OBJECT (widget), attach_data_key);
1111 gtk_menu_detach (menu);
1113 gtk_menu_stop_navigating_submenu (menu);
1115 if (priv->old_active_menu_item)
1116 g_clear_object (&priv->old_active_menu_item);
1118 /* Add back the reference count for being a child */
1119 if (priv->needs_destruction_ref)
1121 priv->needs_destruction_ref = FALSE;
1122 g_object_ref (widget);
1125 if (priv->accel_group)
1126 g_clear_object (&priv->accel_group);
1129 gtk_widget_destroy (priv->toplevel);
1131 if (priv->tearoff_window)
1132 gtk_widget_destroy (priv->tearoff_window);
1136 g_free (priv->heights);
1137 priv->heights = NULL;
1142 g_free (priv->title);
1146 if (priv->position_func_data_destroy)
1148 priv->position_func_data_destroy (priv->position_func_data);
1149 priv->position_func_data = NULL;
1150 priv->position_func_data_destroy = NULL;
1153 GTK_WIDGET_CLASS (gtk_menu_parent_class)->destroy (widget);
1157 menu_change_screen (GtkMenu *menu,
1158 GdkScreen *new_screen)
1160 GtkMenuPrivate *priv = menu->priv;
1162 if (gtk_widget_has_screen (GTK_WIDGET (menu)))
1164 if (new_screen == gtk_widget_get_screen (GTK_WIDGET (menu)))
1170 gtk_window_set_screen (GTK_WINDOW (priv->tearoff_window), new_screen);
1171 gtk_menu_position (menu, TRUE);
1174 gtk_window_set_screen (GTK_WINDOW (priv->toplevel), new_screen);
1175 priv->monitor_num = -1;
1179 attach_widget_screen_changed (GtkWidget *attach_widget,
1180 GdkScreen *previous_screen,
1183 if (gtk_widget_has_screen (attach_widget) &&
1184 !g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1185 menu_change_screen (menu, gtk_widget_get_screen (attach_widget));
1189 * gtk_menu_attach_to_widget:
1191 * @attach_widget: the #GtkWidget that the menu will be attached to
1192 * @detacher: (scope async)(allow-none): the user supplied callback function
1193 * that will be called when the menu calls gtk_menu_detach()
1195 * Attaches the menu to the widget and provides a callback function
1196 * that will be invoked when the menu calls gtk_menu_detach() during
1200 gtk_menu_attach_to_widget (GtkMenu *menu,
1201 GtkWidget *attach_widget,
1202 GtkMenuDetachFunc detacher)
1204 GtkMenuAttachData *data;
1207 g_return_if_fail (GTK_IS_MENU (menu));
1208 g_return_if_fail (GTK_IS_WIDGET (attach_widget));
1210 /* keep this function in sync with gtk_widget_set_parent() */
1211 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1214 g_warning ("gtk_menu_attach_to_widget(): menu already attached to %s",
1215 g_type_name (G_TYPE_FROM_INSTANCE (data->attach_widget)));
1219 g_object_ref_sink (menu);
1221 data = g_slice_new (GtkMenuAttachData);
1222 data->attach_widget = attach_widget;
1224 g_signal_connect (attach_widget, "screen-changed",
1225 G_CALLBACK (attach_widget_screen_changed), menu);
1226 attach_widget_screen_changed (attach_widget, NULL, menu);
1228 data->detacher = detacher;
1229 g_object_set_data (G_OBJECT (menu), I_(attach_data_key), data);
1230 list = g_object_steal_data (G_OBJECT (attach_widget), ATTACHED_MENUS);
1231 if (!g_list_find (list, menu))
1232 list = g_list_prepend (list, menu);
1234 g_object_set_data_full (G_OBJECT (attach_widget), I_(ATTACHED_MENUS), list,
1235 (GDestroyNotify) g_list_free);
1237 /* Attach the widget to the toplevel window. */
1238 gtk_window_set_attached_to (GTK_WINDOW (menu->priv->toplevel), attach_widget);
1240 _gtk_widget_update_parent_muxer (GTK_WIDGET (menu));
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 /* Detach the toplevel window. */
1295 gtk_window_set_attached_to (GTK_WINDOW (menu->priv->toplevel), NULL);
1297 g_signal_handlers_disconnect_by_func (data->attach_widget,
1298 (gpointer) attach_widget_screen_changed,
1302 data->detacher (data->attach_widget, menu);
1303 list = g_object_steal_data (G_OBJECT (data->attach_widget), ATTACHED_MENUS);
1304 list = g_list_remove (list, menu);
1306 g_object_set_data_full (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), list,
1307 (GDestroyNotify) g_list_free);
1309 g_object_set_data (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), NULL);
1311 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
1312 gtk_widget_unrealize (GTK_WIDGET (menu));
1314 g_slice_free (GtkMenuAttachData, data);
1316 _gtk_widget_update_parent_muxer (GTK_WIDGET (menu));
1318 /* Fallback title for menu comes from attach widget */
1319 gtk_menu_update_title (menu);
1321 g_object_notify (G_OBJECT (menu), "attach-widget");
1322 g_object_unref (menu);
1326 gtk_menu_remove (GtkContainer *container,
1329 GtkMenu *menu = GTK_MENU (container);
1330 GtkMenuPrivate *priv = menu->priv;
1332 /* Clear out old_active_menu_item if it matches the item we are removing */
1333 if (priv->old_active_menu_item == widget)
1334 g_clear_object (&priv->old_active_menu_item);
1336 GTK_CONTAINER_CLASS (gtk_menu_parent_class)->remove (container, widget);
1338 g_object_set_data (G_OBJECT (widget), I_(ATTACH_INFO_KEY), NULL);
1340 menu_queue_resize (menu);
1346 * Creates a new #GtkMenu
1348 * Returns: a new #GtkMenu
1353 return g_object_new (GTK_TYPE_MENU, NULL);
1357 gtk_menu_real_insert (GtkMenuShell *menu_shell,
1361 GtkMenu *menu = GTK_MENU (menu_shell);
1362 GtkMenuPrivate *priv = menu->priv;
1363 AttachInfo *ai = get_attach_info (child);
1365 ai->left_attach = -1;
1366 ai->right_attach = -1;
1367 ai->top_attach = -1;
1368 ai->bottom_attach = -1;
1370 if (gtk_widget_get_realized (GTK_WIDGET (menu_shell)))
1371 gtk_widget_set_parent_window (child, priv->bin_window);
1373 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->insert (menu_shell, child, position);
1375 menu_queue_resize (menu);
1379 gtk_menu_tearoff_bg_copy (GtkMenu *menu)
1381 GtkMenuPrivate *priv = menu->priv;
1387 cairo_surface_t *surface;
1388 cairo_pattern_t *pattern;
1391 priv->tearoff_active = FALSE;
1392 priv->saved_scroll_offset = priv->scroll_offset;
1394 window = gtk_widget_get_window (priv->tearoff_window);
1395 width = gdk_window_get_width (window);
1396 height = gdk_window_get_height (window);
1398 surface = gdk_window_create_similar_surface (window,
1399 CAIRO_CONTENT_COLOR,
1403 cr = cairo_create (surface);
1404 gdk_cairo_set_source_window (cr, window, 0, 0);
1408 gtk_widget_set_size_request (priv->tearoff_window, width, height);
1410 pattern = cairo_pattern_create_for_surface (surface);
1411 gdk_window_set_background_pattern (window, pattern);
1413 cairo_pattern_destroy (pattern);
1414 cairo_surface_destroy (surface);
1419 popup_grab_on_window (GdkWindow *window,
1420 GdkDevice *keyboard,
1422 guint32 activate_time)
1425 gdk_device_grab (keyboard, window,
1426 GDK_OWNERSHIP_WINDOW, TRUE,
1427 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
1428 NULL, activate_time) != GDK_GRAB_SUCCESS)
1432 gdk_device_grab (pointer, window,
1433 GDK_OWNERSHIP_WINDOW, TRUE,
1434 GDK_SMOOTH_SCROLL_MASK |
1435 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1436 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1437 GDK_POINTER_MOTION_MASK,
1438 NULL, activate_time) != GDK_GRAB_SUCCESS)
1441 gdk_device_ungrab (keyboard, activate_time);
1450 * gtk_menu_popup_for_device:
1452 * @device: (allow-none): a #GdkDevice
1453 * @parent_menu_shell: (allow-none): the menu shell containing the triggering
1454 * menu item, or %NULL
1455 * @parent_menu_item: (allow-none): the menu item whose activation triggered
1456 * the popup, or %NULL
1457 * @func: (allow-none): a user supplied function used to position the menu,
1459 * @data: (allow-none): user supplied data to be passed to @func
1460 * @destroy: (allow-none): destroy notify for @data
1461 * @button: the mouse button which was pressed to initiate the event
1462 * @activate_time: the time at which the activation event occurred
1464 * Displays a menu and makes it available for selection.
1466 * Applications can use this function to display context-sensitive menus,
1467 * and will typically supply %NULL for the @parent_menu_shell,
1468 * @parent_menu_item, @func, @data and @destroy parameters. The default
1469 * menu positioning function will position the menu at the current position
1470 * of @device (or its corresponding pointer).
1472 * The @button parameter should be the mouse button pressed to initiate
1473 * the menu popup. If the menu popup was initiated by something other than
1474 * a mouse button press, such as a mouse button release or a keypress,
1475 * @button should be 0.
1477 * The @activate_time parameter is used to conflict-resolve initiation of
1478 * concurrent requests for mouse/keyboard grab requests. To function
1479 * properly, this needs to be the time stamp of the user event (such as
1480 * a mouse click or key press) that caused the initiation of the popup.
1481 * Only if no such event is available, gtk_get_current_event_time() can
1487 gtk_menu_popup_for_device (GtkMenu *menu,
1489 GtkWidget *parent_menu_shell,
1490 GtkWidget *parent_menu_item,
1491 GtkMenuPositionFunc func,
1493 GDestroyNotify destroy,
1495 guint32 activate_time)
1497 GtkMenuPrivate *priv = menu->priv;
1499 GtkWidget *xgrab_shell;
1501 GdkEvent *current_event;
1502 GtkMenuShell *menu_shell;
1503 gboolean grab_keyboard;
1504 GtkWidget *parent_toplevel;
1505 GdkDevice *keyboard, *pointer, *source_device = NULL;
1507 g_return_if_fail (GTK_IS_MENU (menu));
1508 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1511 device = gtk_get_current_event_device ();
1515 GdkDisplay *display;
1516 GdkDeviceManager *device_manager;
1519 display = gtk_widget_get_display (GTK_WIDGET (menu));
1520 device_manager = gdk_display_get_device_manager (display);
1521 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1523 device = devices->data;
1525 g_list_free (devices);
1528 widget = GTK_WIDGET (menu);
1529 menu_shell = GTK_MENU_SHELL (menu);
1531 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1534 pointer = gdk_device_get_associated_device (device);
1539 keyboard = gdk_device_get_associated_device (device);
1542 menu_shell->priv->parent_menu_shell = parent_menu_shell;
1544 priv->seen_item_enter = FALSE;
1546 /* Find the last viewable ancestor, and make an X grab on it
1548 parent = GTK_WIDGET (menu);
1552 gboolean viewable = TRUE;
1553 GtkWidget *tmp = parent;
1557 if (!gtk_widget_get_mapped (tmp))
1562 tmp = gtk_widget_get_parent (tmp);
1566 xgrab_shell = parent;
1568 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1571 /* We want to receive events generated when we map the menu;
1572 * unfortunately, since there is probably already an implicit
1573 * grab in place from the button that the user used to pop up
1574 * the menu, we won't receive then -- in particular, the EnterNotify
1575 * when the menu pops up under the pointer.
1577 * If we are grabbing on a parent menu shell, no problem; just grab
1578 * on that menu shell first before popping up the window with
1579 * owner_events = TRUE.
1581 * When grabbing on the menu itself, things get more convoluted --
1582 * we do an explicit grab on a specially created window with
1583 * owner_events = TRUE, which we override further down with a
1584 * grab on the menu. (We can't grab on the menu until it is mapped;
1585 * we probably could just leave the grab on the other window,
1586 * with a little reorganization of the code in gtkmenu*).
1588 grab_keyboard = gtk_menu_shell_get_take_focus (menu_shell);
1589 gtk_window_set_accept_focus (GTK_WINDOW (priv->toplevel), grab_keyboard);
1594 if (xgrab_shell && xgrab_shell != widget)
1596 if (popup_grab_on_window (gtk_widget_get_window (xgrab_shell), keyboard, pointer, activate_time))
1598 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1599 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1604 GdkWindow *transfer_window;
1606 xgrab_shell = widget;
1607 transfer_window = menu_grab_transfer_window_get (menu);
1608 if (popup_grab_on_window (transfer_window, keyboard, pointer, activate_time))
1610 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1611 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1615 if (!GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab)
1617 /* We failed to make our pointer/keyboard grab.
1618 * Rather than leaving the user with a stuck up window,
1619 * we just abort here. Presumably the user will try again.
1621 menu_shell->priv->parent_menu_shell = NULL;
1622 menu_grab_transfer_window_destroy (menu);
1626 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (menu), pointer);
1627 menu_shell->priv->active = TRUE;
1628 menu_shell->priv->button = button;
1630 /* If we are popping up the menu from something other than, a button
1631 * press then, as a heuristic, we ignore enter events for the menu
1632 * until we get a MOTION_NOTIFY.
1635 current_event = gtk_get_current_event ();
1638 if ((current_event->type != GDK_BUTTON_PRESS) &&
1639 (current_event->type != GDK_ENTER_NOTIFY))
1640 menu_shell->priv->ignore_enter = TRUE;
1642 source_device = gdk_event_get_source_device (current_event);
1643 gdk_event_free (current_event);
1646 menu_shell->priv->ignore_enter = TRUE;
1650 gtk_menu_tearoff_bg_copy (menu);
1652 gtk_menu_reparent (menu, priv->toplevel, FALSE);
1655 parent_toplevel = NULL;
1656 if (parent_menu_shell)
1657 parent_toplevel = gtk_widget_get_toplevel (parent_menu_shell);
1658 else if (!g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1660 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
1662 parent_toplevel = gtk_widget_get_toplevel (attach_widget);
1665 /* Set transient for to get the right window group and parent */
1666 if (GTK_IS_WINDOW (parent_toplevel))
1667 gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel),
1668 GTK_WINDOW (parent_toplevel));
1670 priv->parent_menu_item = parent_menu_item;
1671 priv->position_func = func;
1672 priv->position_func_data = data;
1673 priv->position_func_data_destroy = destroy;
1674 menu_shell->priv->activate_time = activate_time;
1676 /* We need to show the menu here rather in the init function
1677 * because code expects to be able to tell if the menu is onscreen
1678 * by looking at gtk_widget_get_visible (menu)
1680 gtk_widget_show (GTK_WIDGET (menu));
1682 /* Position the menu, possibly changing the size request
1684 gtk_menu_position (menu, TRUE);
1686 /* Compute the size of the toplevel and realize it so we
1687 * can scroll correctly.
1689 if (!gtk_widget_get_realized (GTK_WIDGET (menu)))
1691 GtkRequisition tmp_request;
1692 GtkAllocation tmp_allocation = { 0, };
1694 /* Instead of trusting the menu position function to queue a
1695 * resize when the menu goes out of bounds, invalidate the cached
1698 gtk_widget_queue_resize (GTK_WIDGET (menu));
1699 gtk_widget_get_preferred_size (priv->toplevel, &tmp_request, NULL);
1701 tmp_allocation.width = tmp_request.width;
1702 tmp_allocation.height = tmp_request.height;
1704 gtk_widget_size_allocate (priv->toplevel, &tmp_allocation);
1706 gtk_widget_realize (priv->toplevel);
1709 gtk_menu_scroll_to (menu, priv->scroll_offset);
1711 /* if no item is selected, select the first one */
1712 if (!menu_shell->priv->active_menu_item &&
1713 source_device && gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
1714 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);
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: (scope async) (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 #GtkComboBox 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.
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 GtkBorder arrow_border, padding;
2532 g_return_if_fail (GTK_IS_MENU (widget));
2534 gtk_widget_set_realized (widget, TRUE);
2536 gtk_widget_get_allocation (widget, &allocation);
2538 attributes.window_type = GDK_WINDOW_CHILD;
2539 attributes.x = allocation.x;
2540 attributes.y = allocation.y;
2541 attributes.width = allocation.width;
2542 attributes.height = allocation.height;
2543 attributes.wclass = GDK_INPUT_OUTPUT;
2544 attributes.visual = gtk_widget_get_visual (widget);
2545 attributes.event_mask = gtk_widget_get_events (widget);
2546 attributes.event_mask |= (GDK_EXPOSURE_MASK | GDK_KEY_PRESS_MASK |
2547 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK );
2549 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
2551 window = gdk_window_new (gtk_widget_get_parent_window (widget),
2552 &attributes, attributes_mask);
2553 gtk_widget_set_window (widget, window);
2554 gdk_window_set_user_data (window, widget);
2556 get_menu_padding (widget, &padding);
2557 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2558 context = gtk_widget_get_style_context (widget);
2560 gtk_widget_get_allocation (widget, &allocation);
2562 attributes.x = border_width + padding.left;
2563 attributes.y = border_width + padding.top;
2564 attributes.width = allocation.width -
2565 (2 * border_width) - padding.left - padding.right;
2566 attributes.height = allocation.height -
2567 (2 * border_width) - padding.top - padding.bottom;
2569 get_arrows_border (menu, &arrow_border);
2570 attributes.y += arrow_border.top;
2571 attributes.height -= arrow_border.top;
2572 attributes.height -= arrow_border.bottom;
2574 attributes.width = MAX (1, attributes.width);
2575 attributes.height = MAX (1, attributes.height);
2577 priv->view_window = gdk_window_new (window,
2578 &attributes, attributes_mask);
2579 gdk_window_set_user_data (priv->view_window, menu);
2581 gtk_widget_get_allocation (widget, &allocation);
2585 attributes.width = allocation.width + (2 * border_width) +
2586 padding.left + padding.right;
2587 attributes.height = priv->requested_height - (2 * border_width) +
2588 padding.top + padding.bottom;
2590 attributes.width = MAX (1, attributes.width);
2591 attributes.height = MAX (1, attributes.height);
2593 priv->bin_window = gdk_window_new (priv->view_window,
2594 &attributes, attributes_mask);
2595 gdk_window_set_user_data (priv->bin_window, menu);
2597 children = GTK_MENU_SHELL (menu)->priv->children;
2600 child = children->data;
2601 children = children->next;
2603 gtk_widget_set_parent_window (child, priv->bin_window);
2606 gtk_style_context_set_background (context, priv->bin_window);
2607 gtk_style_context_set_background (context, priv->view_window);
2608 gtk_style_context_set_background (context, window);
2610 if (GTK_MENU_SHELL (widget)->priv->active_menu_item)
2611 gtk_menu_scroll_item_visible (GTK_MENU_SHELL (widget),
2612 GTK_MENU_SHELL (widget)->priv->active_menu_item);
2614 gdk_window_show (priv->bin_window);
2615 gdk_window_show (priv->view_window);
2619 gtk_menu_focus (GtkWidget *widget,
2620 GtkDirectionType direction)
2622 /* A menu or its menu items cannot have focus */
2626 /* See notes in gtk_menu_popup() for information
2627 * about the "grab transfer window"
2630 menu_grab_transfer_window_get (GtkMenu *menu)
2632 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2635 GdkWindowAttr attributes;
2636 gint attributes_mask;
2638 attributes.x = -100;
2639 attributes.y = -100;
2640 attributes.width = 10;
2641 attributes.height = 10;
2642 attributes.window_type = GDK_WINDOW_TEMP;
2643 attributes.wclass = GDK_INPUT_ONLY;
2644 attributes.override_redirect = TRUE;
2645 attributes.event_mask = 0;
2647 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
2649 window = gdk_window_new (gtk_widget_get_root_window (GTK_WIDGET (menu)),
2650 &attributes, attributes_mask);
2651 gdk_window_set_user_data (window, menu);
2653 gdk_window_show (window);
2655 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), window);
2662 menu_grab_transfer_window_destroy (GtkMenu *menu)
2664 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2667 gdk_window_set_user_data (window, NULL);
2668 gdk_window_destroy (window);
2669 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), NULL);
2674 gtk_menu_unrealize (GtkWidget *widget)
2676 GtkMenu *menu = GTK_MENU (widget);
2677 GtkMenuPrivate *priv = menu->priv;
2679 menu_grab_transfer_window_destroy (menu);
2681 gdk_window_set_user_data (priv->view_window, NULL);
2682 gdk_window_destroy (priv->view_window);
2683 priv->view_window = NULL;
2685 gdk_window_set_user_data (priv->bin_window, NULL);
2686 gdk_window_destroy (priv->bin_window);
2687 priv->bin_window = NULL;
2689 GTK_WIDGET_CLASS (gtk_menu_parent_class)->unrealize (widget);
2693 calculate_line_heights (GtkMenu *menu,
2695 guint **ret_min_heights,
2696 guint **ret_nat_heights)
2699 GtkMenuPrivate *priv;
2700 GtkMenuShell *menu_shell;
2701 GtkWidget *child, *widget;
2711 widget = GTK_WIDGET (menu);
2712 menu_shell = GTK_MENU_SHELL (widget);
2714 min_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2715 nat_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2716 n_heights = gtk_menu_get_n_rows (menu);
2717 n_columns = gtk_menu_get_n_columns (menu);
2718 avail_width = for_width - (2 * priv->toggle_size + priv->accel_size) * n_columns;
2720 get_menu_padding (widget, &padding);
2722 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2723 avail_width -= (border_width) * 2 + padding.left + padding.right;
2725 for (children = menu_shell->priv->children; children; children = children->next)
2730 gint child_min, child_nat;
2732 child = children->data;
2734 if (!gtk_widget_get_visible (child))
2737 get_effective_child_attach (child, &l, &r, &t, &b);
2739 part = avail_width / (r - l);
2741 gtk_widget_get_preferred_height_for_width (child, part,
2742 &child_min, &child_nat);
2744 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
2746 part = MAX (child_min, toggle_size) / (b - t);
2747 min_heights[t] = MAX (min_heights[t], part);
2749 part = MAX (child_nat, toggle_size) / (b - t);
2750 nat_heights[t] = MAX (nat_heights[t], part);
2753 if (ret_min_heights)
2754 *ret_min_heights = min_heights;
2756 g_free (min_heights);
2758 if (ret_nat_heights)
2759 *ret_nat_heights = nat_heights;
2761 g_free (nat_heights);
2767 gtk_menu_size_allocate (GtkWidget *widget,
2768 GtkAllocation *allocation)
2771 GtkMenuPrivate *priv;
2772 GtkMenuShell *menu_shell;
2774 GtkAllocation child_allocation;
2781 g_return_if_fail (GTK_IS_MENU (widget));
2782 g_return_if_fail (allocation != NULL);
2784 menu = GTK_MENU (widget);
2785 menu_shell = GTK_MENU_SHELL (widget);
2788 gtk_widget_set_allocation (widget, allocation);
2790 get_menu_padding (widget, &padding);
2791 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2793 g_free (priv->heights);
2794 priv->heights_length = calculate_line_heights (menu,
2799 /* refresh our cached height request */
2800 priv->requested_height = (2 * border_width) + padding.top + padding.bottom;
2801 for (i = 0; i < priv->heights_length; i++)
2802 priv->requested_height += priv->heights[i];
2804 x = border_width + padding.left;
2805 y = border_width + padding.top;
2806 width = allocation->width - (2 * border_width) -
2807 padding.left - padding.right;
2808 height = allocation->height - (2 * border_width) -
2809 padding.top - padding.bottom;
2811 if (menu_shell->priv->active)
2812 gtk_menu_scroll_to (menu, priv->scroll_offset);
2814 if (!priv->tearoff_active)
2816 GtkBorder arrow_border;
2818 get_arrows_border (menu, &arrow_border);
2819 y += arrow_border.top;
2820 height -= arrow_border.top;
2821 height -= arrow_border.bottom;
2824 width = MAX (1, width);
2825 height = MAX (1, height);
2827 if (gtk_widget_get_realized (widget))
2829 gdk_window_move_resize (gtk_widget_get_window (widget),
2830 allocation->x, allocation->y,
2831 allocation->width, allocation->height);
2833 gdk_window_move_resize (priv->view_window, x, y, width, height);
2836 if (menu_shell->priv->children)
2838 gint base_width = width / gtk_menu_get_n_columns (menu);
2840 children = menu_shell->priv->children;
2843 child = children->data;
2844 children = children->next;
2846 if (gtk_widget_get_visible (child))
2851 get_effective_child_attach (child, &l, &r, &t, &b);
2853 if (gtk_widget_get_direction (GTK_WIDGET (menu)) == GTK_TEXT_DIR_RTL)
2856 tmp = gtk_menu_get_n_columns (menu) - l;
2857 l = gtk_menu_get_n_columns (menu) - r;
2861 child_allocation.width = (r - l) * base_width;
2862 child_allocation.height = 0;
2863 child_allocation.x = l * base_width;
2864 child_allocation.y = 0;
2866 for (i = 0; i < b; i++)
2869 child_allocation.y += priv->heights[i];
2871 child_allocation.height += priv->heights[i];
2874 gtk_menu_item_toggle_size_allocate (GTK_MENU_ITEM (child),
2877 gtk_widget_size_allocate (child, &child_allocation);
2878 gtk_widget_queue_draw (child);
2882 /* Resize the item window */
2883 if (gtk_widget_get_realized (widget))
2889 for (i = 0; i < gtk_menu_get_n_rows (menu); i++)
2890 height += priv->heights[i];
2892 width = gtk_menu_get_n_columns (menu) * base_width;
2893 gdk_window_resize (priv->bin_window, width, height);
2896 if (priv->tearoff_active)
2898 if (height >= priv->requested_height)
2900 if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2902 gtk_widget_hide (priv->tearoff_scrollbar);
2903 gtk_menu_set_tearoff_hints (menu, allocation->width);
2905 gtk_menu_scroll_to (menu, 0);
2910 gtk_adjustment_configure (priv->tearoff_adjustment,
2911 gtk_adjustment_get_value (priv->tearoff_adjustment),
2913 priv->requested_height,
2914 gtk_adjustment_get_step_increment (priv->tearoff_adjustment),
2915 gtk_adjustment_get_page_increment (priv->tearoff_adjustment),
2916 allocation->height);
2918 if (!gtk_widget_get_visible (priv->tearoff_scrollbar))
2920 gtk_widget_show (priv->tearoff_scrollbar);
2921 gtk_menu_set_tearoff_hints (menu, allocation->width);
2929 get_arrows_visible_area (GtkMenu *menu,
2930 GdkRectangle *border,
2931 GdkRectangle *upper,
2932 GdkRectangle *lower,
2935 GtkArrowPlacement arrow_placement;
2936 GtkWidget *widget = GTK_WIDGET (menu);
2938 gint scroll_arrow_height;
2939 GtkBorder menu_padding;
2941 gtk_widget_style_get (widget,
2942 "scroll-arrow-vlength", &scroll_arrow_height,
2943 "arrow-placement", &arrow_placement,
2946 get_menu_padding (widget, &menu_padding);
2947 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2948 border->x = border_width + menu_padding.left;
2949 border->y = border_width + menu_padding.top;
2950 border->width = gdk_window_get_width (gtk_widget_get_window (widget));
2951 border->height = gdk_window_get_height (gtk_widget_get_window (widget));
2953 switch (arrow_placement)
2955 case GTK_ARROWS_BOTH:
2956 upper->x = border->x;
2957 upper->y = border->y;
2958 upper->width = border->width - 2 * border->x;
2959 upper->height = scroll_arrow_height;
2961 lower->x = border->x;
2962 lower->y = border->height - border->y - scroll_arrow_height;
2963 lower->width = border->width - 2 * border->x;
2964 lower->height = scroll_arrow_height;
2967 case GTK_ARROWS_START:
2968 upper->x = border->x;
2969 upper->y = border->y;
2970 upper->width = (border->width - 2 * border->x) / 2;
2971 upper->height = scroll_arrow_height;
2973 lower->x = border->x + upper->width;
2974 lower->y = border->y;
2975 lower->width = (border->width - 2 * border->x) / 2;
2976 lower->height = scroll_arrow_height;
2979 case GTK_ARROWS_END:
2980 upper->x = border->x;
2981 upper->y = border->height - border->y - scroll_arrow_height;
2982 upper->width = (border->width - 2 * border->x) / 2;
2983 upper->height = scroll_arrow_height;
2985 lower->x = border->x + upper->width;
2986 lower->y = border->height - border->y - scroll_arrow_height;
2987 lower->width = (border->width - 2 * border->x) / 2;
2988 lower->height = scroll_arrow_height;
2992 g_assert_not_reached();
2993 upper->x = upper->y = upper->width = upper->height = 0;
2994 lower->x = lower->y = lower->width = lower->height = 0;
2997 *arrow_space = scroll_arrow_height - menu_padding.top - menu_padding.bottom;
3001 gtk_menu_draw (GtkWidget *widget,
3005 GtkMenuPrivate *priv;
3006 GtkStyleContext *context;
3007 GdkRectangle border;
3011 GtkBorder menu_padding;
3013 menu = GTK_MENU (widget);
3015 context = gtk_widget_get_style_context (widget);
3017 get_arrows_visible_area (menu, &border, &upper, &lower, &arrow_space);
3018 get_menu_padding (widget, &menu_padding);
3020 if (gtk_cairo_should_draw_window (cr, gtk_widget_get_window (widget)))
3022 gfloat arrow_scaling;
3025 gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
3026 arrow_size = arrow_scaling * arrow_space;
3028 gtk_render_background (context, cr, 0, 0,
3029 gtk_widget_get_allocated_width (widget),
3030 gtk_widget_get_allocated_height (widget));
3031 gtk_render_frame (context, cr, 0, 0,
3032 gtk_widget_get_allocated_width (widget),
3033 gtk_widget_get_allocated_height (widget));
3035 gtk_style_context_save (context);
3036 gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
3038 if (priv->upper_arrow_visible && !priv->tearoff_active)
3040 gtk_style_context_save (context);
3041 gtk_style_context_set_state (context, priv->upper_arrow_state);
3043 gtk_render_background (context, cr,
3045 upper.width, upper.height);
3046 gtk_render_frame (context, cr,
3048 upper.width, upper.height);
3050 gtk_render_arrow (context, cr, 0,
3051 upper.x + (upper.width - arrow_size) / 2,
3052 upper.y + menu_padding.top + (arrow_space - arrow_size) / 2,
3055 gtk_style_context_restore (context);
3058 if (priv->lower_arrow_visible && !priv->tearoff_active)
3060 gtk_style_context_save (context);
3061 gtk_style_context_set_state (context, priv->lower_arrow_state);
3063 gtk_render_background (context, cr,
3065 lower.width, lower.height);
3066 gtk_render_frame (context, cr,
3068 lower.width, lower.height);
3070 gtk_render_arrow (context, cr, G_PI,
3071 lower.x + (lower.width - arrow_size) / 2,
3072 lower.y + menu_padding.bottom + (arrow_space - arrow_size) / 2,
3075 gtk_style_context_restore (context);
3078 gtk_style_context_restore (context);
3081 if (gtk_cairo_should_draw_window (cr, priv->bin_window))
3083 gint y = -border.y + priv->scroll_offset;
3086 gtk_cairo_transform_to_window (cr, widget, priv->bin_window);
3088 if (!priv->tearoff_active)
3090 GtkBorder arrow_border;
3092 get_arrows_border (menu, &arrow_border);
3093 y -= arrow_border.top;
3096 gtk_render_background (context, cr,
3098 border.width, border.height);
3099 gtk_render_frame (context, cr,
3101 border.width, border.height);
3106 GTK_WIDGET_CLASS (gtk_menu_parent_class)->draw (widget, cr);
3112 gtk_menu_show (GtkWidget *widget)
3114 GtkMenu *menu = GTK_MENU (widget);
3116 _gtk_menu_refresh_accel_paths (menu, FALSE);
3118 GTK_WIDGET_CLASS (gtk_menu_parent_class)->show (widget);
3123 gtk_menu_get_preferred_width (GtkWidget *widget,
3128 GtkMenuShell *menu_shell;
3129 GtkMenuPrivate *priv;
3132 guint max_toggle_size;
3133 guint max_accel_width;
3135 gint child_min, child_nat;
3136 gint min_width, nat_width;
3139 menu = GTK_MENU (widget);
3140 menu_shell = GTK_MENU_SHELL (widget);
3143 min_width = nat_width = 0;
3145 max_toggle_size = 0;
3146 max_accel_width = 0;
3148 children = menu_shell->priv->children;
3155 child = children->data;
3156 children = children->next;
3158 if (! gtk_widget_get_visible (child))
3161 get_effective_child_attach (child, &l, &r, &t, &b);
3163 /* It's important to size_request the child
3164 * before doing the toggle size request, in
3165 * case the toggle size request depends on the size
3166 * request of a child of the child (e.g. for ImageMenuItem)
3168 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
3170 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
3171 max_toggle_size = MAX (max_toggle_size, toggle_size);
3172 max_accel_width = MAX (max_accel_width,
3173 GTK_MENU_ITEM (child)->priv->accelerator_width);
3175 part = child_min / (r - l);
3176 min_width = MAX (min_width, part);
3178 part = child_nat / (r - l);
3179 nat_width = MAX (nat_width, part);
3182 /* If the menu doesn't include any images or check items
3183 * reserve the space so that all menus are consistent.
3184 * We only do this for 'ordinary' menus, not for combobox
3185 * menus or multi-column menus
3187 if (max_toggle_size == 0 &&
3188 gtk_menu_get_n_columns (menu) == 1 &&
3189 !priv->no_toggle_size)
3191 GtkStyleContext *context;
3192 GtkWidgetPath *check_path;
3193 guint toggle_spacing;
3194 guint indicator_size;
3196 context = gtk_style_context_new ();
3198 /* Create a GtkCheckMenuItem path, only to query indicator spacing */
3199 check_path = _gtk_widget_create_path (widget);
3200 gtk_widget_path_append_type (check_path, GTK_TYPE_CHECK_MENU_ITEM);
3202 gtk_style_context_set_path (context, check_path);
3203 gtk_widget_path_free (check_path);
3204 gtk_style_context_set_screen (context, gtk_widget_get_screen (widget));
3206 gtk_style_context_get_style (context,
3207 "toggle-spacing", &toggle_spacing,
3208 "indicator-size", &indicator_size,
3211 max_toggle_size = indicator_size + toggle_spacing;
3213 g_object_unref (context);
3216 min_width += 2 * max_toggle_size + max_accel_width;
3217 min_width *= gtk_menu_get_n_columns (menu);
3219 nat_width += 2 * max_toggle_size + max_accel_width;
3220 nat_width *= gtk_menu_get_n_columns (menu);
3222 get_menu_padding (widget, &padding);
3223 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3224 min_width += (2 * border_width) + padding.left + padding.right;
3225 nat_width += (2 * border_width) + padding.left + padding.right;
3227 priv->toggle_size = max_toggle_size;
3228 priv->accel_size = max_accel_width;
3231 *minimum_size = min_width;
3234 *natural_size = nat_width;
3236 /* Don't resize the tearoff if it is not active,
3237 * because it won't redraw (it is only a background pixmap).
3239 if (priv->tearoff_active)
3240 gtk_menu_set_tearoff_hints (menu, min_width);
3244 gtk_menu_get_preferred_height (GtkWidget *widget,
3250 /* Menus are height-for-width only, just return the height
3251 * for the minimum width
3253 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
3254 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
3258 gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
3264 GtkMenu *menu = GTK_MENU (widget);
3265 GtkMenuPrivate *priv = menu->priv;
3266 guint *min_heights, *nat_heights;
3269 gint min_height, nat_height;
3271 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3272 get_menu_padding (widget, &padding);
3274 min_height = nat_height = (2 * border_width) + padding.top + padding.bottom;
3277 calculate_line_heights (menu, for_size, &min_heights, &nat_heights);
3279 for (i = 0; i < n_heights; i++)
3281 min_height += min_heights[i];
3282 nat_height += nat_heights[i];
3285 if (priv->have_position)
3287 GdkScreen *screen = gtk_widget_get_screen (priv->toplevel);
3288 GdkRectangle monitor;
3290 gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
3292 if (priv->position_y + min_height > monitor.y + monitor.height)
3293 min_height = monitor.y + monitor.height - priv->position_y;
3295 if (priv->position_y + nat_height > monitor.y + monitor.height)
3296 nat_height = monitor.y + monitor.height - priv->position_y;
3298 if (priv->position_y < monitor.y)
3300 min_height -= monitor.y - priv->position_y;
3301 nat_height -= monitor.y - priv->position_y;
3306 *minimum_size = min_height;
3309 *natural_size = nat_height;
3311 g_free (min_heights);
3312 g_free (nat_heights);
3316 pointer_in_menu_window (GtkWidget *widget,
3320 GtkMenu *menu = GTK_MENU (widget);
3321 GtkMenuPrivate *priv = menu->priv;
3322 GtkAllocation allocation;
3324 if (gtk_widget_get_mapped (priv->toplevel))
3326 GtkMenuShell *menu_shell;
3327 gint window_x, window_y;
3329 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
3330 &window_x, &window_y);
3332 gtk_widget_get_allocation (widget, &allocation);
3333 if (x_root >= window_x && x_root < window_x + allocation.width &&
3334 y_root >= window_y && y_root < window_y + allocation.height)
3337 menu_shell = GTK_MENU_SHELL (widget);
3339 if (GTK_IS_MENU (menu_shell->priv->parent_menu_shell))
3340 return pointer_in_menu_window (menu_shell->priv->parent_menu_shell,
3348 gtk_menu_button_press (GtkWidget *widget,
3349 GdkEventButton *event)
3351 GdkDevice *source_device;
3352 GtkWidget *event_widget;
3355 if (event->type != GDK_BUTTON_PRESS)
3358 source_device = gdk_event_get_source_device ((GdkEvent *) event);
3359 event_widget = gtk_get_event_widget ((GdkEvent *) event);
3360 menu = GTK_MENU (widget);
3362 /* Don't pass down to menu shell if a non-menuitem part of the menu
3363 * was clicked. The check for the event_widget being a GtkMenuShell
3364 * works because we have the pointer grabbed on menu_shell->window
3365 * with owner_events=TRUE, so all events that are either outside
3366 * the menu or on its border are delivered relative to
3367 * menu_shell->window.
3369 if (GTK_IS_MENU_SHELL (event_widget) &&
3370 pointer_in_menu_window (widget, event->x_root, event->y_root))
3373 if (GTK_IS_MENU_ITEM (event_widget) &&
3374 gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN &&
3375 GTK_MENU_ITEM (event_widget)->priv->submenu != NULL &&
3376 !gtk_widget_is_drawable (GTK_MENU_ITEM (event_widget)->priv->submenu))
3377 menu->priv->ignore_button_release = TRUE;
3379 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_press_event (widget, event);
3383 gtk_menu_button_release (GtkWidget *widget,
3384 GdkEventButton *event)
3386 GtkMenuPrivate *priv = GTK_MENU (widget)->priv;
3388 if (priv->ignore_button_release)
3390 priv->ignore_button_release = FALSE;
3394 if (event->type != GDK_BUTTON_RELEASE)
3397 /* Don't pass down to menu shell if a non-menuitem part of the menu
3398 * was clicked (see comment in button_press()).
3400 if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3401 pointer_in_menu_window (widget, event->x_root, event->y_root))
3403 /* Ugly: make sure menu_shell->button gets reset to 0 when we
3404 * bail out early here so it is in a consistent state for the
3405 * next button_press/button_release in GtkMenuShell.
3408 if (GTK_MENU_SHELL (widget)->priv->active)
3409 GTK_MENU_SHELL (widget)->priv->button = 0;
3414 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_release_event (widget, event);
3417 static const gchar *
3418 get_accel_path (GtkWidget *menu_item,
3423 GClosure *accel_closure;
3424 GtkAccelGroup *accel_group;
3426 path = _gtk_widget_get_accel_path (menu_item, locked);
3429 path = GTK_MENU_ITEM (menu_item)->priv->accel_path;
3435 label = gtk_bin_get_child (GTK_BIN (menu_item));
3437 if (GTK_IS_ACCEL_LABEL (label))
3439 g_object_get (label,
3440 "accel-closure", &accel_closure,
3444 accel_group = gtk_accel_group_from_accel_closure (accel_closure);
3446 *locked = gtk_accel_group_get_is_locked (accel_group);
3456 gtk_menu_key_press (GtkWidget *widget,
3459 GtkMenuShell *menu_shell;
3461 gboolean delete = FALSE;
3462 gboolean can_change_accels;
3463 gchar *accel = NULL;
3464 guint accel_key, accel_mods;
3465 GdkModifierType consumed_modifiers;
3466 GdkDisplay *display;
3468 g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
3469 g_return_val_if_fail (event != NULL, FALSE);
3471 menu_shell = GTK_MENU_SHELL (widget);
3472 menu = GTK_MENU (widget);
3474 gtk_menu_stop_navigating_submenu (menu);
3476 if (GTK_WIDGET_CLASS (gtk_menu_parent_class)->key_press_event (widget, event))
3479 display = gtk_widget_get_display (widget);
3481 g_object_get (gtk_widget_get_settings (widget),
3482 "gtk-menu-bar-accel", &accel,
3483 "gtk-can-change-accels", &can_change_accels,
3486 if (accel && *accel)
3489 GdkModifierType mods = 0;
3491 gtk_accelerator_parse (accel, &keyval, &mods);
3494 g_warning ("Failed to parse menu bar accelerator '%s'\n", accel);
3496 /* FIXME this is wrong, needs to be in the global accel resolution
3497 * thing, to properly consider i18n etc., but that probably requires
3498 * AccelGroup changes etc.
3500 if (event->keyval == keyval && (mods & event->state) == mods)
3502 gtk_menu_shell_cancel (menu_shell);
3510 switch (event->keyval)
3512 case GDK_KEY_Delete:
3513 case GDK_KEY_KP_Delete:
3514 case GDK_KEY_BackSpace:
3521 /* Figure out what modifiers went into determining the key symbol */
3522 _gtk_translate_keyboard_accel_state (gdk_keymap_get_for_display (display),
3523 event->hardware_keycode,
3525 gtk_accelerator_get_default_mod_mask (),
3527 &accel_key, NULL, NULL, &consumed_modifiers);
3529 accel_key = gdk_keyval_to_lower (accel_key);
3530 accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
3532 /* If lowercasing affects the keysym, then we need to include SHIFT
3533 * in the modifiers, We re-upper case when we match against the
3534 * keyval, but display and save in caseless form.
3536 if (accel_key != event->keyval)
3537 accel_mods |= GDK_SHIFT_MASK;
3539 /* Modify the accelerators */
3540 if (can_change_accels &&
3541 menu_shell->priv->active_menu_item &&
3542 gtk_bin_get_child (GTK_BIN (menu_shell->priv->active_menu_item)) && /* no separators */
3543 GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu == NULL && /* no submenus */
3544 (delete || gtk_accelerator_valid (accel_key, accel_mods)))
3546 GtkWidget *menu_item = menu_shell->priv->active_menu_item;
3547 gboolean locked, replace_accels = TRUE;
3550 path = get_accel_path (menu_item, &locked);
3551 if (!path || locked)
3553 /* Can't change accelerators on menu_items without paths
3554 * (basically, those items are accelerator-locked).
3556 gtk_widget_error_bell (widget);
3562 /* For the keys that act to delete the current setting,
3563 * we delete the current setting if there is one, otherwise,
3564 * we set the key as the accelerator.
3570 if (gtk_accel_map_lookup_entry (path, &key) &&
3571 (key.accel_key || key.accel_mods))
3577 changed = gtk_accel_map_change_entry (path, accel_key, accel_mods, replace_accels);
3581 /* We failed, probably because this key is in use
3582 * and locked already.
3584 gtk_widget_error_bell (widget);
3593 check_threshold (GtkWidget *widget,
3602 ABS (start_x - x) > THRESHOLD ||
3603 ABS (start_y - y) > THRESHOLD;
3607 definitely_within_item (GtkWidget *widget,
3611 GdkWindow *window = GTK_MENU_ITEM (widget)->priv->event_window;
3614 w = gdk_window_get_width (window);
3615 h = gdk_window_get_height (window);
3618 check_threshold (widget, 0, 0, x, y) &&
3619 check_threshold (widget, w - 1, 0, x, y) &&
3620 check_threshold (widget, w - 1, h - 1, x, y) &&
3621 check_threshold (widget, 0, h - 1, x, y);
3625 gtk_menu_has_navigation_triangle (GtkMenu *menu)
3627 GtkMenuPrivate *priv = menu->priv;
3629 return priv->navigation_height && priv->navigation_width;
3633 gtk_menu_motion_notify (GtkWidget *widget,
3634 GdkEventMotion *event)
3636 GtkWidget *menu_item;
3638 GtkMenuShell *menu_shell;
3640 GdkDevice *source_device;
3642 gboolean need_enter;
3644 source_device = gdk_event_get_source_device ((GdkEvent *) event);
3646 if (GTK_IS_MENU (widget) &&
3647 gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
3649 GtkMenuPrivate *priv = GTK_MENU(widget)->priv;
3651 if (priv->ignore_button_release)
3652 priv->ignore_button_release = FALSE;
3654 gtk_menu_handle_scrolling (GTK_MENU (widget), event->x_root, event->y_root,
3658 /* We received the event for one of two reasons:
3660 * a) We are the active menu, and did gtk_grab_add()
3661 * b) The widget is a child of ours, and the event was propagated
3663 * Since for computation of navigation regions, we want the menu which
3664 * is the parent of the menu item, for a), we need to find that menu,
3665 * which may be different from 'widget'.
3667 menu_item = gtk_get_event_widget ((GdkEvent*) event);
3668 parent = gtk_widget_get_parent (menu_item);
3669 if (!GTK_IS_MENU_ITEM (menu_item) ||
3670 !GTK_IS_MENU (parent))
3673 menu_shell = GTK_MENU_SHELL (parent);
3674 menu = GTK_MENU (menu_shell);
3676 if (definitely_within_item (menu_item, event->x, event->y))
3677 menu_shell->priv->activate_time = 0;
3679 need_enter = (gtk_menu_has_navigation_triangle (menu) || menu_shell->priv->ignore_enter);
3681 /* Check to see if we are within an active submenu's navigation region
3683 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
3686 /* Make sure we pop down if we enter a non-selectable menu item, so we
3687 * don't show a submenu when the cursor is outside the stay-up triangle.
3689 if (!_gtk_menu_item_is_selectable (menu_item))
3691 /* We really want to deselect, but this gives the menushell code
3692 * a chance to do some bookkeeping about the menuitem.
3694 gtk_menu_shell_select_item (menu_shell, menu_item);
3700 /* The menu is now sensitive to enter events on its items, but
3701 * was previously sensitive. So we fake an enter event.
3703 menu_shell->priv->ignore_enter = FALSE;
3705 if (event->x >= 0 && event->x < gdk_window_get_width (event->window) &&
3706 event->y >= 0 && event->y < gdk_window_get_height (event->window))
3708 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
3711 send_event->crossing.window = g_object_ref (event->window);
3712 send_event->crossing.time = event->time;
3713 send_event->crossing.send_event = TRUE;
3714 send_event->crossing.x_root = event->x_root;
3715 send_event->crossing.y_root = event->y_root;
3716 send_event->crossing.x = event->x;
3717 send_event->crossing.y = event->y;
3718 send_event->crossing.state = event->state;
3719 gdk_event_set_device (send_event, gdk_event_get_device ((GdkEvent *) event));
3721 /* We send the event to 'widget', the currently active menu,
3722 * instead of 'menu', the menu that the pointer is in. This
3723 * will ensure that the event will be ignored unless the
3724 * menuitem is a child of the active menu or some parent
3725 * menu of the active menu.
3727 result = gtk_widget_event (widget, send_event);
3728 gdk_event_free (send_event);
3738 get_double_arrows (GtkMenu *menu)
3740 GtkMenuPrivate *priv = menu->priv;
3741 gboolean double_arrows;
3742 GtkArrowPlacement arrow_placement;
3744 gtk_widget_style_get (GTK_WIDGET (menu),
3745 "double-arrows", &double_arrows,
3746 "arrow-placement", &arrow_placement,
3749 if (arrow_placement != GTK_ARROWS_BOTH)
3752 return double_arrows || (priv->initially_pushed_in &&
3753 priv->scroll_offset != 0);
3757 gtk_menu_scroll_by (GtkMenu *menu,
3760 GtkMenuPrivate *priv = menu->priv;
3761 GtkBorder arrow_border;
3765 gboolean double_arrows;
3767 widget = GTK_WIDGET (menu);
3768 offset = priv->scroll_offset + step;
3770 get_arrows_border (menu, &arrow_border);
3772 double_arrows = get_double_arrows (menu);
3774 /* If we scroll upward and the non-visible top part
3775 * is smaller than the scroll arrow it would be
3776 * pretty stupid to show the arrow and taking more
3777 * screen space than just scrolling to the top.
3780 if ((step < 0) && (offset < arrow_border.top))
3783 /* Don't scroll over the top if we weren't before: */
3784 if ((priv->scroll_offset >= 0) && (offset < 0))
3787 view_height = gdk_window_get_height (gtk_widget_get_window (widget));
3789 if (priv->scroll_offset == 0 &&
3790 view_height >= priv->requested_height)
3793 /* Don't scroll past the bottom if we weren't before: */
3794 if (priv->scroll_offset > 0)
3795 view_height -= arrow_border.top;
3797 /* When both arrows are always shown,
3798 * reduce view height even more.
3801 view_height -= arrow_border.bottom;
3803 if ((priv->scroll_offset + view_height <= priv->requested_height) &&
3804 (offset + view_height > priv->requested_height))
3805 offset = priv->requested_height - view_height;
3807 if (offset != priv->scroll_offset)
3808 gtk_menu_scroll_to (menu, offset);
3812 gtk_menu_scroll_timeout (gpointer data)
3816 menu = GTK_MENU (data);
3817 gtk_menu_scroll_by (menu, menu->priv->scroll_step);
3823 gtk_menu_scroll (GtkWidget *widget,
3824 GdkEventScroll *event)
3826 GtkMenu *menu = GTK_MENU (widget);
3828 switch (event->direction)
3830 case GDK_SCROLL_RIGHT:
3831 case GDK_SCROLL_DOWN:
3832 gtk_menu_scroll_by (menu, MENU_SCROLL_STEP2);
3834 case GDK_SCROLL_LEFT:
3836 gtk_menu_scroll_by (menu, - MENU_SCROLL_STEP2);
3838 case GDK_SCROLL_SMOOTH:
3839 gtk_menu_scroll_by (menu, event->delta_y);
3847 get_arrows_sensitive_area (GtkMenu *menu,
3848 GdkRectangle *upper,
3849 GdkRectangle *lower)
3851 GtkArrowPlacement arrow_placement;
3852 GtkWidget *widget = GTK_WIDGET (menu);
3857 gint scroll_arrow_height;
3860 window = gtk_widget_get_window (widget);
3861 width = gdk_window_get_width (window);
3862 height = gdk_window_get_height (window);
3864 gtk_widget_style_get (widget,
3865 "scroll-arrow-vlength", &scroll_arrow_height,
3866 "arrow-placement", &arrow_placement,
3869 border = gtk_container_get_border_width (GTK_CONTAINER (menu));
3870 get_menu_padding (widget, &padding);
3872 gdk_window_get_position (window, &win_x, &win_y);
3874 switch (arrow_placement)
3876 case GTK_ARROWS_BOTH:
3881 upper->width = width;
3882 upper->height = scroll_arrow_height + border + padding.top;
3888 lower->y = win_y + height - border - padding.bottom - scroll_arrow_height;
3889 lower->width = width;
3890 lower->height = scroll_arrow_height + border + padding.bottom;
3894 case GTK_ARROWS_START:
3899 upper->width = width / 2;
3900 upper->height = scroll_arrow_height + border + padding.top;
3905 lower->x = win_x + width / 2;
3907 lower->width = width / 2;
3908 lower->height = scroll_arrow_height + border + padding.bottom;
3912 case GTK_ARROWS_END:
3916 upper->y = win_y + height - border - scroll_arrow_height;
3917 upper->width = width / 2;
3918 upper->height = scroll_arrow_height + border + padding.top;
3923 lower->x = win_x + width / 2;
3924 lower->y = win_y + height - border - scroll_arrow_height;
3925 lower->width = width / 2;
3926 lower->height = scroll_arrow_height + border + padding.bottom;
3934 gtk_menu_handle_scrolling (GtkMenu *menu,
3940 GtkMenuPrivate *priv = menu->priv;
3941 GtkMenuShell *menu_shell;
3944 gboolean scroll_fast = FALSE;
3947 menu_shell = GTK_MENU_SHELL (menu);
3949 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
3954 /* upper arrow handling */
3956 get_arrows_sensitive_area (menu, &rect, NULL);
3959 if (priv->upper_arrow_visible && !priv->tearoff_active &&
3960 (x >= rect.x) && (x < rect.x + rect.width) &&
3961 (y >= rect.y) && (y < rect.y + rect.height))
3966 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
3968 gboolean arrow_pressed = FALSE;
3970 if (priv->upper_arrow_visible && !priv->tearoff_active)
3972 scroll_fast = (y < rect.y + MENU_SCROLL_FAST_ZONE);
3974 if (enter && in_arrow &&
3975 (!priv->upper_arrow_prelight ||
3976 priv->scroll_fast != scroll_fast))
3978 priv->upper_arrow_prelight = TRUE;
3979 priv->scroll_fast = scroll_fast;
3981 /* Deselect the active item so that
3982 * any submenus are popped down
3984 gtk_menu_shell_deselect (menu_shell);
3986 gtk_menu_remove_scroll_timeout (menu);
3987 priv->scroll_step = scroll_fast
3988 ? -MENU_SCROLL_STEP2
3989 : -MENU_SCROLL_STEP1;
3991 priv->scroll_timeout =
3992 gdk_threads_add_timeout (scroll_fast
3993 ? MENU_SCROLL_TIMEOUT2
3994 : MENU_SCROLL_TIMEOUT1,
3995 gtk_menu_scroll_timeout, menu);
3997 else if (!enter && !in_arrow && priv->upper_arrow_prelight)
3999 gtk_menu_stop_scrolling (menu);
4003 /* check if the button isn't insensitive before
4004 * changing it to something else.
4006 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4008 GtkStateFlags arrow_state = 0;
4011 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4013 if (priv->upper_arrow_prelight)
4014 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4016 if (arrow_state != priv->upper_arrow_state)
4018 priv->upper_arrow_state = arrow_state;
4020 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4026 /* lower arrow handling */
4028 get_arrows_sensitive_area (menu, NULL, &rect);
4031 if (priv->lower_arrow_visible && !priv->tearoff_active &&
4032 (x >= rect.x) && (x < rect.x + rect.width) &&
4033 (y >= rect.y) && (y < rect.y + rect.height))
4038 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4040 gboolean arrow_pressed = FALSE;
4042 if (priv->lower_arrow_visible && !priv->tearoff_active)
4044 scroll_fast = (y > rect.y + rect.height - MENU_SCROLL_FAST_ZONE);
4046 if (enter && in_arrow &&
4047 (!priv->lower_arrow_prelight ||
4048 priv->scroll_fast != scroll_fast))
4050 priv->lower_arrow_prelight = TRUE;
4051 priv->scroll_fast = scroll_fast;
4053 /* Deselect the active item so that
4054 * any submenus are popped down
4056 gtk_menu_shell_deselect (menu_shell);
4058 gtk_menu_remove_scroll_timeout (menu);
4059 priv->scroll_step = scroll_fast
4061 : MENU_SCROLL_STEP1;
4063 priv->scroll_timeout =
4064 gdk_threads_add_timeout (scroll_fast
4065 ? MENU_SCROLL_TIMEOUT2
4066 : MENU_SCROLL_TIMEOUT1,
4067 gtk_menu_scroll_timeout, menu);
4069 else if (!enter && !in_arrow && priv->lower_arrow_prelight)
4071 gtk_menu_stop_scrolling (menu);
4075 /* check if the button isn't insensitive before
4076 * changing it to something else.
4078 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4080 GtkStateFlags arrow_state = 0;
4083 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4085 if (priv->lower_arrow_prelight)
4086 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4088 if (arrow_state != priv->lower_arrow_state)
4090 priv->lower_arrow_state = arrow_state;
4092 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4100 gtk_menu_enter_notify (GtkWidget *widget,
4101 GdkEventCrossing *event)
4103 GtkWidget *menu_item;
4105 GdkDevice *source_device;
4107 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4108 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4109 event->mode == GDK_CROSSING_STATE_CHANGED)
4112 source_device = gdk_event_get_source_device ((GdkEvent *) event);
4113 menu_item = gtk_get_event_widget ((GdkEvent*) event);
4115 if (GTK_IS_MENU (widget) &&
4116 gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
4118 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
4120 if (!menu_shell->priv->ignore_enter)
4121 gtk_menu_handle_scrolling (GTK_MENU (widget),
4122 event->x_root, event->y_root, TRUE, TRUE);
4125 if (gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN &&
4126 GTK_IS_MENU_ITEM (menu_item))
4128 GtkWidget *menu = gtk_widget_get_parent (menu_item);
4130 if (GTK_IS_MENU (menu))
4132 GtkMenuPrivate *priv = (GTK_MENU (menu))->priv;
4133 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
4135 if (priv->seen_item_enter)
4137 /* This is the second enter we see for an item
4138 * on this menu. This means a release should always
4141 menu_shell->priv->activate_time = 0;
4143 else if ((event->detail != GDK_NOTIFY_NONLINEAR &&
4144 event->detail != GDK_NOTIFY_NONLINEAR_VIRTUAL))
4146 if (definitely_within_item (menu_item, event->x, event->y))
4148 /* This is an actual user-enter (ie. not a pop-under)
4149 * In this case, the user must either have entered
4150 * sufficiently far enough into the item, or he must move
4151 * far enough away from the enter point. (see
4152 * gtk_menu_motion_notify())
4154 menu_shell->priv->activate_time = 0;
4158 priv->seen_item_enter = TRUE;
4162 /* If this is a faked enter (see gtk_menu_motion_notify), 'widget'
4163 * will not correspond to the event widget's parent. Check to see
4164 * if we are in the parent's navigation region.
4166 parent = gtk_widget_get_parent (menu_item);
4167 if (GTK_IS_MENU_ITEM (menu_item) && GTK_IS_MENU (parent) &&
4168 gtk_menu_navigating_submenu (GTK_MENU (parent),
4169 event->x_root, event->y_root))
4172 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (widget, event);
4176 gtk_menu_leave_notify (GtkWidget *widget,
4177 GdkEventCrossing *event)
4179 GtkMenuShell *menu_shell;
4181 GtkMenuItem *menu_item;
4182 GtkWidget *event_widget;
4183 GdkDevice *source_device;
4185 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4186 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4187 event->mode == GDK_CROSSING_STATE_CHANGED)
4190 menu = GTK_MENU (widget);
4191 menu_shell = GTK_MENU_SHELL (widget);
4193 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
4196 source_device = gdk_event_get_source_device ((GdkEvent *) event);
4198 if (gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
4199 gtk_menu_handle_scrolling (menu, event->x_root, event->y_root, FALSE, TRUE);
4201 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4203 if (!GTK_IS_MENU_ITEM (event_widget))
4206 menu_item = GTK_MENU_ITEM (event_widget);
4208 /* Here we check to see if we're leaving an active menu item
4209 * with a submenu, in which case we enter submenu navigation mode.
4211 if (menu_shell->priv->active_menu_item != NULL
4212 && menu_item->priv->submenu != NULL
4213 && menu_item->priv->submenu_placement == GTK_LEFT_RIGHT)
4215 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active)
4217 gtk_menu_set_submenu_navigation_region (menu, menu_item, event);
4220 else if (menu_item == GTK_MENU_ITEM (menu_shell->priv->active_menu_item))
4222 /* We are leaving an active menu item with nonactive submenu.
4223 * Deselect it so we don't surprise the user with by popping
4224 * up a submenu _after_ he left the item.
4226 gtk_menu_shell_deselect (menu_shell);
4231 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->leave_notify_event (widget, event);
4235 pointer_on_menu_widget (GtkMenu *menu,
4239 GtkMenuPrivate *priv = menu->priv;
4240 GtkAllocation allocation;
4241 gint window_x, window_y;
4243 gtk_widget_get_allocation (GTK_WIDGET (menu), &allocation);
4244 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
4245 &window_x, &window_y);
4247 if (x_root >= window_x && x_root < window_x + allocation.width &&
4248 y_root >= window_y && y_root < window_y + allocation.height)
4255 gtk_menu_captured_event (GtkWidget *widget,
4258 GdkDevice *source_device;
4259 gboolean retval = FALSE;
4260 GtkMenuPrivate *priv;
4262 gdouble x_root, y_root;
4264 GdkModifierType state;
4266 menu = GTK_MENU (widget);
4269 if (!priv->upper_arrow_visible && !priv->lower_arrow_visible && priv->drag_start_y < 0)
4272 source_device = gdk_event_get_source_device (event);
4273 gdk_event_get_root_coords (event, &x_root, &y_root);
4275 switch (event->type)
4277 case GDK_TOUCH_BEGIN:
4278 case GDK_BUTTON_PRESS:
4279 if ((!gdk_event_get_button (event, &button) || button == 1) &&
4280 gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN &&
4281 pointer_on_menu_widget (menu, x_root, y_root))
4283 priv->drag_start_y = event->button.y_root;
4284 priv->initial_drag_offset = priv->scroll_offset;
4285 priv->drag_scroll_started = FALSE;
4288 priv->drag_start_y = -1;
4290 priv->drag_already_pressed = TRUE;
4293 case GDK_BUTTON_RELEASE:
4294 if (priv->drag_scroll_started)
4296 priv->drag_scroll_started = FALSE;
4297 priv->drag_start_y = -1;
4298 priv->drag_already_pressed = FALSE;
4302 case GDK_TOUCH_UPDATE:
4303 case GDK_MOTION_NOTIFY:
4304 if ((!gdk_event_get_state (event, &state) || (state & GDK_BUTTON1_MASK) != 0) &&
4305 gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
4307 if (!priv->drag_already_pressed)
4309 if (pointer_on_menu_widget (menu, x_root, y_root))
4311 priv->drag_start_y = y_root;
4312 priv->initial_drag_offset = priv->scroll_offset;
4313 priv->drag_scroll_started = FALSE;
4316 priv->drag_start_y = -1;
4318 priv->drag_already_pressed = TRUE;
4321 if (priv->drag_start_y < 0 && !priv->drag_scroll_started)
4324 if (priv->drag_scroll_started)
4326 gint offset, view_height;
4327 GtkBorder arrow_border;
4330 y_diff = y_root - priv->drag_start_y;
4331 offset = priv->initial_drag_offset - y_diff;
4333 view_height = gdk_window_get_height (gtk_widget_get_window (widget));
4334 get_arrows_border (menu, &arrow_border);
4336 if (priv->upper_arrow_visible)
4337 view_height -= arrow_border.top;
4339 if (priv->lower_arrow_visible)
4340 view_height -= arrow_border.bottom;
4342 offset = CLAMP (offset,
4343 MIN (priv->scroll_offset, 0),
4344 MAX (priv->scroll_offset, priv->requested_height - view_height));
4346 gtk_menu_scroll_to (menu, offset);
4350 else if (gtk_drag_check_threshold (widget,
4351 0, priv->drag_start_y,
4354 priv->drag_scroll_started = TRUE;
4355 gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
4360 case GDK_ENTER_NOTIFY:
4361 case GDK_LEAVE_NOTIFY:
4362 if (priv->drag_scroll_started)
4373 gtk_menu_stop_navigating_submenu (GtkMenu *menu)
4375 GtkMenuPrivate *priv = menu->priv;
4377 priv->navigation_x = 0;
4378 priv->navigation_y = 0;
4379 priv->navigation_width = 0;
4380 priv->navigation_height = 0;
4382 if (priv->navigation_timeout)
4384 g_source_remove (priv->navigation_timeout);
4385 priv->navigation_timeout = 0;
4389 /* When the timeout is elapsed, the navigation region is destroyed
4390 * and the menuitem under the pointer (if any) is selected.
4393 gtk_menu_stop_navigating_submenu_cb (gpointer user_data)
4395 GtkMenuPopdownData *popdown_data = user_data;
4396 GtkMenu *menu = popdown_data->menu;
4397 GtkMenuPrivate *priv = menu->priv;
4398 GdkWindow *child_window;
4400 gtk_menu_stop_navigating_submenu (menu);
4402 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
4404 child_window = gdk_window_get_device_position (priv->bin_window,
4405 popdown_data->device,
4410 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
4412 send_event->crossing.window = g_object_ref (child_window);
4413 send_event->crossing.time = GDK_CURRENT_TIME; /* Bogus */
4414 send_event->crossing.send_event = TRUE;
4415 gdk_event_set_device (send_event, popdown_data->device);
4417 GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (GTK_WIDGET (menu), (GdkEventCrossing *)send_event);
4419 gdk_event_free (send_event);
4427 gtk_menu_navigating_submenu (GtkMenu *menu,
4431 GtkMenuPrivate *priv = menu->priv;
4434 if (!gtk_menu_has_navigation_triangle (menu))
4437 width = priv->navigation_width;
4438 height = priv->navigation_height;
4440 /* Check if x/y are in the triangle spanned by the navigation parameters */
4442 /* 1) Move the coordinates so the triangle starts at 0,0 */
4443 event_x -= priv->navigation_x;
4444 event_y -= priv->navigation_y;
4446 /* 2) Ensure both legs move along the positive axis */
4458 /* 3) Check that the given coordinate is inside the triangle. The formula
4459 * is a transformed form of this formula: x/w + y/h <= 1
4461 if (event_x >= 0 && event_y >= 0 &&
4462 event_x * height + event_y * width <= width * height)
4468 gtk_menu_stop_navigating_submenu (menu);
4474 gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
4475 GtkMenuItem *menu_item,
4476 GdkEventCrossing *event)
4478 GtkMenuPrivate *priv = menu->priv;
4479 gint submenu_left = 0;
4480 gint submenu_right = 0;
4481 gint submenu_top = 0;
4482 gint submenu_bottom = 0;
4484 GtkWidget *event_widget;
4485 GtkMenuPopdownData *popdown_data;
4488 g_return_if_fail (menu_item->priv->submenu != NULL);
4489 g_return_if_fail (event != NULL);
4491 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4493 window = gtk_widget_get_window (menu_item->priv->submenu);
4494 gdk_window_get_origin (window, &submenu_left, &submenu_top);
4496 submenu_right = submenu_left + gdk_window_get_width (window);
4497 submenu_bottom = submenu_top + gdk_window_get_height (window);
4499 width = gdk_window_get_width (gtk_widget_get_window (event_widget));
4501 if (event->x >= 0 && event->x < width)
4505 gtk_menu_stop_navigating_submenu (menu);
4507 /* The navigation region is the triangle closest to the x/y
4508 * location of the rectangle. This is why the width or height
4511 if (menu_item->priv->submenu_direction == GTK_DIRECTION_RIGHT)
4514 priv->navigation_x = submenu_left;
4515 priv->navigation_width = event->x_root - submenu_left;
4520 priv->navigation_x = submenu_right;
4521 priv->navigation_width = event->x_root - submenu_right;
4527 priv->navigation_y = event->y_root;
4528 priv->navigation_height = submenu_top - event->y_root - NAVIGATION_REGION_OVERSHOOT;
4530 if (priv->navigation_height >= 0)
4536 priv->navigation_y = event->y_root;
4537 priv->navigation_height = submenu_bottom - event->y_root + NAVIGATION_REGION_OVERSHOOT;
4539 if (priv->navigation_height <= 0)
4543 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4544 "gtk-menu-popdown-delay", &popdown_delay,
4547 popdown_data = g_new (GtkMenuPopdownData, 1);
4548 popdown_data->menu = menu;
4549 popdown_data->device = gdk_event_get_device ((GdkEvent *) event);
4551 priv->navigation_timeout = gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
4553 gtk_menu_stop_navigating_submenu_cb,
4555 (GDestroyNotify) g_free);
4560 gtk_menu_deactivate (GtkMenuShell *menu_shell)
4564 g_return_if_fail (GTK_IS_MENU (menu_shell));
4566 parent = menu_shell->priv->parent_menu_shell;
4568 menu_shell->priv->activate_time = 0;
4569 gtk_menu_popdown (GTK_MENU (menu_shell));
4572 gtk_menu_shell_deactivate (GTK_MENU_SHELL (parent));
4576 gtk_menu_position (GtkMenu *menu,
4577 gboolean set_scroll_offset)
4579 GtkMenuPrivate *priv = menu->priv;
4581 GtkRequisition requisition;
4585 GdkScreen *pointer_screen;
4586 GdkRectangle monitor;
4589 widget = GTK_WIDGET (menu);
4591 screen = gtk_widget_get_screen (widget);
4592 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (menu));
4593 gdk_device_get_position (pointer, &pointer_screen, &x, &y);
4595 /* Realize so we have the proper width and heigh to figure out
4596 * the right place to popup the menu.
4598 gtk_widget_realize (priv->toplevel);
4599 requisition.width = gtk_widget_get_allocated_width (widget);
4600 requisition.height = gtk_widget_get_allocated_height (widget);
4602 if (pointer_screen != screen)
4604 /* Pointer is on a different screen; roughly center the
4605 * menu on the screen. If someone was using multiscreen
4606 * + Xinerama together they'd probably want something
4607 * fancier; but that is likely to be vanishingly rare.
4609 x = MAX (0, (gdk_screen_get_width (screen) - requisition.width) / 2);
4610 y = MAX (0, (gdk_screen_get_height (screen) - requisition.height) / 2);
4613 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4614 priv->initially_pushed_in = FALSE;
4616 /* Set the type hint here to allow custom position functions
4617 * to set a different hint
4619 if (!gtk_widget_get_visible (priv->toplevel))
4620 gtk_window_set_type_hint (GTK_WINDOW (priv->toplevel), GDK_WINDOW_TYPE_HINT_POPUP_MENU);
4622 if (priv->position_func)
4624 (* priv->position_func) (menu, &x, &y, &priv->initially_pushed_in,
4625 priv->position_func_data);
4627 if (priv->monitor_num < 0)
4628 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4630 gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
4634 gint space_left, space_right, space_above, space_below;
4638 gboolean rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
4640 get_menu_padding (widget, &padding);
4642 /* The placement of popup menus horizontally works like this (with
4643 * RTL in parentheses)
4645 * - If there is enough room to the right (left) of the mouse cursor,
4646 * position the menu there.
4648 * - Otherwise, if if there is enough room to the left (right) of the
4649 * mouse cursor, position the menu there.
4651 * - Otherwise if the menu is smaller than the monitor, position it
4652 * on the side of the mouse cursor that has the most space available
4654 * - Otherwise (if there is simply not enough room for the menu on the
4655 * monitor), position it as far left (right) as possible.
4657 * Positioning in the vertical direction is similar: first try below
4658 * mouse cursor, then above.
4660 gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
4662 space_left = x - monitor.x;
4663 space_right = monitor.x + monitor.width - x - 1;
4664 space_above = y - monitor.y;
4665 space_below = monitor.y + monitor.height - y - 1;
4667 /* Position horizontally. */
4669 /* the amount of space we need to position the menu.
4670 * Note the menu is offset "thickness" pixels
4672 needed_width = requisition.width - padding.left;
4674 if (needed_width <= space_left ||
4675 needed_width <= space_right)
4677 if ((rtl && needed_width <= space_left) ||
4678 (!rtl && needed_width > space_right))
4681 x = x + padding.left - requisition.width + 1;
4685 /* position right */
4686 x = x - padding.right;
4689 /* x is clamped on-screen further down */
4691 else if (requisition.width <= monitor.width)
4693 /* the menu is too big to fit on either side of the mouse
4694 * cursor, but smaller than the monitor. Position it on
4695 * the side that has the most space
4697 if (space_left > space_right)
4705 x = monitor.x + monitor.width - requisition.width;
4708 else /* menu is simply too big for the monitor */
4713 x = monitor.x + monitor.width - requisition.width;
4722 /* Position vertically.
4723 * The algorithm is the same as above, but simpler
4724 * because we don't have to take RTL into account.
4726 needed_height = requisition.height - padding.top;
4728 if (needed_height <= space_above ||
4729 needed_height <= space_below)
4731 if (needed_height <= space_below)
4732 y = y - padding.top;
4734 y = y + padding.bottom - requisition.height + 1;
4736 y = CLAMP (y, monitor.y,
4737 monitor.y + monitor.height - requisition.height);
4739 else if (needed_height > space_below && needed_height > space_above)
4741 if (space_below >= space_above)
4742 y = monitor.y + monitor.height - requisition.height;
4754 if (y + requisition.height > monitor.y + monitor.height)
4756 if (priv->initially_pushed_in)
4757 scroll_offset += (monitor.y + monitor.height) - requisition.height - y;
4758 y = (monitor.y + monitor.height) - requisition.height;
4763 if (priv->initially_pushed_in)
4764 scroll_offset += monitor.y - y;
4768 x = CLAMP (x, monitor.x, MAX (monitor.x, monitor.x + monitor.width - requisition.width));
4770 if (GTK_MENU_SHELL (menu)->priv->active)
4772 priv->have_position = TRUE;
4773 priv->position_x = x;
4774 priv->position_y = y;
4777 if (scroll_offset != 0)
4779 GtkBorder arrow_border;
4781 get_arrows_border (menu, &arrow_border);
4782 scroll_offset += arrow_border.top;
4785 gtk_window_move (GTK_WINDOW (GTK_MENU_SHELL (menu)->priv->active ? priv->toplevel : priv->tearoff_window),
4788 if (!GTK_MENU_SHELL (menu)->priv->active)
4790 gtk_window_resize (GTK_WINDOW (priv->tearoff_window),
4791 requisition.width, requisition.height);
4794 if (set_scroll_offset)
4795 priv->scroll_offset = scroll_offset;
4799 gtk_menu_remove_scroll_timeout (GtkMenu *menu)
4801 GtkMenuPrivate *priv = menu->priv;
4803 if (priv->scroll_timeout)
4805 g_source_remove (priv->scroll_timeout);
4806 priv->scroll_timeout = 0;
4811 gtk_menu_stop_scrolling (GtkMenu *menu)
4813 GtkMenuPrivate *priv = menu->priv;
4815 gtk_menu_remove_scroll_timeout (menu);
4816 priv->upper_arrow_prelight = FALSE;
4817 priv->lower_arrow_prelight = FALSE;
4821 gtk_menu_scroll_to (GtkMenu *menu,
4824 GtkMenuPrivate *priv = menu->priv;
4825 GtkBorder arrow_border, padding;
4828 gint view_width, view_height;
4831 gboolean double_arrows;
4833 widget = GTK_WIDGET (menu);
4835 if (priv->tearoff_active && priv->tearoff_adjustment)
4836 gtk_adjustment_set_value (priv->tearoff_adjustment, offset);
4838 /* Move/resize the viewport according to arrows: */
4839 view_width = gtk_widget_get_allocated_width (widget);
4840 view_height = gtk_widget_get_allocated_height (widget);
4842 get_menu_padding (widget, &padding);
4843 double_arrows = get_double_arrows (menu);
4845 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
4847 view_width -= (2 * border_width) + padding.left + padding.right;
4848 view_height -= (2 * border_width) + padding.top + padding.bottom;
4849 menu_height = priv->requested_height - (2 * border_width) - padding.top - padding.bottom;
4851 x = border_width + padding.left;
4852 y = border_width + padding.top;
4854 if (double_arrows && !priv->tearoff_active)
4856 if (view_height < menu_height ||
4857 (offset > 0 && priv->scroll_offset > 0) ||
4858 (offset < 0 && priv->scroll_offset < 0))
4860 GtkStateFlags upper_arrow_previous_state = priv->upper_arrow_state;
4861 GtkStateFlags lower_arrow_previous_state = priv->lower_arrow_state;
4863 if (!priv->upper_arrow_visible || !priv->lower_arrow_visible)
4864 gtk_widget_queue_draw (GTK_WIDGET (menu));
4866 priv->upper_arrow_visible = priv->lower_arrow_visible = TRUE;
4868 get_arrows_border (menu, &arrow_border);
4869 y += arrow_border.top;
4870 view_height -= arrow_border.top;
4871 view_height -= arrow_border.bottom;
4874 priv->upper_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
4877 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
4879 if (priv->upper_arrow_prelight)
4880 priv->upper_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4882 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
4885 if (offset >= menu_height - view_height)
4886 priv->lower_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
4889 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
4891 if (priv->lower_arrow_prelight)
4892 priv->lower_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4894 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
4897 if ((priv->upper_arrow_state != upper_arrow_previous_state) ||
4898 (priv->lower_arrow_state != lower_arrow_previous_state))
4899 gtk_widget_queue_draw (GTK_WIDGET (menu));
4901 if ((upper_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
4902 (priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
4904 /* At the upper border, possibly remove timeout */
4905 if (priv->scroll_step < 0)
4907 gtk_menu_stop_scrolling (menu);
4908 gtk_widget_queue_draw (GTK_WIDGET (menu));
4912 if ((lower_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
4913 (priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
4915 /* At the lower border, possibly remove timeout */
4916 if (priv->scroll_step > 0)
4918 gtk_menu_stop_scrolling (menu);
4919 gtk_widget_queue_draw (GTK_WIDGET (menu));
4923 else if (priv->upper_arrow_visible || priv->lower_arrow_visible)
4927 priv->upper_arrow_visible = priv->lower_arrow_visible = FALSE;
4928 priv->upper_arrow_prelight = priv->lower_arrow_prelight = FALSE;
4930 gtk_menu_stop_scrolling (menu);
4931 gtk_widget_queue_draw (GTK_WIDGET (menu));
4934 else if (!priv->tearoff_active)
4936 gboolean last_visible;
4938 last_visible = priv->upper_arrow_visible;
4939 priv->upper_arrow_visible = offset > 0;
4941 /* upper_arrow_visible may have changed, so requery the border */
4942 get_arrows_border (menu, &arrow_border);
4943 view_height -= arrow_border.top;
4945 if ((last_visible != priv->upper_arrow_visible) &&
4946 !priv->upper_arrow_visible)
4948 priv->upper_arrow_prelight = FALSE;
4950 /* If we hide the upper arrow, possibly remove timeout */
4951 if (priv->scroll_step < 0)
4953 gtk_menu_stop_scrolling (menu);
4954 gtk_widget_queue_draw (GTK_WIDGET (menu));
4958 last_visible = priv->lower_arrow_visible;
4959 priv->lower_arrow_visible = offset < menu_height - view_height;
4961 /* lower_arrow_visible may have changed, so requery the border */
4962 get_arrows_border (menu, &arrow_border);
4963 view_height -= arrow_border.bottom;
4965 if ((last_visible != priv->lower_arrow_visible) &&
4966 !priv->lower_arrow_visible)
4968 priv->lower_arrow_prelight = FALSE;
4970 /* If we hide the lower arrow, possibly remove timeout */
4971 if (priv->scroll_step > 0)
4973 gtk_menu_stop_scrolling (menu);
4974 gtk_widget_queue_draw (GTK_WIDGET (menu));
4978 y += arrow_border.top;
4981 /* Scroll the menu: */
4982 if (gtk_widget_get_realized (widget))
4984 gdk_window_move (priv->bin_window, 0, -offset);
4985 gdk_window_move_resize (priv->view_window, x, y, view_width, view_height);
4988 priv->scroll_offset = offset;
4992 compute_child_offset (GtkMenu *menu,
4993 GtkWidget *menu_item,
4996 gboolean *is_last_child)
4998 GtkMenuPrivate *priv = menu->priv;
4999 gint item_top_attach;
5000 gint item_bottom_attach;
5001 gint child_offset = 0;
5004 get_effective_child_attach (menu_item, NULL, NULL,
5005 &item_top_attach, &item_bottom_attach);
5007 /* there is a possibility that we get called before _size_request,
5008 * so check the height table for safety.
5010 if (!priv->heights || priv->heights_length < gtk_menu_get_n_rows (menu))
5013 /* when we have a row with only invisible children, its height will
5014 * be zero, so there's no need to check WIDGET_VISIBLE here
5016 for (i = 0; i < item_top_attach; i++)
5017 child_offset += priv->heights[i];
5020 *is_last_child = (item_bottom_attach == gtk_menu_get_n_rows (menu));
5022 *offset = child_offset;
5024 *height = priv->heights[item_top_attach];
5030 gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
5031 GtkWidget *menu_item)
5033 GtkMenu *menu = GTK_MENU (menu_shell);
5034 GtkMenuPrivate *priv = menu->priv;
5035 GtkWidget *widget = GTK_WIDGET (menu_shell);
5036 gint child_offset, child_height;
5040 gboolean last_child = 0;
5042 /* We need to check if the selected item fully visible.
5043 * If not we need to scroll the menu so that it becomes fully
5046 if (compute_child_offset (menu, menu_item,
5047 &child_offset, &child_height, &last_child))
5049 gboolean double_arrows;
5052 y = priv->scroll_offset;
5053 height = gdk_window_get_height (gtk_widget_get_window (widget));
5055 double_arrows = get_double_arrows (menu);
5056 get_menu_padding (widget, &padding);
5058 height -= 2 * gtk_container_get_border_width (GTK_CONTAINER (menu)) +
5059 padding.top + padding.bottom;
5061 if (child_offset < y)
5063 /* Ignore the enter event we might get if the pointer
5066 menu_shell->priv->ignore_enter = TRUE;
5067 gtk_menu_scroll_to (menu, child_offset);
5071 GtkBorder arrow_border;
5075 get_arrows_border (menu, &arrow_border);
5076 if (!priv->tearoff_active)
5077 arrow_height = arrow_border.top + arrow_border.bottom;
5079 if (child_offset + child_height > y + height - arrow_height)
5082 if ((!last_child && !priv->tearoff_active) || double_arrows)
5083 arrow_height += arrow_border.bottom;
5085 y = child_offset + child_height - height + arrow_height;
5086 if (((y > 0) && !priv->tearoff_active) || double_arrows)
5088 /* Need upper arrow */
5089 arrow_height += arrow_border.top;
5090 y = child_offset + child_height - height + arrow_height;
5092 /* Ignore the enter event we might get if the pointer
5095 menu_shell->priv->ignore_enter = TRUE;
5096 gtk_menu_scroll_to (menu, y);
5103 gtk_menu_select_item (GtkMenuShell *menu_shell,
5104 GtkWidget *menu_item)
5106 GtkMenu *menu = GTK_MENU (menu_shell);
5108 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
5109 gtk_menu_scroll_item_visible (menu_shell, menu_item);
5111 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->select_item (menu_shell, menu_item);
5115 /* Reparent the menu, taking care of the refcounting
5117 * If unrealize is true we force a unrealize while reparenting the parent.
5118 * This can help eliminate flicker in some cases.
5120 * What happens is that when the menu is unrealized and then re-realized,
5121 * the allocations are as follows:
5123 * parent - 1x1 at (0,0)
5124 * child1 - 100x20 at (0,0)
5125 * child2 - 100x20 at (0,20)
5126 * child3 - 100x20 at (0,40)
5128 * That is, the parent is small but the children are full sized. Then,
5129 * when the queued_resize gets processed, the parent gets resized to
5132 * But in order to eliminate flicker when scrolling, gdkgeometry-x11.c
5133 * contains the following logic:
5135 * - if a move or resize operation on a window would change the clip
5136 * region on the children, then before the window is resized
5137 * the background for children is temporarily set to None, the
5138 * move/resize done, and the background for the children restored.
5140 * So, at the point where the parent is resized to final size, the
5141 * background for the children is temporarily None, and thus they
5142 * are not cleared to the background color and the previous background
5143 * (the image of the menu) is left in place.
5146 gtk_menu_reparent (GtkMenu *menu,
5147 GtkWidget *new_parent,
5150 GObject *object = G_OBJECT (menu);
5151 GtkWidget *widget = GTK_WIDGET (menu);
5152 gboolean was_floating = g_object_is_floating (object);
5154 g_object_ref_sink (object);
5158 g_object_ref (object);
5159 gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (widget)), widget);
5160 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5161 g_object_unref (object);
5164 gtk_widget_reparent (widget, new_parent);
5167 g_object_force_floating (object);
5169 g_object_unref (object);
5173 gtk_menu_show_all (GtkWidget *widget)
5175 /* Show children, but not self. */
5176 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
5180 * gtk_menu_set_screen:
5182 * @screen: (allow-none): a #GdkScreen, or %NULL if the screen should be
5183 * determined by the widget the menu is attached to
5185 * Sets the #GdkScreen on which the menu will be displayed.
5190 gtk_menu_set_screen (GtkMenu *menu,
5193 g_return_if_fail (GTK_IS_MENU (menu));
5194 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
5196 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-explicit-screen"), screen);
5200 menu_change_screen (menu, screen);
5204 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
5206 attach_widget_screen_changed (attach_widget, NULL, menu);
5213 * @child: a #GtkMenuItem
5214 * @left_attach: The column number to attach the left side of the item to
5215 * @right_attach: The column number to attach the right side of the item to
5216 * @top_attach: The row number to attach the top of the item to
5217 * @bottom_attach: The row number to attach the bottom of the item to
5219 * Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
5220 * an item will occupy is specified by @left_attach, @right_attach,
5221 * @top_attach and @bottom_attach. These each represent the leftmost,
5222 * rightmost, uppermost and lower column and row numbers of the table.
5223 * (Columns and rows are indexed from zero).
5225 * Note that this function is not related to gtk_menu_detach().
5230 gtk_menu_attach (GtkMenu *menu,
5235 guint bottom_attach)
5237 GtkMenuShell *menu_shell;
5240 g_return_if_fail (GTK_IS_MENU (menu));
5241 g_return_if_fail (GTK_IS_MENU_ITEM (child));
5242 parent = gtk_widget_get_parent (child);
5243 g_return_if_fail (parent == NULL || parent == GTK_WIDGET (menu));
5244 g_return_if_fail (left_attach < right_attach);
5245 g_return_if_fail (top_attach < bottom_attach);
5247 menu_shell = GTK_MENU_SHELL (menu);
5251 AttachInfo *ai = get_attach_info (child);
5253 ai->left_attach = left_attach;
5254 ai->right_attach = right_attach;
5255 ai->top_attach = top_attach;
5256 ai->bottom_attach = bottom_attach;
5258 menu_shell->priv->children = g_list_append (menu_shell->priv->children, child);
5260 gtk_widget_set_parent (child, GTK_WIDGET (menu));
5262 menu_queue_resize (menu);
5266 gtk_container_child_set (GTK_CONTAINER (parent), child,
5267 "left-attach", left_attach,
5268 "right-attach", right_attach,
5269 "top-attach", top_attach,
5270 "bottom-attach", bottom_attach,
5276 gtk_menu_get_popup_delay (GtkMenuShell *menu_shell)
5280 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
5281 "gtk-menu-popup-delay", &popup_delay,
5288 find_child_containing (GtkMenuShell *menu_shell,
5296 /* find a child which includes the area given by
5297 * left, right, top, bottom.
5299 for (list = menu_shell->priv->children; list; list = list->next)
5303 if (!_gtk_menu_item_is_selectable (list->data))
5306 get_effective_child_attach (list->data, &l, &r, &t, &b);
5308 if (l <= left && right <= r && t <= top && bottom <= b)
5309 return GTK_WIDGET (list->data);
5316 gtk_menu_move_current (GtkMenuShell *menu_shell,
5317 GtkMenuDirectionType direction)
5319 GtkMenu *menu = GTK_MENU (menu_shell);
5322 GtkWidget *match = NULL;
5324 if (gtk_widget_get_direction (GTK_WIDGET (menu_shell)) == GTK_TEXT_DIR_RTL)
5328 case GTK_MENU_DIR_CHILD:
5329 direction = GTK_MENU_DIR_PARENT;
5331 case GTK_MENU_DIR_PARENT:
5332 direction = GTK_MENU_DIR_CHILD;
5338 /* use special table menu key bindings */
5339 if (menu_shell->priv->active_menu_item && gtk_menu_get_n_columns (menu) > 1)
5341 get_effective_child_attach (menu_shell->priv->active_menu_item, &l, &r, &t, &b);
5343 if (direction == GTK_MENU_DIR_NEXT)
5345 for (i = b; i < gtk_menu_get_n_rows (menu); i++)
5347 match = find_child_containing (menu_shell, l, l + 1, i, i + 1);
5355 for (i = 0; i < t; i++)
5357 match = find_child_containing (menu_shell,
5358 l, l + 1, i, i + 1);
5364 else if (direction == GTK_MENU_DIR_PREV)
5366 for (i = t; i > 0; i--)
5368 match = find_child_containing (menu_shell,
5369 l, l + 1, i - 1, i);
5377 for (i = gtk_menu_get_n_rows (menu); i > b; i--)
5379 match = find_child_containing (menu_shell,
5380 l, l + 1, i - 1, i);
5386 else if (direction == GTK_MENU_DIR_PARENT)
5388 /* we go one left if possible */
5390 match = find_child_containing (menu_shell,
5391 l - 1, l, t, t + 1);
5395 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5398 || g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1)
5399 match = menu_shell->priv->active_menu_item;
5402 else if (direction == GTK_MENU_DIR_CHILD)
5404 /* we go one right if possible */
5405 if (r < gtk_menu_get_n_columns (menu))
5406 match = find_child_containing (menu_shell, r, r + 1, t, t + 1);
5410 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5412 if (! GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu &&
5414 g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1))
5415 match = menu_shell->priv->active_menu_item;
5421 gtk_menu_shell_select_item (menu_shell, match);
5426 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->move_current (menu_shell, direction);
5430 get_visible_size (GtkMenu *menu)
5432 GtkMenuPrivate *priv = menu->priv;
5433 GtkAllocation allocation;
5434 GtkWidget *widget = GTK_WIDGET (menu);
5435 GtkContainer *container = GTK_CONTAINER (menu);
5439 gtk_widget_get_allocation (widget, &allocation);
5440 get_menu_padding (widget, &padding);
5442 menu_height = (allocation.height -
5443 (2 * gtk_container_get_border_width (container)) -
5444 padding.top - padding.bottom);
5446 if (!priv->tearoff_active)
5448 GtkBorder arrow_border;
5450 get_arrows_border (menu, &arrow_border);
5451 menu_height -= arrow_border.top;
5452 menu_height -= arrow_border.bottom;
5458 /* Find the sensitive on-screen child containing @y, or if none,
5459 * the nearest selectable onscreen child. (%NULL if none)
5462 child_at (GtkMenu *menu,
5465 GtkMenuPrivate *priv = menu->priv;
5466 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5467 GtkWidget *child = NULL;
5468 gint child_offset = 0;
5471 gint lower, upper; /* Onscreen bounds */
5473 menu_height = get_visible_size (menu);
5474 lower = priv->scroll_offset;
5475 upper = priv->scroll_offset + menu_height;
5477 for (children = menu_shell->priv->children; children; children = children->next)
5479 if (gtk_widget_get_visible (children->data))
5481 GtkRequisition child_requisition;
5483 gtk_widget_get_preferred_size (children->data,
5484 &child_requisition, NULL);
5486 if (_gtk_menu_item_is_selectable (children->data) &&
5487 child_offset >= lower &&
5488 child_offset + child_requisition.height <= upper)
5490 child = children->data;
5492 if (child_offset + child_requisition.height > y &&
5493 !GTK_IS_TEAROFF_MENU_ITEM (child))
5497 child_offset += child_requisition.height;
5505 get_menu_height (GtkMenu *menu)
5507 GtkMenuPrivate *priv = menu->priv;
5508 GtkWidget *widget = GTK_WIDGET (menu);
5512 get_menu_padding (widget, &padding);
5514 height = priv->requested_height;
5515 height -= (gtk_container_get_border_width (GTK_CONTAINER (widget)) * 2) +
5516 padding.top + padding.bottom;
5518 if (!priv->tearoff_active)
5520 GtkBorder arrow_border;
5522 get_arrows_border (menu, &arrow_border);
5523 height -= arrow_border.top;
5524 height -= arrow_border.bottom;
5531 gtk_menu_real_move_scroll (GtkMenu *menu,
5534 GtkMenuPrivate *priv = menu->priv;
5535 gint page_size = get_visible_size (menu);
5536 gint end_position = get_menu_height (menu);
5537 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5541 case GTK_SCROLL_PAGE_UP:
5542 case GTK_SCROLL_PAGE_DOWN:
5546 gint child_offset = 0;
5547 gboolean old_upper_arrow_visible;
5550 if (type == GTK_SCROLL_PAGE_UP)
5555 if (menu_shell->priv->active_menu_item)
5559 compute_child_offset (menu, menu_shell->priv->active_menu_item,
5560 &child_offset, &child_height, NULL);
5561 child_offset += child_height / 2;
5564 menu_shell->priv->ignore_enter = TRUE;
5565 old_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5566 old_offset = priv->scroll_offset;
5568 new_offset = priv->scroll_offset + step;
5569 new_offset = CLAMP (new_offset, 0, end_position - page_size);
5571 gtk_menu_scroll_to (menu, new_offset);
5573 if (menu_shell->priv->active_menu_item)
5575 GtkWidget *new_child;
5576 gboolean new_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5577 GtkBorder arrow_border;
5579 get_arrows_border (menu, &arrow_border);
5581 if (priv->scroll_offset != old_offset)
5582 step = priv->scroll_offset - old_offset;
5584 step -= (new_upper_arrow_visible - old_upper_arrow_visible) * arrow_border.top;
5586 new_child = child_at (menu, child_offset + step);
5588 gtk_menu_shell_select_item (menu_shell, new_child);
5592 case GTK_SCROLL_START:
5593 /* Ignore the enter event we might get if the pointer is on the menu */
5594 menu_shell->priv->ignore_enter = TRUE;
5595 gtk_menu_shell_select_first (menu_shell, TRUE);
5597 case GTK_SCROLL_END:
5598 /* Ignore the enter event we might get if the pointer is on the menu */
5599 menu_shell->priv->ignore_enter = TRUE;
5600 _gtk_menu_shell_select_last (menu_shell, TRUE);
5608 * gtk_menu_set_monitor:
5610 * @monitor_num: the number of the monitor on which the menu should
5613 * Informs GTK+ on which monitor a menu should be popped up.
5614 * See gdk_screen_get_monitor_geometry().
5616 * This function should be called from a #GtkMenuPositionFunc
5617 * if the menu should not appear on the same monitor as the pointer.
5618 * This information can't be reliably inferred from the coordinates
5619 * returned by a #GtkMenuPositionFunc, since, for very long menus,
5620 * these coordinates may extend beyond the monitor boundaries or even
5621 * the screen boundaries.
5626 gtk_menu_set_monitor (GtkMenu *menu,
5629 GtkMenuPrivate *priv = menu->priv;
5631 g_return_if_fail (GTK_IS_MENU (menu));
5633 priv->monitor_num = monitor_num;
5637 * gtk_menu_get_monitor:
5640 * Retrieves the number of the monitor on which to show the menu.
5642 * Returns: the number of the monitor on which the menu should
5643 * be popped up or -1, if no monitor has been set
5648 gtk_menu_get_monitor (GtkMenu *menu)
5650 g_return_val_if_fail (GTK_IS_MENU (menu), -1);
5652 return menu->priv->monitor_num;
5656 * gtk_menu_get_for_attach_widget:
5657 * @widget: a #GtkWidget
5659 * Returns a list of the menus which are attached to this widget.
5660 * This list is owned by GTK+ and must not be modified.
5662 * Return value: (element-type GtkWidget) (transfer none): the list
5663 * of menus attached to his widget.
5668 gtk_menu_get_for_attach_widget (GtkWidget *widget)
5672 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5674 list = g_object_get_data (G_OBJECT (widget), ATTACHED_MENUS);
5680 gtk_menu_grab_notify (GtkWidget *widget,
5681 gboolean was_grabbed)
5684 GtkWidget *toplevel;
5685 GtkWindowGroup *group;
5689 menu = GTK_MENU (widget);
5690 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (widget));
5693 !gtk_widget_device_is_shadowed (widget, pointer))
5696 toplevel = gtk_widget_get_toplevel (widget);
5698 if (!GTK_IS_WINDOW (toplevel))
5701 group = gtk_window_get_group (GTK_WINDOW (toplevel));
5702 grab = gtk_window_group_get_current_device_grab (group, pointer);
5704 if (GTK_MENU_SHELL (widget)->priv->active && !GTK_IS_MENU_SHELL (grab))
5705 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
5707 menu->priv->drag_scroll_started = FALSE;
5711 * gtk_menu_set_reserve_toggle_size:
5713 * @reserve_toggle_size: whether to reserve size for toggles
5715 * Sets whether the menu should reserve space for drawing toggles
5716 * or icons, regardless of their actual presence.
5721 gtk_menu_set_reserve_toggle_size (GtkMenu *menu,
5722 gboolean reserve_toggle_size)
5724 GtkMenuPrivate *priv = menu->priv;
5725 gboolean no_toggle_size;
5727 g_return_if_fail (GTK_IS_MENU (menu));
5729 no_toggle_size = !reserve_toggle_size;
5731 if (priv->no_toggle_size != no_toggle_size)
5733 priv->no_toggle_size = no_toggle_size;
5735 g_object_notify (G_OBJECT (menu), "reserve-toggle-size");
5740 * gtk_menu_get_reserve_toggle_size:
5743 * Returns whether the menu reserves space for toggles and
5744 * icons, regardless of their actual presence.
5746 * Returns: Whether the menu reserves toggle space
5751 gtk_menu_get_reserve_toggle_size (GtkMenu *menu)
5753 g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
5755 return !menu->priv->no_toggle_size;
5759 * gtk_menu_new_from_model:
5760 * @model: a #GMenuModel
5762 * Creates a #GtkMenu and populates it with menu items and
5763 * submenus according to @model.
5765 * The created menu items are connected to actions found in the
5766 * #GtkApplicationWindow to which the menu belongs - typically
5767 * by means of being attached to a widget (see gtk_menu_attach_to_widget())
5768 * that is contained within the #GtkApplicationWindows widget hierarchy.
5770 * Returns: a new #GtkMenu
5775 gtk_menu_new_from_model (GMenuModel *model)
5779 g_return_val_if_fail (G_IS_MENU_MODEL (model), NULL);
5781 menu = gtk_menu_new ();
5782 gtk_menu_shell_bind_model (GTK_MENU_SHELL (menu), model, NULL, TRUE);