1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 * @Short_description: A menu widget
32 * A #GtkMenu is a #GtkMenuShell that implements a drop down menu
33 * consisting of a list of #GtkMenuItem objects which can be navigated
34 * and activated by the user to perform application functions.
36 * A #GtkMenu is most commonly dropped down by activating a
37 * #GtkMenuItem in a #GtkMenuBar or popped up by activating a
38 * #GtkMenuItem in another #GtkMenu.
40 * A #GtkMenu can also be popped up by activating a #GtkOptionMenu.
41 * Other composite widgets such as the #GtkNotebook can pop up a
44 * Applications can display a #GtkMenu as a popup menu by calling the
45 * gtk_menu_popup() function. The example below shows how an application
46 * can pop up a menu when the 3rd mouse button is pressed.
49 * <title>Connecting the popup signal handler.</title>
51 * /<!---->* connect our handler which will popup the menu *<!---->/
52 * g_signal_connect_swapped (window, "button_press_event",
53 * G_CALLBACK (my_popup_handler), menu);
58 * <title>Signal handler which displays a popup menu.</title>
61 * my_popup_handler (GtkWidget *widget, GdkEvent *event)
64 * GdkEventButton *event_button;
66 * g_return_val_if_fail (widget != NULL, FALSE);
67 * g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
68 * g_return_val_if_fail (event != NULL, FALSE);
70 * /<!---->* The "widget" is the menu that was supplied when
71 * * g_signal_connect_swapped() was called.
73 * menu = GTK_MENU (widget);
75 * if (event->type == GDK_BUTTON_PRESS)
77 * event_button = (GdkEventButton *) event;
78 * if (event_button->button == 3)
80 * gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
81 * event_button->button, event_button->time);
96 #include <gobject/gvaluecollector.h>
98 #include "gtkaccellabel.h"
99 #include "gtkaccelmap.h"
100 #include "gtkbindings.h"
101 #include "gtkcheckmenuitem.h"
103 #include "gtkmarshalers.h"
104 #include "gtkmenuprivate.h"
105 #include "gtkmenuitemprivate.h"
106 #include "gtkmenushellprivate.h"
107 #include "gtktearoffmenuitem.h"
108 #include "gtkwindow.h"
110 #include "gtkvscrollbar.h"
111 #include "gtksettings.h"
112 #include "gtkprivate.h"
114 #include "gtktypebuiltins.h"
116 #define NAVIGATION_REGION_OVERSHOOT 50 /* How much the navigation region
117 * extends below the submenu
120 #define MENU_SCROLL_STEP1 8
121 #define MENU_SCROLL_STEP2 15
122 #define MENU_SCROLL_FAST_ZONE 8
123 #define MENU_SCROLL_TIMEOUT1 50
124 #define MENU_SCROLL_TIMEOUT2 20
126 #define ATTACH_INFO_KEY "gtk-menu-child-attach-info-key"
127 #define ATTACHED_MENUS "gtk-attached-menus"
129 typedef struct _GtkMenuAttachData GtkMenuAttachData;
130 typedef struct _GtkMenuPopdownData GtkMenuPopdownData;
132 struct _GtkMenuAttachData
134 GtkWidget *attach_widget;
135 GtkMenuDetachFunc detacher;
138 struct _OldGtkMenuPrivate
142 gboolean initially_pushed_in;
144 GDestroyNotify position_func_data_destroy;
146 /* info used for the table */
149 gint requested_height;
153 /* Cached layout information */
162 GtkStateFlags lower_arrow_state;
163 GtkStateFlags upper_arrow_state;
165 /* navigation region */
168 int navigation_width;
169 int navigation_height;
171 guint have_layout : 1;
172 guint seen_item_enter : 1;
173 guint have_position : 1;
174 guint ignore_button_release : 1;
175 guint no_toggle_size : 1;
178 struct _GtkMenuPopdownData
190 gint effective_left_attach;
191 gint effective_right_attach;
192 gint effective_top_attach;
193 gint effective_bottom_attach;
210 PROP_RESERVE_TOGGLE_SIZE
215 CHILD_PROP_LEFT_ATTACH,
216 CHILD_PROP_RIGHT_ATTACH,
217 CHILD_PROP_TOP_ATTACH,
218 CHILD_PROP_BOTTOM_ATTACH
221 static void gtk_menu_set_property (GObject *object,
225 static void gtk_menu_get_property (GObject *object,
229 static void gtk_menu_set_child_property(GtkContainer *container,
234 static void gtk_menu_get_child_property(GtkContainer *container,
239 static void gtk_menu_destroy (GtkWidget *widget);
240 static void gtk_menu_realize (GtkWidget *widget);
241 static void gtk_menu_unrealize (GtkWidget *widget);
242 static void gtk_menu_size_allocate (GtkWidget *widget,
243 GtkAllocation *allocation);
244 static void gtk_menu_show (GtkWidget *widget);
245 static gboolean gtk_menu_draw (GtkWidget *widget,
247 static gboolean gtk_menu_key_press (GtkWidget *widget,
249 static gboolean gtk_menu_scroll (GtkWidget *widget,
250 GdkEventScroll *event);
251 static gboolean gtk_menu_button_press (GtkWidget *widget,
252 GdkEventButton *event);
253 static gboolean gtk_menu_button_release (GtkWidget *widget,
254 GdkEventButton *event);
255 static gboolean gtk_menu_motion_notify (GtkWidget *widget,
256 GdkEventMotion *event);
257 static gboolean gtk_menu_enter_notify (GtkWidget *widget,
258 GdkEventCrossing *event);
259 static gboolean gtk_menu_leave_notify (GtkWidget *widget,
260 GdkEventCrossing *event);
261 static void gtk_menu_scroll_to (GtkMenu *menu,
263 static void gtk_menu_grab_notify (GtkWidget *widget,
264 gboolean was_grabbed);
266 static void gtk_menu_stop_scrolling (GtkMenu *menu);
267 static void gtk_menu_remove_scroll_timeout (GtkMenu *menu);
268 static gboolean gtk_menu_scroll_timeout (gpointer data);
269 static gboolean gtk_menu_scroll_timeout_initial (gpointer data);
270 static void gtk_menu_start_scrolling (GtkMenu *menu);
272 static void gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
273 GtkWidget *menu_item);
274 static void gtk_menu_select_item (GtkMenuShell *menu_shell,
275 GtkWidget *menu_item);
276 static void gtk_menu_real_insert (GtkMenuShell *menu_shell,
279 static void gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
281 static void gtk_menu_handle_scrolling (GtkMenu *menu,
286 static void gtk_menu_set_tearoff_hints (GtkMenu *menu,
288 static void gtk_menu_style_updated (GtkWidget *widget);
289 static gboolean gtk_menu_focus (GtkWidget *widget,
290 GtkDirectionType direction);
291 static gint gtk_menu_get_popup_delay (GtkMenuShell *menu_shell);
292 static void gtk_menu_move_current (GtkMenuShell *menu_shell,
293 GtkMenuDirectionType direction);
294 static void gtk_menu_real_move_scroll (GtkMenu *menu,
297 static void gtk_menu_stop_navigating_submenu (GtkMenu *menu);
298 static gboolean gtk_menu_stop_navigating_submenu_cb (gpointer user_data);
299 static gboolean gtk_menu_navigating_submenu (GtkMenu *menu,
302 static void gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
303 GtkMenuItem *menu_item,
304 GdkEventCrossing *event);
306 static void gtk_menu_deactivate (GtkMenuShell *menu_shell);
307 static void gtk_menu_show_all (GtkWidget *widget);
308 static void gtk_menu_position (GtkMenu *menu,
309 gboolean set_scroll_offset);
310 static void gtk_menu_reparent (GtkMenu *menu,
311 GtkWidget *new_parent,
313 static void gtk_menu_remove (GtkContainer *menu,
316 static void gtk_menu_update_title (GtkMenu *menu);
318 static void menu_grab_transfer_window_destroy (GtkMenu *menu);
319 static GdkWindow *menu_grab_transfer_window_get (GtkMenu *menu);
321 static gboolean gtk_menu_real_can_activate_accel (GtkWidget *widget,
323 static void _gtk_menu_refresh_accel_paths (GtkMenu *menu,
324 gboolean group_changed);
326 static void gtk_menu_get_preferred_width (GtkWidget *widget,
329 static void gtk_menu_get_preferred_height (GtkWidget *widget,
332 static void gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
338 static const gchar attach_data_key[] = "gtk-menu-attach-data";
340 static guint menu_signals[LAST_SIGNAL] = { 0 };
342 G_DEFINE_TYPE (GtkMenu, gtk_menu, GTK_TYPE_MENU_SHELL)
345 menu_queue_resize (GtkMenu *menu)
347 GtkMenuPrivate *priv = menu->priv;
349 priv->have_layout = FALSE;
350 gtk_widget_queue_resize (GTK_WIDGET (menu));
354 attach_info_free (AttachInfo *info)
356 g_slice_free (AttachInfo, info);
360 get_attach_info (GtkWidget *child)
362 GObject *object = G_OBJECT (child);
363 AttachInfo *ai = g_object_get_data (object, ATTACH_INFO_KEY);
367 ai = g_slice_new0 (AttachInfo);
368 g_object_set_data_full (object, I_(ATTACH_INFO_KEY), ai,
369 (GDestroyNotify) attach_info_free);
376 is_grid_attached (AttachInfo *ai)
378 return (ai->left_attach >= 0 &&
379 ai->right_attach >= 0 &&
380 ai->top_attach >= 0 &&
381 ai->bottom_attach >= 0);
385 menu_ensure_layout (GtkMenu *menu)
387 GtkMenuPrivate *priv = menu->priv;
389 if (!priv->have_layout)
391 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
395 gint max_right_attach;
396 gint max_bottom_attach;
398 /* Find extents of gridded portion
400 max_right_attach = 1;
401 max_bottom_attach = 0;
403 for (l = menu_shell->priv->children; l; l = l->next)
405 GtkWidget *child = l->data;
406 AttachInfo *ai = get_attach_info (child);
408 if (is_grid_attached (ai))
410 max_bottom_attach = MAX (max_bottom_attach, ai->bottom_attach);
411 max_right_attach = MAX (max_right_attach, ai->right_attach);
415 /* Find empty rows */
416 row_occupied = g_malloc0 (max_bottom_attach);
418 for (l = menu_shell->priv->children; l; l = l->next)
420 GtkWidget *child = l->data;
421 AttachInfo *ai = get_attach_info (child);
423 if (is_grid_attached (ai))
427 for (i = ai->top_attach; i < ai->bottom_attach; i++)
428 row_occupied[i] = TRUE;
432 /* Lay non-grid-items out in those rows
435 for (l = menu_shell->priv->children; l; l = l->next)
437 GtkWidget *child = l->data;
438 AttachInfo *ai = get_attach_info (child);
440 if (!is_grid_attached (ai))
442 while (current_row < max_bottom_attach && row_occupied[current_row])
445 ai->effective_left_attach = 0;
446 ai->effective_right_attach = max_right_attach;
447 ai->effective_top_attach = current_row;
448 ai->effective_bottom_attach = current_row + 1;
454 ai->effective_left_attach = ai->left_attach;
455 ai->effective_right_attach = ai->right_attach;
456 ai->effective_top_attach = ai->top_attach;
457 ai->effective_bottom_attach = ai->bottom_attach;
461 g_free (row_occupied);
463 priv->n_rows = MAX (current_row, max_bottom_attach);
464 priv->n_columns = max_right_attach;
465 priv->have_layout = TRUE;
471 gtk_menu_get_n_columns (GtkMenu *menu)
473 GtkMenuPrivate *priv = menu->priv;
475 menu_ensure_layout (menu);
477 return priv->n_columns;
481 gtk_menu_get_n_rows (GtkMenu *menu)
483 GtkMenuPrivate *priv = menu->priv;
485 menu_ensure_layout (menu);
491 get_effective_child_attach (GtkWidget *child,
497 GtkMenu *menu = GTK_MENU (gtk_widget_get_parent (child));
500 menu_ensure_layout (menu);
502 ai = get_attach_info (child);
505 *l = ai->effective_left_attach;
507 *r = ai->effective_right_attach;
509 *t = ai->effective_top_attach;
511 *b = ai->effective_bottom_attach;
516 gtk_menu_class_init (GtkMenuClass *class)
518 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
519 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
520 GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
521 GtkMenuShellClass *menu_shell_class = GTK_MENU_SHELL_CLASS (class);
522 GtkBindingSet *binding_set;
524 gobject_class->set_property = gtk_menu_set_property;
525 gobject_class->get_property = gtk_menu_get_property;
527 widget_class->destroy = gtk_menu_destroy;
528 widget_class->realize = gtk_menu_realize;
529 widget_class->unrealize = gtk_menu_unrealize;
530 widget_class->size_allocate = gtk_menu_size_allocate;
531 widget_class->show = gtk_menu_show;
532 widget_class->draw = gtk_menu_draw;
533 widget_class->scroll_event = gtk_menu_scroll;
534 widget_class->key_press_event = gtk_menu_key_press;
535 widget_class->button_press_event = gtk_menu_button_press;
536 widget_class->button_release_event = gtk_menu_button_release;
537 widget_class->motion_notify_event = gtk_menu_motion_notify;
538 widget_class->show_all = gtk_menu_show_all;
539 widget_class->enter_notify_event = gtk_menu_enter_notify;
540 widget_class->leave_notify_event = gtk_menu_leave_notify;
541 widget_class->style_updated = gtk_menu_style_updated;
542 widget_class->focus = gtk_menu_focus;
543 widget_class->can_activate_accel = gtk_menu_real_can_activate_accel;
544 widget_class->grab_notify = gtk_menu_grab_notify;
545 widget_class->get_preferred_width = gtk_menu_get_preferred_width;
546 widget_class->get_preferred_height = gtk_menu_get_preferred_height;
547 widget_class->get_preferred_height_for_width = gtk_menu_get_preferred_height_for_width;
549 container_class->remove = gtk_menu_remove;
550 container_class->get_child_property = gtk_menu_get_child_property;
551 container_class->set_child_property = gtk_menu_set_child_property;
553 menu_shell_class->submenu_placement = GTK_LEFT_RIGHT;
554 menu_shell_class->deactivate = gtk_menu_deactivate;
555 menu_shell_class->select_item = gtk_menu_select_item;
556 menu_shell_class->insert = gtk_menu_real_insert;
557 menu_shell_class->get_popup_delay = gtk_menu_get_popup_delay;
558 menu_shell_class->move_current = gtk_menu_move_current;
561 * GtkMenu::move-scroll:
563 * @scroll_type: a #GtkScrollType
565 menu_signals[MOVE_SCROLL] =
566 g_signal_new_class_handler (I_("move-scroll"),
567 G_OBJECT_CLASS_TYPE (gobject_class),
568 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
569 G_CALLBACK (gtk_menu_real_move_scroll),
571 _gtk_marshal_VOID__ENUM,
573 GTK_TYPE_SCROLL_TYPE);
578 * The index of the currently selected menu item, or -1 if no
579 * menu item is selected.
583 g_object_class_install_property (gobject_class,
585 g_param_spec_int ("active",
587 P_("The currently selected menu item"),
589 GTK_PARAM_READWRITE));
592 * GtkMenu:accel-group:
594 * The accel group holding accelerators for the menu.
598 g_object_class_install_property (gobject_class,
600 g_param_spec_object ("accel-group",
602 P_("The accel group holding accelerators for the menu"),
603 GTK_TYPE_ACCEL_GROUP,
604 GTK_PARAM_READWRITE));
607 * GtkMenu:accel-path:
609 * An accel path used to conveniently construct accel paths of child items.
613 g_object_class_install_property (gobject_class,
615 g_param_spec_string ("accel-path",
617 P_("An accel path used to conveniently construct accel paths of child items"),
619 GTK_PARAM_READWRITE));
622 * GtkMenu:attach-widget:
624 * The widget the menu is attached to. Setting this property attaches
625 * the menu without a #GtkMenuDetachFunc. If you need to use a detacher,
626 * use gtk_menu_attach_to_widget() directly.
630 g_object_class_install_property (gobject_class,
632 g_param_spec_object ("attach-widget",
634 P_("The widget the menu is attached to"),
636 GTK_PARAM_READWRITE));
638 g_object_class_install_property (gobject_class,
640 g_param_spec_string ("tearoff-title",
642 P_("A title that may be displayed by the window manager when this menu is torn-off"),
644 GTK_PARAM_READWRITE));
647 * GtkMenu:tearoff-state:
649 * A boolean that indicates whether the menu is torn-off.
653 g_object_class_install_property (gobject_class,
655 g_param_spec_boolean ("tearoff-state",
657 P_("A boolean that indicates whether the menu is torn-off"),
659 GTK_PARAM_READWRITE));
664 * The monitor the menu will be popped up on.
668 g_object_class_install_property (gobject_class,
670 g_param_spec_int ("monitor",
672 P_("The monitor the menu will be popped up on"),
674 GTK_PARAM_READWRITE));
676 gtk_widget_class_install_style_property (widget_class,
677 g_param_spec_int ("vertical-padding",
678 P_("Vertical Padding"),
679 P_("Extra space at the top and bottom of the menu"),
683 GTK_PARAM_READABLE));
686 * GtkMenu:reserve-toggle-size:
688 * A boolean that indicates whether the menu reserves space for
689 * toggles and icons, regardless of their actual presence.
691 * This property should only be changed from its default value
692 * for special-purposes such as tabular menus. Regular menus that
693 * are connected to a menu bar or context menus should reserve
694 * toggle space for consistency.
698 g_object_class_install_property (gobject_class,
699 PROP_RESERVE_TOGGLE_SIZE,
700 g_param_spec_boolean ("reserve-toggle-size",
701 P_("Reserve Toggle Size"),
702 P_("A boolean that indicates whether the menu reserves space for toggles and icons"),
704 GTK_PARAM_READWRITE));
706 gtk_widget_class_install_style_property (widget_class,
707 g_param_spec_int ("horizontal-padding",
708 P_("Horizontal Padding"),
709 P_("Extra space at the left and right edges of the menu"),
713 GTK_PARAM_READABLE));
715 gtk_widget_class_install_style_property (widget_class,
716 g_param_spec_int ("vertical-offset",
717 P_("Vertical Offset"),
718 P_("When the menu is a submenu, position it this number of pixels offset vertically"),
722 GTK_PARAM_READABLE));
724 gtk_widget_class_install_style_property (widget_class,
725 g_param_spec_int ("horizontal-offset",
726 P_("Horizontal Offset"),
727 P_("When the menu is a submenu, position it this number of pixels offset horizontally"),
731 GTK_PARAM_READABLE));
733 gtk_widget_class_install_style_property (widget_class,
734 g_param_spec_boolean ("double-arrows",
736 P_("When scrolling, always show both arrows."),
738 GTK_PARAM_READABLE));
741 * GtkMenu:arrow-placement:
743 * Indicates where scroll arrows should be placed.
747 gtk_widget_class_install_style_property (widget_class,
748 g_param_spec_enum ("arrow-placement",
749 P_("Arrow Placement"),
750 P_("Indicates where scroll arrows should be placed"),
751 GTK_TYPE_ARROW_PLACEMENT,
753 GTK_PARAM_READABLE));
755 gtk_container_class_install_child_property (container_class,
756 CHILD_PROP_LEFT_ATTACH,
757 g_param_spec_int ("left-attach",
759 P_("The column number to attach the left side of the child to"),
761 GTK_PARAM_READWRITE));
763 gtk_container_class_install_child_property (container_class,
764 CHILD_PROP_RIGHT_ATTACH,
765 g_param_spec_int ("right-attach",
767 P_("The column number to attach the right side of the child to"),
769 GTK_PARAM_READWRITE));
771 gtk_container_class_install_child_property (container_class,
772 CHILD_PROP_TOP_ATTACH,
773 g_param_spec_int ("top-attach",
775 P_("The row number to attach the top of the child to"),
777 GTK_PARAM_READWRITE));
779 gtk_container_class_install_child_property (container_class,
780 CHILD_PROP_BOTTOM_ATTACH,
781 g_param_spec_int ("bottom-attach",
783 P_("The row number to attach the bottom of the child to"),
785 GTK_PARAM_READWRITE));
788 * GtkMenu:arrow-scaling
790 * Arbitrary constant to scale down the size of the scroll arrow.
794 gtk_widget_class_install_style_property (widget_class,
795 g_param_spec_float ("arrow-scaling",
797 P_("Arbitrary constant to scale down the size of the scroll arrow"),
799 GTK_PARAM_READABLE));
801 binding_set = gtk_binding_set_by_class (class);
802 gtk_binding_entry_add_signal (binding_set,
804 I_("move-current"), 1,
805 GTK_TYPE_MENU_DIRECTION_TYPE,
807 gtk_binding_entry_add_signal (binding_set,
810 GTK_TYPE_MENU_DIRECTION_TYPE,
812 gtk_binding_entry_add_signal (binding_set,
815 GTK_TYPE_MENU_DIRECTION_TYPE,
817 gtk_binding_entry_add_signal (binding_set,
820 GTK_TYPE_MENU_DIRECTION_TYPE,
822 gtk_binding_entry_add_signal (binding_set,
825 GTK_TYPE_MENU_DIRECTION_TYPE,
826 GTK_MENU_DIR_PARENT);
827 gtk_binding_entry_add_signal (binding_set,
830 GTK_TYPE_MENU_DIRECTION_TYPE,
831 GTK_MENU_DIR_PARENT);
832 gtk_binding_entry_add_signal (binding_set,
835 GTK_TYPE_MENU_DIRECTION_TYPE,
837 gtk_binding_entry_add_signal (binding_set,
840 GTK_TYPE_MENU_DIRECTION_TYPE,
842 gtk_binding_entry_add_signal (binding_set,
845 GTK_TYPE_SCROLL_TYPE,
847 gtk_binding_entry_add_signal (binding_set,
850 GTK_TYPE_SCROLL_TYPE,
852 gtk_binding_entry_add_signal (binding_set,
855 GTK_TYPE_SCROLL_TYPE,
857 gtk_binding_entry_add_signal (binding_set,
860 GTK_TYPE_SCROLL_TYPE,
862 gtk_binding_entry_add_signal (binding_set,
865 GTK_TYPE_SCROLL_TYPE,
867 gtk_binding_entry_add_signal (binding_set,
868 GDK_KEY_KP_Page_Up, 0,
870 GTK_TYPE_SCROLL_TYPE,
872 gtk_binding_entry_add_signal (binding_set,
873 GDK_KEY_Page_Down, 0,
875 GTK_TYPE_SCROLL_TYPE,
876 GTK_SCROLL_PAGE_DOWN);
877 gtk_binding_entry_add_signal (binding_set,
878 GDK_KEY_KP_Page_Down, 0,
880 GTK_TYPE_SCROLL_TYPE,
881 GTK_SCROLL_PAGE_DOWN);
883 g_type_class_add_private (gobject_class, sizeof (GtkMenuPrivate));
888 gtk_menu_set_property (GObject *object,
893 GtkMenu *menu = GTK_MENU (object);
898 gtk_menu_set_active (menu, g_value_get_int (value));
900 case PROP_ACCEL_GROUP:
901 gtk_menu_set_accel_group (menu, g_value_get_object (value));
903 case PROP_ACCEL_PATH:
904 gtk_menu_set_accel_path (menu, g_value_get_string (value));
906 case PROP_ATTACH_WIDGET:
910 widget = gtk_menu_get_attach_widget (menu);
912 gtk_menu_detach (menu);
914 widget = (GtkWidget*) g_value_get_object (value);
916 gtk_menu_attach_to_widget (menu, widget, NULL);
919 case PROP_TEAROFF_STATE:
920 gtk_menu_set_tearoff_state (menu, g_value_get_boolean (value));
922 case PROP_TEAROFF_TITLE:
923 gtk_menu_set_title (menu, g_value_get_string (value));
926 gtk_menu_set_monitor (menu, g_value_get_int (value));
928 case PROP_RESERVE_TOGGLE_SIZE:
929 gtk_menu_set_reserve_toggle_size (menu, g_value_get_boolean (value));
932 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
938 gtk_menu_get_property (GObject *object,
943 GtkMenu *menu = GTK_MENU (object);
948 g_value_set_int (value, g_list_index (GTK_MENU_SHELL (menu)->priv->children, gtk_menu_get_active (menu)));
950 case PROP_ACCEL_GROUP:
951 g_value_set_object (value, gtk_menu_get_accel_group (menu));
953 case PROP_ACCEL_PATH:
954 g_value_set_string (value, gtk_menu_get_accel_path (menu));
956 case PROP_ATTACH_WIDGET:
957 g_value_set_object (value, gtk_menu_get_attach_widget (menu));
959 case PROP_TEAROFF_STATE:
960 g_value_set_boolean (value, gtk_menu_get_tearoff_state (menu));
962 case PROP_TEAROFF_TITLE:
963 g_value_set_string (value, gtk_menu_get_title (menu));
966 g_value_set_int (value, gtk_menu_get_monitor (menu));
968 case PROP_RESERVE_TOGGLE_SIZE:
969 g_value_set_boolean (value, gtk_menu_get_reserve_toggle_size (menu));
972 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
978 gtk_menu_set_child_property (GtkContainer *container,
984 GtkMenu *menu = GTK_MENU (container);
985 AttachInfo *ai = get_attach_info (child);
989 case CHILD_PROP_LEFT_ATTACH:
990 ai->left_attach = g_value_get_int (value);
992 case CHILD_PROP_RIGHT_ATTACH:
993 ai->right_attach = g_value_get_int (value);
995 case CHILD_PROP_TOP_ATTACH:
996 ai->top_attach = g_value_get_int (value);
998 case CHILD_PROP_BOTTOM_ATTACH:
999 ai->bottom_attach = g_value_get_int (value);
1003 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1007 menu_queue_resize (menu);
1011 gtk_menu_get_child_property (GtkContainer *container,
1017 AttachInfo *ai = get_attach_info (child);
1019 switch (property_id)
1021 case CHILD_PROP_LEFT_ATTACH:
1022 g_value_set_int (value, ai->left_attach);
1024 case CHILD_PROP_RIGHT_ATTACH:
1025 g_value_set_int (value, ai->right_attach);
1027 case CHILD_PROP_TOP_ATTACH:
1028 g_value_set_int (value, ai->top_attach);
1030 case CHILD_PROP_BOTTOM_ATTACH:
1031 g_value_set_int (value, ai->bottom_attach);
1035 GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1041 gtk_menu_window_event (GtkWidget *window,
1045 gboolean handled = FALSE;
1047 g_object_ref (window);
1048 g_object_ref (menu);
1050 switch (event->type)
1053 case GDK_KEY_RELEASE:
1054 handled = gtk_widget_event (menu, event);
1060 g_object_unref (window);
1061 g_object_unref (menu);
1067 gtk_menu_init (GtkMenu *menu)
1069 GtkMenuPrivate *priv;
1070 GtkStyleContext *context;
1072 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu, GTK_TYPE_MENU, GtkMenuPrivate);
1076 priv->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
1077 "type", GTK_WINDOW_POPUP,
1080 "signal::event", gtk_menu_window_event, menu,
1081 "signal::destroy", gtk_widget_destroyed, &priv->toplevel,
1083 gtk_window_set_resizable (GTK_WINDOW (priv->toplevel), FALSE);
1084 gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->toplevel), 0);
1086 /* Refloat the menu, so that reference counting for the menu isn't
1087 * affected by it being a child of the toplevel
1089 g_object_force_floating (G_OBJECT (menu));
1090 priv->needs_destruction_ref = TRUE;
1092 priv->monitor_num = -1;
1094 context = gtk_widget_get_style_context (GTK_WIDGET (menu));
1095 gtk_style_context_add_class (context, GTK_STYLE_CLASS_MENU);
1099 gtk_menu_destroy (GtkWidget *widget)
1101 GtkMenu *menu = GTK_MENU (widget);
1102 GtkMenuPrivate *priv = menu->priv;
1103 GtkMenuAttachData *data;
1105 gtk_menu_remove_scroll_timeout (menu);
1107 data = g_object_get_data (G_OBJECT (widget), attach_data_key);
1109 gtk_menu_detach (menu);
1111 gtk_menu_stop_navigating_submenu (menu);
1113 if (priv->old_active_menu_item)
1114 g_clear_object (&priv->old_active_menu_item);
1116 /* Add back the reference count for being a child */
1117 if (priv->needs_destruction_ref)
1119 priv->needs_destruction_ref = FALSE;
1120 g_object_ref (widget);
1123 if (priv->accel_group)
1124 g_clear_object (&priv->accel_group);
1127 gtk_widget_destroy (priv->toplevel);
1129 if (priv->tearoff_window)
1130 gtk_widget_destroy (priv->tearoff_window);
1134 g_free (priv->heights);
1135 priv->heights = NULL;
1140 g_free (priv->title);
1144 if (priv->position_func_data_destroy)
1146 priv->position_func_data_destroy (priv->position_func_data);
1147 priv->position_func_data = NULL;
1148 priv->position_func_data_destroy = NULL;
1151 GTK_WIDGET_CLASS (gtk_menu_parent_class)->destroy (widget);
1155 menu_change_screen (GtkMenu *menu,
1156 GdkScreen *new_screen)
1158 GtkMenuPrivate *priv = menu->priv;
1160 if (gtk_widget_has_screen (GTK_WIDGET (menu)))
1162 if (new_screen == gtk_widget_get_screen (GTK_WIDGET (menu)))
1168 gtk_window_set_screen (GTK_WINDOW (priv->tearoff_window), new_screen);
1169 gtk_menu_position (menu, TRUE);
1172 gtk_window_set_screen (GTK_WINDOW (priv->toplevel), new_screen);
1173 priv->monitor_num = -1;
1177 attach_widget_screen_changed (GtkWidget *attach_widget,
1178 GdkScreen *previous_screen,
1181 if (gtk_widget_has_screen (attach_widget) &&
1182 !g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1183 menu_change_screen (menu, gtk_widget_get_screen (attach_widget));
1187 * gtk_menu_attach_to_widget: (skip)
1189 * @attach_widget: the #GtkWidget that the menu will be attached to
1190 * @detacher: the user supplied callback function that will be called
1191 * when the menu calls gtk_menu_detach()
1193 * Attaches the menu to the widget and provides a callback function
1194 * that will be invoked when the menu calls gtk_menu_detach() during
1198 gtk_menu_attach_to_widget (GtkMenu *menu,
1199 GtkWidget *attach_widget,
1200 GtkMenuDetachFunc detacher)
1202 GtkMenuAttachData *data;
1205 g_return_if_fail (GTK_IS_MENU (menu));
1206 g_return_if_fail (GTK_IS_WIDGET (attach_widget));
1208 /* keep this function in sync with gtk_widget_set_parent() */
1209 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1212 g_warning ("gtk_menu_attach_to_widget(): menu already attached to %s",
1213 g_type_name (G_TYPE_FROM_INSTANCE (data->attach_widget)));
1217 g_object_ref_sink (menu);
1219 data = g_slice_new (GtkMenuAttachData);
1220 data->attach_widget = attach_widget;
1222 g_signal_connect (attach_widget, "screen-changed",
1223 G_CALLBACK (attach_widget_screen_changed), menu);
1224 attach_widget_screen_changed (attach_widget, NULL, menu);
1226 data->detacher = detacher;
1227 g_object_set_data (G_OBJECT (menu), I_(attach_data_key), data);
1228 list = g_object_steal_data (G_OBJECT (attach_widget), ATTACHED_MENUS);
1229 if (!g_list_find (list, menu))
1230 list = g_list_prepend (list, menu);
1232 g_object_set_data_full (G_OBJECT (attach_widget), I_(ATTACHED_MENUS), list,
1233 (GDestroyNotify) g_list_free);
1235 if (gtk_widget_get_state_flags (GTK_WIDGET (menu)) != 0)
1236 gtk_widget_set_state_flags (GTK_WIDGET (menu), 0, TRUE);
1238 /* we don't need to set the style here, since
1239 * we are a toplevel widget.
1242 /* Fallback title for menu comes from attach widget */
1243 gtk_menu_update_title (menu);
1245 g_object_notify (G_OBJECT (menu), "attach-widget");
1249 * gtk_menu_get_attach_widget:
1252 * Returns the #GtkWidget that the menu is attached to.
1254 * Returns: (transfer none): the #GtkWidget that the menu is attached to
1257 gtk_menu_get_attach_widget (GtkMenu *menu)
1259 GtkMenuAttachData *data;
1261 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1263 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1265 return data->attach_widget;
1273 * Detaches the menu from the widget to which it had been attached.
1274 * This function will call the callback function, @detacher, provided
1275 * when the gtk_menu_attach_to_widget() function was called.
1278 gtk_menu_detach (GtkMenu *menu)
1280 GtkMenuAttachData *data;
1283 g_return_if_fail (GTK_IS_MENU (menu));
1285 /* keep this function in sync with gtk_widget_unparent() */
1286 data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1289 g_warning ("gtk_menu_detach(): menu is not attached");
1292 g_object_set_data (G_OBJECT (menu), I_(attach_data_key), NULL);
1294 g_signal_handlers_disconnect_by_func (data->attach_widget,
1295 (gpointer) attach_widget_screen_changed,
1299 data->detacher (data->attach_widget, menu);
1300 list = g_object_steal_data (G_OBJECT (data->attach_widget), ATTACHED_MENUS);
1301 list = g_list_remove (list, menu);
1303 g_object_set_data_full (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), list,
1304 (GDestroyNotify) g_list_free);
1306 g_object_set_data (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), NULL);
1308 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
1309 gtk_widget_unrealize (GTK_WIDGET (menu));
1311 g_slice_free (GtkMenuAttachData, data);
1313 /* Fallback title for menu comes from attach widget */
1314 gtk_menu_update_title (menu);
1316 g_object_unref (menu);
1320 gtk_menu_remove (GtkContainer *container,
1323 GtkMenu *menu = GTK_MENU (container);
1324 GtkMenuPrivate *priv = menu->priv;
1326 /* Clear out old_active_menu_item if it matches the item we are removing */
1327 if (priv->old_active_menu_item == widget)
1328 g_clear_object (&priv->old_active_menu_item);
1330 GTK_CONTAINER_CLASS (gtk_menu_parent_class)->remove (container, widget);
1332 g_object_set_data (G_OBJECT (widget), I_(ATTACH_INFO_KEY), NULL);
1334 menu_queue_resize (menu);
1340 * Creates a new #GtkMenu
1342 * Returns: a new #GtkMenu
1347 return g_object_new (GTK_TYPE_MENU, NULL);
1351 gtk_menu_real_insert (GtkMenuShell *menu_shell,
1355 GtkMenu *menu = GTK_MENU (menu_shell);
1356 GtkMenuPrivate *priv = menu->priv;
1357 AttachInfo *ai = get_attach_info (child);
1359 ai->left_attach = -1;
1360 ai->right_attach = -1;
1361 ai->top_attach = -1;
1362 ai->bottom_attach = -1;
1364 if (gtk_widget_get_realized (GTK_WIDGET (menu_shell)))
1365 gtk_widget_set_parent_window (child, priv->bin_window);
1367 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->insert (menu_shell, child, position);
1369 menu_queue_resize (menu);
1373 gtk_menu_tearoff_bg_copy (GtkMenu *menu)
1375 GtkMenuPrivate *priv = menu->priv;
1381 cairo_surface_t *surface;
1382 cairo_pattern_t *pattern;
1385 priv->tearoff_active = FALSE;
1386 priv->saved_scroll_offset = priv->scroll_offset;
1388 window = gtk_widget_get_window (priv->tearoff_window);
1389 width = gdk_window_get_width (window);
1390 height = gdk_window_get_height (window);
1392 surface = gdk_window_create_similar_surface (window,
1393 CAIRO_CONTENT_COLOR,
1397 cr = cairo_create (surface);
1398 gdk_cairo_set_source_window (cr, window, 0, 0);
1402 gtk_widget_set_size_request (priv->tearoff_window, width, height);
1404 pattern = cairo_pattern_create_for_surface (surface);
1405 gdk_window_set_background_pattern (window, pattern);
1407 cairo_pattern_destroy (pattern);
1408 cairo_surface_destroy (surface);
1413 popup_grab_on_window (GdkWindow *window,
1414 GdkDevice *keyboard,
1416 guint32 activate_time)
1419 gdk_device_grab (keyboard, window,
1420 GDK_OWNERSHIP_WINDOW, TRUE,
1421 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
1422 NULL, activate_time) != GDK_GRAB_SUCCESS)
1426 gdk_device_grab (pointer, window,
1427 GDK_OWNERSHIP_WINDOW, TRUE,
1428 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1429 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1430 GDK_POINTER_MOTION_MASK,
1431 NULL, activate_time) != GDK_GRAB_SUCCESS)
1434 gdk_device_ungrab (keyboard, activate_time);
1443 * gtk_menu_popup_for_device:
1445 * @device: (allow-none): a #GdkDevice
1446 * @parent_menu_shell: (allow-none): the menu shell containing the triggering
1447 * menu item, or %NULL
1448 * @parent_menu_item: (allow-none): the menu item whose activation triggered
1449 * the popup, or %NULL
1450 * @func: (allow-none): a user supplied function used to position the menu,
1452 * @data: (allow-none): user supplied data to be passed to @func
1453 * @destroy: (allow-none): destroy notify for @data
1454 * @button: the mouse button which was pressed to initiate the event
1455 * @activate_time: the time at which the activation event occurred
1457 * Displays a menu and makes it available for selection.
1459 * Applications can use this function to display context-sensitive menus,
1460 * and will typically supply %NULL for the @parent_menu_shell,
1461 * @parent_menu_item, @func, @data and @destroy parameters. The default
1462 * menu positioning function will position the menu at the current position
1463 * of @device (or its corresponding pointer).
1465 * The @button parameter should be the mouse button pressed to initiate
1466 * the menu popup. If the menu popup was initiated by something other than
1467 * a mouse button press, such as a mouse button release or a keypress,
1468 * @button should be 0.
1470 * The @activate_time parameter is used to conflict-resolve initiation of
1471 * concurrent requests for mouse/keyboard grab requests. To function
1472 * properly, this needs to be the time stamp of the user event (such as
1473 * a mouse click or key press) that caused the initiation of the popup.
1474 * Only if no such event is available, gtk_get_current_event_time() can
1480 gtk_menu_popup_for_device (GtkMenu *menu,
1482 GtkWidget *parent_menu_shell,
1483 GtkWidget *parent_menu_item,
1484 GtkMenuPositionFunc func,
1486 GDestroyNotify destroy,
1488 guint32 activate_time)
1490 GtkMenuPrivate *priv = menu->priv;
1492 GtkWidget *xgrab_shell;
1494 GdkEvent *current_event;
1495 GtkMenuShell *menu_shell;
1496 gboolean grab_keyboard;
1497 GtkWidget *parent_toplevel;
1498 GdkDevice *keyboard, *pointer;
1500 g_return_if_fail (GTK_IS_MENU (menu));
1501 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1504 device = gtk_get_current_event_device ();
1508 GdkDisplay *display;
1509 GdkDeviceManager *device_manager;
1512 display = gtk_widget_get_display (GTK_WIDGET (menu));
1513 device_manager = gdk_display_get_device_manager (display);
1514 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1516 device = devices->data;
1518 g_list_free (devices);
1521 widget = GTK_WIDGET (menu);
1522 menu_shell = GTK_MENU_SHELL (menu);
1524 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1527 pointer = gdk_device_get_associated_device (device);
1532 keyboard = gdk_device_get_associated_device (device);
1535 menu_shell->priv->parent_menu_shell = parent_menu_shell;
1537 priv->seen_item_enter = FALSE;
1539 /* Find the last viewable ancestor, and make an X grab on it
1541 parent = GTK_WIDGET (menu);
1545 gboolean viewable = TRUE;
1546 GtkWidget *tmp = parent;
1550 if (!gtk_widget_get_mapped (tmp))
1555 tmp = gtk_widget_get_parent (tmp);
1559 xgrab_shell = parent;
1561 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1564 /* We want to receive events generated when we map the menu;
1565 * unfortunately, since there is probably already an implicit
1566 * grab in place from the button that the user used to pop up
1567 * the menu, we won't receive then -- in particular, the EnterNotify
1568 * when the menu pops up under the pointer.
1570 * If we are grabbing on a parent menu shell, no problem; just grab
1571 * on that menu shell first before popping up the window with
1572 * owner_events = TRUE.
1574 * When grabbing on the menu itself, things get more convoluted --
1575 * we do an explicit grab on a specially created window with
1576 * owner_events = TRUE, which we override further down with a
1577 * grab on the menu. (We can't grab on the menu until it is mapped;
1578 * we probably could just leave the grab on the other window,
1579 * with a little reorganization of the code in gtkmenu*).
1581 grab_keyboard = gtk_menu_shell_get_take_focus (menu_shell);
1582 gtk_window_set_accept_focus (GTK_WINDOW (priv->toplevel), grab_keyboard);
1587 if (xgrab_shell && xgrab_shell != widget)
1589 if (popup_grab_on_window (gtk_widget_get_window (xgrab_shell), keyboard, pointer, activate_time))
1591 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1592 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1597 GdkWindow *transfer_window;
1599 xgrab_shell = widget;
1600 transfer_window = menu_grab_transfer_window_get (menu);
1601 if (popup_grab_on_window (transfer_window, keyboard, pointer, activate_time))
1603 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1604 GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1608 if (!GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab)
1610 /* We failed to make our pointer/keyboard grab.
1611 * Rather than leaving the user with a stuck up window,
1612 * we just abort here. Presumably the user will try again.
1614 menu_shell->priv->parent_menu_shell = NULL;
1615 menu_grab_transfer_window_destroy (menu);
1619 _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (menu), pointer);
1620 menu_shell->priv->active = TRUE;
1621 menu_shell->priv->button = button;
1623 /* If we are popping up the menu from something other than, a button
1624 * press then, as a heuristic, we ignore enter events for the menu
1625 * until we get a MOTION_NOTIFY.
1628 current_event = gtk_get_current_event ();
1631 if ((current_event->type != GDK_BUTTON_PRESS) &&
1632 (current_event->type != GDK_ENTER_NOTIFY))
1633 menu_shell->priv->ignore_enter = TRUE;
1635 gdk_event_free (current_event);
1638 menu_shell->priv->ignore_enter = TRUE;
1642 gtk_menu_tearoff_bg_copy (menu);
1644 gtk_menu_reparent (menu, priv->toplevel, FALSE);
1647 parent_toplevel = NULL;
1648 if (parent_menu_shell)
1649 parent_toplevel = gtk_widget_get_toplevel (parent_menu_shell);
1650 else if (!g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1652 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
1654 parent_toplevel = gtk_widget_get_toplevel (attach_widget);
1657 /* Set transient for to get the right window group and parent */
1658 if (GTK_IS_WINDOW (parent_toplevel))
1659 gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel),
1660 GTK_WINDOW (parent_toplevel));
1662 priv->parent_menu_item = parent_menu_item;
1663 priv->position_func = func;
1664 priv->position_func_data = data;
1665 priv->position_func_data_destroy = destroy;
1666 menu_shell->priv->activate_time = activate_time;
1668 /* We need to show the menu here rather in the init function
1669 * because code expects to be able to tell if the menu is onscreen
1670 * by looking at gtk_widget_get_visible (menu)
1672 gtk_widget_show (GTK_WIDGET (menu));
1674 /* Position the menu, possibly changing the size request
1676 gtk_menu_position (menu, TRUE);
1678 /* Compute the size of the toplevel and realize it so we
1679 * can scroll correctly.
1682 GtkRequisition tmp_request;
1683 GtkAllocation tmp_allocation = { 0, };
1685 /* Instead of trusting the menu position function to queue a
1686 * resize when the menu goes out of bounds, invalidate the cached
1689 gtk_widget_queue_resize (GTK_WIDGET (menu));
1690 gtk_widget_get_preferred_size (priv->toplevel, &tmp_request, NULL);
1692 tmp_allocation.width = tmp_request.width;
1693 tmp_allocation.height = tmp_request.height;
1695 gtk_widget_size_allocate (priv->toplevel, &tmp_allocation);
1697 gtk_widget_realize (GTK_WIDGET (menu));
1700 gtk_menu_scroll_to (menu, priv->scroll_offset);
1702 /* if no item is selected, select the first one */
1703 if (!menu_shell->priv->active_menu_item)
1705 gboolean touchscreen_mode;
1707 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
1708 "gtk-touchscreen-mode", &touchscreen_mode,
1711 if (touchscreen_mode)
1712 gtk_menu_shell_select_first (menu_shell, TRUE);
1715 /* Once everything is set up correctly, map the toplevel */
1716 gtk_widget_show (priv->toplevel);
1718 if (xgrab_shell == widget)
1719 popup_grab_on_window (gtk_widget_get_window (widget), keyboard, pointer, activate_time); /* Should always succeed */
1721 gtk_device_grab_add (GTK_WIDGET (menu), pointer, TRUE);
1723 if (parent_menu_shell)
1725 gboolean keyboard_mode;
1727 keyboard_mode = _gtk_menu_shell_get_keyboard_mode (GTK_MENU_SHELL (parent_menu_shell));
1728 _gtk_menu_shell_set_keyboard_mode (menu_shell, keyboard_mode);
1730 else if (menu_shell->priv->button == 0) /* a keynav-activated context menu */
1731 _gtk_menu_shell_set_keyboard_mode (menu_shell, TRUE);
1733 _gtk_menu_shell_update_mnemonics (menu_shell);
1737 * gtk_menu_popup: (skip)
1739 * @parent_menu_shell: (allow-none): the menu shell containing the
1740 * triggering menu item, or %NULL
1741 * @parent_menu_item: (allow-none): the menu item whose activation
1742 * triggered the popup, or %NULL
1743 * @func: (allow-none): a user supplied function used to position
1744 * the menu, or %NULL
1745 * @data: user supplied data to be passed to @func.
1746 * @button: the mouse button which was pressed to initiate the event.
1747 * @activate_time: the time at which the activation event occurred.
1749 * Displays a menu and makes it available for selection.
1751 * Applications can use this function to display context-sensitive
1752 * menus, and will typically supply %NULL for the @parent_menu_shell,
1753 * @parent_menu_item, @func and @data parameters. The default menu
1754 * positioning function will position the menu at the current mouse
1757 * The @button parameter should be the mouse button pressed to initiate
1758 * the menu popup. If the menu popup was initiated by something other
1759 * than a mouse button press, such as a mouse button release or a keypress,
1760 * @button should be 0.
1762 * The @activate_time parameter is used to conflict-resolve initiation
1763 * of concurrent requests for mouse/keyboard grab requests. To function
1764 * properly, this needs to be the timestamp of the user event (such as
1765 * a mouse click or key press) that caused the initiation of the popup.
1766 * Only if no such event is available, gtk_get_current_event_time() can
1770 gtk_menu_popup (GtkMenu *menu,
1771 GtkWidget *parent_menu_shell,
1772 GtkWidget *parent_menu_item,
1773 GtkMenuPositionFunc func,
1776 guint32 activate_time)
1778 g_return_if_fail (GTK_IS_MENU (menu));
1780 gtk_menu_popup_for_device (menu,
1785 button, activate_time);
1792 * Removes the menu from the screen.
1795 gtk_menu_popdown (GtkMenu *menu)
1797 GtkMenuPrivate *priv;
1798 GtkMenuShell *menu_shell;
1801 g_return_if_fail (GTK_IS_MENU (menu));
1803 menu_shell = GTK_MENU_SHELL (menu);
1806 menu_shell->priv->parent_menu_shell = NULL;
1807 menu_shell->priv->active = FALSE;
1808 menu_shell->priv->ignore_enter = FALSE;
1810 priv->have_position = FALSE;
1812 gtk_menu_stop_scrolling (menu);
1813 gtk_menu_stop_navigating_submenu (menu);
1815 if (menu_shell->priv->active_menu_item)
1817 if (priv->old_active_menu_item)
1818 g_object_unref (priv->old_active_menu_item);
1819 priv->old_active_menu_item = menu_shell->priv->active_menu_item;
1820 g_object_ref (priv->old_active_menu_item);
1823 gtk_menu_shell_deselect (menu_shell);
1825 /* The X Grab, if present, will automatically be removed
1826 * when we hide the window
1830 gtk_widget_hide (priv->toplevel);
1831 gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel), NULL);
1834 pointer = _gtk_menu_shell_get_grab_device (menu_shell);
1838 gtk_widget_set_size_request (priv->tearoff_window, -1, -1);
1840 if (gtk_bin_get_child (GTK_BIN (priv->toplevel)))
1842 gtk_menu_reparent (menu, priv->tearoff_hbox, TRUE);
1846 /* We popped up the menu from the tearoff, so we need to
1847 * release the grab - we aren't actually hiding the menu.
1849 if (menu_shell->priv->have_xgrab && pointer)
1851 GdkDevice *keyboard;
1853 gdk_device_ungrab (pointer, GDK_CURRENT_TIME);
1854 keyboard = gdk_device_get_associated_device (pointer);
1857 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1861 /* gtk_menu_popdown is called each time a menu item is selected from
1862 * a torn off menu. Only scroll back to the saved position if the
1863 * non-tearoff menu was popped down.
1865 if (!priv->tearoff_active)
1866 gtk_menu_scroll_to (menu, priv->saved_scroll_offset);
1867 priv->tearoff_active = TRUE;
1870 gtk_widget_hide (GTK_WIDGET (menu));
1872 menu_shell->priv->have_xgrab = FALSE;
1875 gtk_device_grab_remove (GTK_WIDGET (menu), pointer);
1877 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1879 menu_grab_transfer_window_destroy (menu);
1883 * gtk_menu_get_active:
1886 * Returns the selected menu item from the menu. This is used by the
1889 * Returns: (transfer none): the #GtkMenuItem that was last selected
1890 * in the menu. If a selection has not yet been made, the
1891 * first menu item is selected.
1894 gtk_menu_get_active (GtkMenu *menu)
1896 GtkMenuPrivate *priv = menu->priv;
1900 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1902 if (!priv->old_active_menu_item)
1905 children = GTK_MENU_SHELL (menu)->priv->children;
1909 child = children->data;
1910 children = children->next;
1912 if (gtk_bin_get_child (GTK_BIN (child)))
1917 priv->old_active_menu_item = child;
1918 if (priv->old_active_menu_item)
1919 g_object_ref (priv->old_active_menu_item);
1922 return priv->old_active_menu_item;
1926 * gtk_menu_set_active:
1928 * @index: the index of the menu item to select. Iindex values are
1931 * Selects the specified menu item within the menu. This is used by
1932 * the #GtkOptionMenu and should not be used by anyone else.
1935 gtk_menu_set_active (GtkMenu *menu,
1938 GtkMenuPrivate *priv = menu->priv;
1942 g_return_if_fail (GTK_IS_MENU (menu));
1944 tmp_list = g_list_nth (GTK_MENU_SHELL (menu)->priv->children, index);
1947 child = tmp_list->data;
1948 if (gtk_bin_get_child (GTK_BIN (child)))
1950 if (priv->old_active_menu_item)
1951 g_object_unref (priv->old_active_menu_item);
1952 priv->old_active_menu_item = child;
1953 g_object_ref (priv->old_active_menu_item);
1959 * gtk_menu_set_accel_group:
1961 * @accel_group: (allow-none): the #GtkAccelGroup to be associated
1964 * Set the #GtkAccelGroup which holds global accelerators for the
1965 * menu. This accelerator group needs to also be added to all windows
1966 * that this menu is being used in with gtk_window_add_accel_group(),
1967 * in order for those windows to support all the accelerators
1968 * contained in this group.
1971 gtk_menu_set_accel_group (GtkMenu *menu,
1972 GtkAccelGroup *accel_group)
1974 GtkMenuPrivate *priv = menu->priv;
1975 g_return_if_fail (GTK_IS_MENU (menu));
1977 if (priv->accel_group != accel_group)
1979 if (priv->accel_group)
1980 g_object_unref (priv->accel_group);
1981 priv->accel_group = accel_group;
1982 if (priv->accel_group)
1983 g_object_ref (priv->accel_group);
1984 _gtk_menu_refresh_accel_paths (menu, TRUE);
1989 * gtk_menu_get_accel_group:
1992 * Gets the #GtkAccelGroup which holds global accelerators for the
1993 * menu. See gtk_menu_set_accel_group().
1995 * Returns: (transfer none): the #GtkAccelGroup associated with the menu
1998 gtk_menu_get_accel_group (GtkMenu *menu)
2000 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2002 return menu->priv->accel_group;
2006 gtk_menu_real_can_activate_accel (GtkWidget *widget,
2009 /* Menu items chain here to figure whether they can activate their
2010 * accelerators. Unlike ordinary widgets, menus allow accel
2011 * activation even if invisible since that's the usual case for
2012 * submenus/popup-menus. however, the state of the attach widget
2013 * affects the "activeness" of the menu.
2015 GtkWidget *awidget = gtk_menu_get_attach_widget (GTK_MENU (widget));
2018 return gtk_widget_can_activate_accel (awidget, signal_id);
2020 return gtk_widget_is_sensitive (widget);
2024 * gtk_menu_set_accel_path
2025 * @menu: a valid #GtkMenu
2026 * @accel_path: (allow-none): a valid accelerator path
2028 * Sets an accelerator path for this menu from which accelerator paths
2029 * for its immediate children, its menu items, can be constructed.
2030 * The main purpose of this function is to spare the programmer the
2031 * inconvenience of having to call gtk_menu_item_set_accel_path() on
2032 * each menu item that should support runtime user changable accelerators.
2033 * Instead, by just calling gtk_menu_set_accel_path() on their parent,
2034 * each menu item of this menu, that contains a label describing its
2035 * purpose, automatically gets an accel path assigned.
2037 * For example, a menu containing menu items "New" and "Exit", will, after
2038 * <literal>gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");</literal>
2039 * has been called, assign its items the accel paths:
2040 * <literal>"<Gnumeric-Sheet>/File/New"</literal> and <literal>"<Gnumeric-Sheet>/File/Exit"</literal>.
2042 * Assigning accel paths to menu items then enables the user to change
2043 * their accelerators at runtime. More details about accelerator paths
2044 * and their default setups can be found at gtk_accel_map_add_entry().
2046 * Note that @accel_path string will be stored in a #GQuark. Therefore,
2047 * if you pass a static string, you can save some memory by interning
2048 * it first with g_intern_static_string().
2051 gtk_menu_set_accel_path (GtkMenu *menu,
2052 const gchar *accel_path)
2054 GtkMenuPrivate *priv = menu->priv;
2055 g_return_if_fail (GTK_IS_MENU (menu));
2058 g_return_if_fail (accel_path[0] == '<' && strchr (accel_path, '/')); /* simplistic check */
2060 /* FIXME: accel_path should be defined as const gchar* */
2061 priv->accel_path = (gchar*)g_intern_string (accel_path);
2062 if (priv->accel_path)
2063 _gtk_menu_refresh_accel_paths (menu, FALSE);
2067 * gtk_menu_get_accel_path
2068 * @menu: a valid #GtkMenu
2070 * Retrieves the accelerator path set on the menu.
2072 * Returns: the accelerator path set on the menu.
2077 gtk_menu_get_accel_path (GtkMenu *menu)
2079 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2081 return menu->priv->accel_path;
2086 gboolean group_changed;
2090 refresh_accel_paths_foreach (GtkWidget *widget,
2093 GtkMenuPrivate *priv;
2094 AccelPropagation *prop = data;
2096 if (GTK_IS_MENU_ITEM (widget)) /* should always be true */
2098 priv = prop->menu->priv;
2099 _gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
2102 prop->group_changed);
2107 _gtk_menu_refresh_accel_paths (GtkMenu *menu,
2108 gboolean group_changed)
2110 GtkMenuPrivate *priv = menu->priv;
2111 g_return_if_fail (GTK_IS_MENU (menu));
2113 if (priv->accel_path && priv->accel_group)
2115 AccelPropagation prop;
2118 prop.group_changed = group_changed;
2119 gtk_container_foreach (GTK_CONTAINER (menu),
2120 refresh_accel_paths_foreach,
2126 * gtk_menu_reposition:
2129 * Repositions the menu according to its position function.
2132 gtk_menu_reposition (GtkMenu *menu)
2134 g_return_if_fail (GTK_IS_MENU (menu));
2136 if (!menu->priv->torn_off && gtk_widget_is_drawable (GTK_WIDGET (menu)))
2137 gtk_menu_position (menu, FALSE);
2141 gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
2146 value = gtk_adjustment_get_value (adjustment);
2147 if (menu->priv->scroll_offset != value)
2148 gtk_menu_scroll_to (menu, value);
2152 gtk_menu_set_tearoff_hints (GtkMenu *menu,
2155 GtkMenuPrivate *priv = menu->priv;
2156 GdkGeometry geometry_hints;
2158 if (!priv->tearoff_window)
2161 if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2163 GtkRequisition requisition;
2165 gtk_widget_get_preferred_size (priv->tearoff_scrollbar,
2166 &requisition, NULL);
2167 width += requisition.width;
2170 geometry_hints.min_width = width;
2171 geometry_hints.max_width = width;
2173 geometry_hints.min_height = 0;
2174 geometry_hints.max_height = priv->requested_height;
2176 gtk_window_set_geometry_hints (GTK_WINDOW (priv->tearoff_window),
2179 GDK_HINT_MAX_SIZE|GDK_HINT_MIN_SIZE);
2183 gtk_menu_update_title (GtkMenu *menu)
2185 GtkMenuPrivate *priv = menu->priv;
2187 if (priv->tearoff_window)
2190 GtkWidget *attach_widget;
2192 title = gtk_menu_get_title (menu);
2195 attach_widget = gtk_menu_get_attach_widget (menu);
2196 if (GTK_IS_MENU_ITEM (attach_widget))
2198 GtkWidget *child = gtk_bin_get_child (GTK_BIN (attach_widget));
2199 if (GTK_IS_LABEL (child))
2200 title = gtk_label_get_text (GTK_LABEL (child));
2205 gtk_window_set_title (GTK_WINDOW (priv->tearoff_window), title);
2210 gtk_menu_get_toplevel (GtkWidget *menu)
2212 GtkWidget *attach, *toplevel;
2214 attach = gtk_menu_get_attach_widget (GTK_MENU (menu));
2216 if (GTK_IS_MENU_ITEM (attach))
2217 attach = gtk_widget_get_parent (attach);
2219 if (GTK_IS_MENU (attach))
2220 return gtk_menu_get_toplevel (attach);
2221 else if (GTK_IS_WIDGET (attach))
2223 toplevel = gtk_widget_get_toplevel (attach);
2224 if (gtk_widget_is_toplevel (toplevel))
2232 tearoff_window_destroyed (GtkWidget *widget,
2235 gtk_menu_set_tearoff_state (menu, FALSE);
2239 * gtk_menu_set_tearoff_state:
2241 * @torn_off: If %TRUE, menu is displayed as a tearoff menu.
2243 * Changes the tearoff state of the menu. A menu is normally
2244 * displayed as drop down menu which persists as long as the menu is
2245 * active. It can also be displayed as a tearoff menu which persists
2246 * until it is closed or reattached.
2249 gtk_menu_set_tearoff_state (GtkMenu *menu,
2252 GtkMenuPrivate *priv = menu->priv;
2255 g_return_if_fail (GTK_IS_MENU (menu));
2257 if (priv->torn_off != torn_off)
2259 priv->torn_off = torn_off;
2260 priv->tearoff_active = torn_off;
2264 if (gtk_widget_get_visible (GTK_WIDGET (menu)))
2265 gtk_menu_popdown (menu);
2267 if (!priv->tearoff_window)
2269 GtkWidget *toplevel;
2271 priv->tearoff_window = g_object_new (GTK_TYPE_WINDOW,
2272 "type", GTK_WINDOW_TOPLEVEL,
2273 "screen", gtk_widget_get_screen (priv->toplevel),
2274 "app-paintable", TRUE,
2277 gtk_window_set_type_hint (GTK_WINDOW (priv->tearoff_window),
2278 GDK_WINDOW_TYPE_HINT_MENU);
2279 gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->tearoff_window), 0);
2280 g_signal_connect (priv->tearoff_window, "destroy",
2281 G_CALLBACK (tearoff_window_destroyed), menu);
2282 g_signal_connect (priv->tearoff_window, "event",
2283 G_CALLBACK (gtk_menu_window_event), menu);
2285 gtk_menu_update_title (menu);
2287 gtk_widget_realize (priv->tearoff_window);
2289 toplevel = gtk_menu_get_toplevel (GTK_WIDGET (menu));
2290 if (toplevel != NULL)
2291 gtk_window_set_transient_for (GTK_WINDOW (priv->tearoff_window),
2292 GTK_WINDOW (toplevel));
2294 priv->tearoff_hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2295 gtk_container_add (GTK_CONTAINER (priv->tearoff_window),
2296 priv->tearoff_hbox);
2298 height = gdk_window_get_height (gtk_widget_get_window (GTK_WIDGET (menu)));
2299 priv->tearoff_adjustment = gtk_adjustment_new (0,
2300 0, priv->requested_height,
2304 g_object_connect (priv->tearoff_adjustment,
2305 "signal::value-changed", gtk_menu_scrollbar_changed, menu,
2307 priv->tearoff_scrollbar = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, priv->tearoff_adjustment);
2309 gtk_box_pack_end (GTK_BOX (priv->tearoff_hbox),
2310 priv->tearoff_scrollbar,
2313 if (gtk_adjustment_get_upper (priv->tearoff_adjustment) > height)
2314 gtk_widget_show (priv->tearoff_scrollbar);
2316 gtk_widget_show (priv->tearoff_hbox);
2319 gtk_menu_reparent (menu, priv->tearoff_hbox, FALSE);
2321 /* Update menu->requisition */
2322 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, NULL);
2324 gtk_menu_set_tearoff_hints (menu, gdk_window_get_width (gtk_widget_get_window (GTK_WIDGET (menu))));
2326 gtk_widget_realize (priv->tearoff_window);
2327 gtk_menu_position (menu, TRUE);
2329 gtk_widget_show (GTK_WIDGET (menu));
2330 gtk_widget_show (priv->tearoff_window);
2332 gtk_menu_scroll_to (menu, 0);
2337 gtk_widget_hide (GTK_WIDGET (menu));
2338 gtk_widget_hide (priv->tearoff_window);
2339 if (GTK_IS_CONTAINER (priv->toplevel))
2340 gtk_menu_reparent (menu, priv->toplevel, FALSE);
2341 gtk_widget_destroy (priv->tearoff_window);
2343 priv->tearoff_window = NULL;
2344 priv->tearoff_hbox = NULL;
2345 priv->tearoff_scrollbar = NULL;
2346 priv->tearoff_adjustment = NULL;
2349 g_object_notify (G_OBJECT (menu), "tearoff-state");
2354 * gtk_menu_get_tearoff_state:
2357 * Returns whether the menu is torn off.
2358 * See gtk_menu_set_tearoff_state().
2360 * Return value: %TRUE if the menu is currently torn off.
2363 gtk_menu_get_tearoff_state (GtkMenu *menu)
2365 g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
2367 return menu->priv->torn_off;
2371 * gtk_menu_set_title:
2373 * @title: a string containing the title for the menu
2375 * Sets the title string for the menu.
2377 * The title is displayed when the menu is shown as a tearoff
2378 * menu. If @title is %NULL, the menu will see if it is attached
2379 * to a parent menu item, and if so it will try to use the same
2380 * text as that menu item's label.
2383 gtk_menu_set_title (GtkMenu *menu,
2386 GtkMenuPrivate *priv = menu->priv;
2389 g_return_if_fail (GTK_IS_MENU (menu));
2391 old_title = priv->title;
2392 priv->title = g_strdup (title);
2395 gtk_menu_update_title (menu);
2396 g_object_notify (G_OBJECT (menu), "tearoff-title");
2400 * gtk_menu_get_title:
2403 * Returns the title of the menu. See gtk_menu_set_title().
2405 * Return value: the title of the menu, or %NULL if the menu
2406 * has no title set on it. This string is owned by GTK+
2407 * and should not be modified or freed.
2409 G_CONST_RETURN gchar *
2410 gtk_menu_get_title (GtkMenu *menu)
2412 g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2414 return menu->priv->title;
2418 * gtk_menu_reorder_child:
2420 * @child: the #GtkMenuItem to move
2421 * @position: the new position to place @child.
2422 * Positions are numbered from 0 to n - 1
2424 * Moves @child to a new @position in the list of @menu
2428 gtk_menu_reorder_child (GtkMenu *menu,
2432 GtkMenuShell *menu_shell;
2434 g_return_if_fail (GTK_IS_MENU (menu));
2435 g_return_if_fail (GTK_IS_MENU_ITEM (child));
2437 menu_shell = GTK_MENU_SHELL (menu);
2439 if (g_list_find (menu_shell->priv->children, child))
2441 menu_shell->priv->children = g_list_remove (menu_shell->priv->children, child);
2442 menu_shell->priv->children = g_list_insert (menu_shell->priv->children, child, position);
2444 menu_queue_resize (menu);
2449 gtk_menu_style_updated (GtkWidget *widget)
2451 GTK_WIDGET_CLASS (gtk_menu_parent_class)->style_updated (widget);
2453 if (gtk_widget_get_realized (widget))
2455 GtkMenu *menu = GTK_MENU (widget);
2456 GtkMenuPrivate *priv = menu->priv;
2457 GtkStyleContext *context;
2459 context = gtk_widget_get_style_context (widget);
2461 gtk_style_context_set_background (context, priv->bin_window);
2462 gtk_style_context_set_background (context, priv->view_window);
2463 gtk_style_context_set_background (context, gtk_widget_get_window (widget));
2468 get_arrows_border (GtkMenu *menu,
2471 GtkMenuPrivate *priv = menu->priv;
2472 guint scroll_arrow_height;
2473 GtkArrowPlacement arrow_placement;
2475 gtk_widget_style_get (GTK_WIDGET (menu),
2476 "scroll-arrow-vlength", &scroll_arrow_height,
2477 "arrow_placement", &arrow_placement,
2480 switch (arrow_placement)
2482 case GTK_ARROWS_BOTH:
2483 border->top = priv->upper_arrow_visible ? scroll_arrow_height : 0;
2484 border->bottom = priv->lower_arrow_visible ? scroll_arrow_height : 0;
2487 case GTK_ARROWS_START:
2488 border->top = (priv->upper_arrow_visible ||
2489 priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2493 case GTK_ARROWS_END:
2495 border->bottom = (priv->upper_arrow_visible ||
2496 priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2500 border->left = border->right = 0;
2504 get_menu_border (GtkWidget *widget,
2507 GtkStyleContext *context;
2508 GtkStateFlags state;
2509 GtkBorder padding, border_width;
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);
2515 gtk_style_context_get_border (context, state, &border_width);
2517 border->left = border_width.left + padding.left;
2518 border->right = border_width.right + padding.right;
2519 border->top = border_width.top + padding.top;
2520 border->bottom = border_width.bottom + padding.bottom;
2524 gtk_menu_realize (GtkWidget *widget)
2526 GtkMenu *menu = GTK_MENU (widget);
2527 GtkMenuPrivate *priv = menu->priv;
2528 GtkAllocation allocation;
2529 GtkStyleContext *context;
2531 GdkWindowAttr attributes;
2532 gint attributes_mask;
2536 guint vertical_padding;
2537 guint horizontal_padding;
2538 GtkBorder arrow_border, border;
2540 g_return_if_fail (GTK_IS_MENU (widget));
2542 gtk_widget_set_realized (widget, TRUE);
2544 gtk_widget_get_allocation (widget, &allocation);
2546 attributes.window_type = GDK_WINDOW_CHILD;
2547 attributes.x = allocation.x;
2548 attributes.y = allocation.y;
2549 attributes.width = allocation.width;
2550 attributes.height = allocation.height;
2551 attributes.wclass = GDK_INPUT_OUTPUT;
2552 attributes.visual = gtk_widget_get_visual (widget);
2553 attributes.event_mask = gtk_widget_get_events (widget);
2554 attributes.event_mask |= (GDK_EXPOSURE_MASK | GDK_KEY_PRESS_MASK |
2555 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK );
2557 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
2559 window = gdk_window_new (gtk_widget_get_parent_window (widget),
2560 &attributes, attributes_mask);
2561 gtk_widget_set_window (widget, window);
2562 gdk_window_set_user_data (window, widget);
2564 get_menu_border (widget, &border);
2565 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2566 context = gtk_widget_get_style_context (widget);
2568 gtk_widget_style_get (GTK_WIDGET (menu),
2569 "vertical-padding", &vertical_padding,
2570 "horizontal-padding", &horizontal_padding,
2573 gtk_widget_get_allocation (widget, &allocation);
2575 attributes.x = border_width + border.left + horizontal_padding;
2576 attributes.y = border_width + border.top + vertical_padding;
2577 attributes.width = allocation.width -
2578 (2 * (border_width + horizontal_padding)) - border.left - border.right;
2579 attributes.height = allocation.height -
2580 (2 * (border_width + vertical_padding)) - border.top - border.bottom;
2582 get_arrows_border (menu, &arrow_border);
2583 attributes.y += arrow_border.top;
2584 attributes.height -= arrow_border.top;
2585 attributes.height -= arrow_border.bottom;
2587 attributes.width = MAX (1, attributes.width);
2588 attributes.height = MAX (1, attributes.height);
2590 priv->view_window = gdk_window_new (window,
2591 &attributes, attributes_mask);
2592 gdk_window_set_user_data (priv->view_window, menu);
2594 gtk_widget_get_allocation (widget, &allocation);
2598 attributes.width = allocation.width + (2 * (border_width + horizontal_padding)) +
2599 border.left + border.right;
2600 attributes.height = priv->requested_height - (2 * (border_width + vertical_padding)) +
2601 border.top + border.bottom;
2603 attributes.width = MAX (1, attributes.width);
2604 attributes.height = MAX (1, attributes.height);
2606 priv->bin_window = gdk_window_new (priv->view_window,
2607 &attributes, attributes_mask);
2608 gdk_window_set_user_data (priv->bin_window, menu);
2610 children = GTK_MENU_SHELL (menu)->priv->children;
2613 child = children->data;
2614 children = children->next;
2616 gtk_widget_set_parent_window (child, priv->bin_window);
2619 gtk_style_context_set_background (context, priv->bin_window);
2620 gtk_style_context_set_background (context, priv->view_window);
2621 gtk_style_context_set_background (context, window);
2623 if (GTK_MENU_SHELL (widget)->priv->active_menu_item)
2624 gtk_menu_scroll_item_visible (GTK_MENU_SHELL (widget),
2625 GTK_MENU_SHELL (widget)->priv->active_menu_item);
2627 gdk_window_show (priv->bin_window);
2628 gdk_window_show (priv->view_window);
2632 gtk_menu_focus (GtkWidget *widget,
2633 GtkDirectionType direction)
2635 /* A menu or its menu items cannot have focus */
2639 /* See notes in gtk_menu_popup() for information
2640 * about the "grab transfer window"
2643 menu_grab_transfer_window_get (GtkMenu *menu)
2645 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2648 GdkWindowAttr attributes;
2649 gint attributes_mask;
2651 attributes.x = -100;
2652 attributes.y = -100;
2653 attributes.width = 10;
2654 attributes.height = 10;
2655 attributes.window_type = GDK_WINDOW_TEMP;
2656 attributes.wclass = GDK_INPUT_ONLY;
2657 attributes.override_redirect = TRUE;
2658 attributes.event_mask = 0;
2660 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
2662 window = gdk_window_new (gtk_widget_get_root_window (GTK_WIDGET (menu)),
2663 &attributes, attributes_mask);
2664 gdk_window_set_user_data (window, menu);
2666 gdk_window_show (window);
2668 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), window);
2675 menu_grab_transfer_window_destroy (GtkMenu *menu)
2677 GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2680 gdk_window_set_user_data (window, NULL);
2681 gdk_window_destroy (window);
2682 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), NULL);
2687 gtk_menu_unrealize (GtkWidget *widget)
2689 GtkMenu *menu = GTK_MENU (widget);
2690 GtkMenuPrivate *priv = menu->priv;
2692 menu_grab_transfer_window_destroy (menu);
2694 gdk_window_set_user_data (priv->view_window, NULL);
2695 gdk_window_destroy (priv->view_window);
2696 priv->view_window = NULL;
2698 gdk_window_set_user_data (priv->bin_window, NULL);
2699 gdk_window_destroy (priv->bin_window);
2700 priv->bin_window = NULL;
2702 GTK_WIDGET_CLASS (gtk_menu_parent_class)->unrealize (widget);
2706 calculate_line_heights (GtkMenu *menu,
2708 guint **ret_min_heights,
2709 guint **ret_nat_heights)
2711 GtkStyleContext *context;
2712 GtkStateFlags state;
2714 GtkMenuPrivate *priv;
2715 GtkMenuShell *menu_shell;
2716 GtkWidget *child, *widget;
2718 guint horizontal_padding;
2727 widget = GTK_WIDGET (menu);
2728 menu_shell = GTK_MENU_SHELL (widget);
2730 min_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2731 nat_heights = g_new0 (guint, gtk_menu_get_n_rows (menu));
2732 n_heights = gtk_menu_get_n_rows (menu);
2733 n_columns = gtk_menu_get_n_columns (menu);
2734 avail_width = for_width - (2 * priv->toggle_size + priv->accel_size) * n_columns;
2736 gtk_widget_style_get (GTK_WIDGET (menu),
2737 "horizontal-padding", &horizontal_padding,
2740 context = gtk_widget_get_style_context (widget);
2741 state = gtk_widget_get_state_flags (widget);
2742 gtk_style_context_get_padding (context, state, &padding);
2744 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2745 avail_width -= (border_width + horizontal_padding) * 2 + padding.left + padding.right;
2747 for (children = menu_shell->priv->children; children; children = children->next)
2752 gint child_min, child_nat;
2754 child = children->data;
2756 if (!gtk_widget_get_visible (child))
2759 get_effective_child_attach (child, &l, &r, &t, &b);
2761 part = avail_width / (r - l);
2763 gtk_widget_get_preferred_height_for_width (child, part,
2764 &child_min, &child_nat);
2766 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
2768 part = MAX (child_min, toggle_size) / (b - t);
2769 min_heights[t] = MAX (min_heights[t], part);
2771 part = MAX (child_nat, toggle_size) / (b - t);
2772 nat_heights[t] = MAX (nat_heights[t], part);
2775 if (ret_min_heights)
2776 *ret_min_heights = min_heights;
2778 g_free (min_heights);
2780 if (ret_nat_heights)
2781 *ret_nat_heights = nat_heights;
2783 g_free (nat_heights);
2789 gtk_menu_size_allocate (GtkWidget *widget,
2790 GtkAllocation *allocation)
2793 GtkMenuPrivate *priv;
2794 GtkMenuShell *menu_shell;
2796 GtkAllocation child_allocation;
2801 guint vertical_padding;
2802 guint horizontal_padding;
2805 g_return_if_fail (GTK_IS_MENU (widget));
2806 g_return_if_fail (allocation != NULL);
2808 menu = GTK_MENU (widget);
2809 menu_shell = GTK_MENU_SHELL (widget);
2812 gtk_widget_set_allocation (widget, allocation);
2814 gtk_widget_style_get (GTK_WIDGET (menu),
2815 "vertical-padding", &vertical_padding,
2816 "horizontal-padding", &horizontal_padding,
2819 get_menu_border (widget, &border);
2820 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2822 g_free (priv->heights);
2823 priv->heights_length = calculate_line_heights (menu,
2828 /* refresh our cached height request */
2829 priv->requested_height = (2 * (border_width + vertical_padding)) +
2830 border.top + border.bottom;
2831 for (i = 0; i < priv->heights_length; i++)
2832 priv->requested_height += priv->heights[i];
2834 x = border_width + border.left + horizontal_padding;
2835 y = border_width + border.top + vertical_padding;
2836 width = allocation->width - (2 * (border_width + horizontal_padding)) -
2837 border.left - border.right;
2838 height = allocation->height - (2 * (border_width + vertical_padding)) -
2839 border.top - border.bottom;
2841 if (menu_shell->priv->active)
2842 gtk_menu_scroll_to (menu, priv->scroll_offset);
2844 if (!priv->tearoff_active)
2846 GtkBorder arrow_border;
2848 get_arrows_border (menu, &arrow_border);
2849 y += arrow_border.top;
2850 height -= arrow_border.top;
2851 height -= arrow_border.bottom;
2854 width = MAX (1, width);
2855 height = MAX (1, height);
2857 if (gtk_widget_get_realized (widget))
2859 gdk_window_move_resize (gtk_widget_get_window (widget),
2860 allocation->x, allocation->y,
2861 allocation->width, allocation->height);
2863 gdk_window_move_resize (priv->view_window, x, y, width, height);
2866 if (menu_shell->priv->children)
2868 gint base_width = width / gtk_menu_get_n_columns (menu);
2870 children = menu_shell->priv->children;
2873 child = children->data;
2874 children = children->next;
2876 if (gtk_widget_get_visible (child))
2881 get_effective_child_attach (child, &l, &r, &t, &b);
2883 if (gtk_widget_get_direction (GTK_WIDGET (menu)) == GTK_TEXT_DIR_RTL)
2886 tmp = gtk_menu_get_n_columns (menu) - l;
2887 l = gtk_menu_get_n_columns (menu) - r;
2891 child_allocation.width = (r - l) * base_width;
2892 child_allocation.height = 0;
2893 child_allocation.x = l * base_width;
2894 child_allocation.y = 0;
2896 for (i = 0; i < b; i++)
2899 child_allocation.y += priv->heights[i];
2901 child_allocation.height += priv->heights[i];
2904 gtk_menu_item_toggle_size_allocate (GTK_MENU_ITEM (child),
2907 gtk_widget_size_allocate (child, &child_allocation);
2908 gtk_widget_queue_draw (child);
2912 /* Resize the item window */
2913 if (gtk_widget_get_realized (widget))
2919 for (i = 0; i < gtk_menu_get_n_rows (menu); i++)
2920 height += priv->heights[i];
2922 width = gtk_menu_get_n_columns (menu) * base_width;
2923 gdk_window_resize (priv->bin_window, width, height);
2926 if (priv->tearoff_active)
2928 if (height >= priv->requested_height)
2930 if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2932 gtk_widget_hide (priv->tearoff_scrollbar);
2933 gtk_menu_set_tearoff_hints (menu, allocation->width);
2935 gtk_menu_scroll_to (menu, 0);
2940 gtk_adjustment_configure (priv->tearoff_adjustment,
2941 gtk_adjustment_get_value (priv->tearoff_adjustment),
2943 priv->requested_height,
2944 gtk_adjustment_get_step_increment (priv->tearoff_adjustment),
2945 gtk_adjustment_get_page_increment (priv->tearoff_adjustment),
2946 allocation->height);
2948 if (!gtk_widget_get_visible (priv->tearoff_scrollbar))
2950 gtk_widget_show (priv->tearoff_scrollbar);
2951 gtk_menu_set_tearoff_hints (menu, allocation->width);
2959 get_arrows_visible_area (GtkMenu *menu,
2960 GdkRectangle *border,
2961 GdkRectangle *upper,
2962 GdkRectangle *lower,
2965 GtkArrowPlacement arrow_placement;
2966 GtkWidget *widget = GTK_WIDGET (menu);
2968 guint vertical_padding;
2969 guint horizontal_padding;
2970 gint scroll_arrow_height;
2971 GtkBorder menu_border;
2973 gtk_widget_style_get (widget,
2974 "vertical-padding", &vertical_padding,
2975 "horizontal-padding", &horizontal_padding,
2976 "scroll-arrow-vlength", &scroll_arrow_height,
2977 "arrow-placement", &arrow_placement,
2980 get_menu_border (widget, &menu_border);
2981 border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2982 border->x = border_width + menu_border.left + horizontal_padding;
2983 border->y = border_width + menu_border.top + vertical_padding;
2984 border->width = gdk_window_get_width (gtk_widget_get_window (widget));
2985 border->height = gdk_window_get_height (gtk_widget_get_window (widget));
2987 switch (arrow_placement)
2989 case GTK_ARROWS_BOTH:
2990 upper->x = border->x;
2991 upper->y = border->y;
2992 upper->width = border->width - 2 * border->x;
2993 upper->height = scroll_arrow_height;
2995 lower->x = border->x;
2996 lower->y = border->height - border->y - scroll_arrow_height;
2997 lower->width = border->width - 2 * border->x;
2998 lower->height = scroll_arrow_height;
3001 case GTK_ARROWS_START:
3002 upper->x = border->x;
3003 upper->y = border->y;
3004 upper->width = (border->width - 2 * border->x) / 2;
3005 upper->height = scroll_arrow_height;
3007 lower->x = border->x + upper->width;
3008 lower->y = border->y;
3009 lower->width = (border->width - 2 * border->x) / 2;
3010 lower->height = scroll_arrow_height;
3013 case GTK_ARROWS_END:
3014 upper->x = border->x;
3015 upper->y = border->height - border->y - scroll_arrow_height;
3016 upper->width = (border->width - 2 * border->x) / 2;
3017 upper->height = scroll_arrow_height;
3019 lower->x = border->x + upper->width;
3020 lower->y = border->height - border->y - scroll_arrow_height;
3021 lower->width = (border->width - 2 * border->x) / 2;
3022 lower->height = scroll_arrow_height;
3026 g_assert_not_reached();
3027 upper->x = upper->y = upper->width = upper->height = 0;
3028 lower->x = lower->y = lower->width = lower->height = 0;
3031 *arrow_space = scroll_arrow_height - menu_border.top - menu_border.bottom;
3035 gtk_menu_draw (GtkWidget *widget,
3039 GtkMenuPrivate *priv;
3040 GtkStyleContext *context;
3041 GdkRectangle border;
3045 GtkBorder menu_border;
3047 menu = GTK_MENU (widget);
3049 context = gtk_widget_get_style_context (widget);
3051 get_arrows_visible_area (menu, &border, &upper, &lower, &arrow_space);
3052 get_menu_border (widget, &menu_border);
3054 if (gtk_cairo_should_draw_window (cr, gtk_widget_get_window (widget)))
3056 gfloat arrow_scaling;
3059 gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
3060 arrow_size = arrow_scaling * arrow_space;
3062 gtk_render_background (context, cr, 0, 0,
3063 gtk_widget_get_allocated_width (widget),
3064 gtk_widget_get_allocated_height (widget));
3065 gtk_render_frame (context, cr, 0, 0,
3066 gtk_widget_get_allocated_width (widget),
3067 gtk_widget_get_allocated_height (widget));
3069 gtk_style_context_save (context);
3070 gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
3072 if (priv->upper_arrow_visible && !priv->tearoff_active)
3074 gtk_style_context_save (context);
3075 gtk_style_context_set_state (context, priv->upper_arrow_state);
3077 gtk_render_background (context, cr,
3079 upper.width, upper.height);
3080 gtk_render_frame (context, cr,
3082 upper.width, upper.height);
3084 gtk_render_arrow (context, cr, 0,
3085 upper.x + (upper.width - arrow_size) / 2,
3086 upper.y + menu_border.top + (arrow_space - arrow_size) / 2,
3089 gtk_style_context_restore (context);
3092 if (priv->lower_arrow_visible && !priv->tearoff_active)
3094 gtk_style_context_save (context);
3095 gtk_style_context_set_state (context, priv->lower_arrow_state);
3097 gtk_render_background (context, cr,
3099 lower.width, lower.height);
3100 gtk_render_frame (context, cr,
3102 lower.width, lower.height);
3104 gtk_render_arrow (context, cr, G_PI,
3105 lower.x + (lower.width - arrow_size) / 2,
3106 lower.y + menu_border.top + (arrow_space - arrow_size) / 2,
3109 gtk_style_context_restore (context);
3112 gtk_style_context_restore (context);
3115 if (gtk_cairo_should_draw_window (cr, priv->bin_window))
3117 gint y = -border.y + priv->scroll_offset;
3120 gtk_cairo_transform_to_window (cr, widget, priv->bin_window);
3122 if (!priv->tearoff_active)
3124 GtkBorder arrow_border;
3126 get_arrows_border (menu, &arrow_border);
3127 y -= arrow_border.top;
3130 gtk_render_background (context, cr,
3132 border.width, border.height);
3133 gtk_render_frame (context, cr,
3135 border.width, border.height);
3140 GTK_WIDGET_CLASS (gtk_menu_parent_class)->draw (widget, cr);
3146 gtk_menu_show (GtkWidget *widget)
3148 GtkMenu *menu = GTK_MENU (widget);
3150 _gtk_menu_refresh_accel_paths (menu, FALSE);
3152 GTK_WIDGET_CLASS (gtk_menu_parent_class)->show (widget);
3157 gtk_menu_get_preferred_width (GtkWidget *widget,
3162 GtkMenuShell *menu_shell;
3163 GtkMenuPrivate *priv;
3166 guint max_toggle_size;
3167 guint max_accel_width;
3168 guint horizontal_padding;
3170 gint child_min, child_nat;
3171 gint min_width, nat_width;
3174 menu = GTK_MENU (widget);
3175 menu_shell = GTK_MENU_SHELL (widget);
3178 min_width = nat_width = 0;
3180 max_toggle_size = 0;
3181 max_accel_width = 0;
3183 children = menu_shell->priv->children;
3190 child = children->data;
3191 children = children->next;
3193 if (! gtk_widget_get_visible (child))
3196 get_effective_child_attach (child, &l, &r, &t, &b);
3198 /* It's important to size_request the child
3199 * before doing the toggle size request, in
3200 * case the toggle size request depends on the size
3201 * request of a child of the child (e.g. for ImageMenuItem)
3203 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
3205 gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
3206 max_toggle_size = MAX (max_toggle_size, toggle_size);
3207 max_accel_width = MAX (max_accel_width,
3208 GTK_MENU_ITEM (child)->priv->accelerator_width);
3210 part = child_min / (r - l);
3211 min_width = MAX (min_width, part);
3213 part = child_nat / (r - l);
3214 nat_width = MAX (nat_width, part);
3217 /* If the menu doesn't include any images or check items
3218 * reserve the space so that all menus are consistent.
3219 * We only do this for 'ordinary' menus, not for combobox
3220 * menus or multi-column menus
3222 if (max_toggle_size == 0 &&
3223 gtk_menu_get_n_columns (menu) == 1 &&
3224 !priv->no_toggle_size)
3226 GtkStyleContext *context;
3227 GtkWidgetPath *menu_path, *check_path;
3228 guint toggle_spacing;
3229 guint indicator_size;
3231 context = gtk_widget_get_style_context (widget);
3232 menu_path = gtk_widget_path_copy (gtk_style_context_get_path (context));
3234 /* Create a GtkCheckMenuItem path, only to query indicator spacing */
3235 check_path = gtk_widget_path_copy (menu_path);
3236 gtk_widget_path_append_type (check_path, GTK_TYPE_CHECK_MENU_ITEM);
3238 gtk_style_context_set_path (context, check_path);
3239 gtk_widget_path_free (check_path);
3241 gtk_style_context_get_style (context,
3242 "toggle-spacing", &toggle_spacing,
3243 "indicator-size", &indicator_size,
3246 max_toggle_size = indicator_size + toggle_spacing;
3248 /* Restore real widget path */
3249 gtk_style_context_set_path (context, menu_path);
3250 gtk_widget_path_free (menu_path);
3253 min_width += 2 * max_toggle_size + max_accel_width;
3254 min_width *= gtk_menu_get_n_columns (menu);
3256 nat_width += 2 * max_toggle_size + max_accel_width;
3257 nat_width *= gtk_menu_get_n_columns (menu);
3259 gtk_widget_style_get (GTK_WIDGET (menu),
3260 "horizontal-padding", &horizontal_padding,
3263 get_menu_border (widget, &border);
3264 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3265 min_width += (2 * (border_width + horizontal_padding)) +
3266 border.left + border.right;
3267 nat_width += (2 * (border_width + horizontal_padding)) +
3268 border.top + border.bottom;
3270 priv->toggle_size = max_toggle_size;
3271 priv->accel_size = max_accel_width;
3274 *minimum_size = min_width;
3277 *natural_size = nat_width;
3279 /* Don't resize the tearoff if it is not active,
3280 * because it won't redraw (it is only a background pixmap).
3282 if (priv->tearoff_active)
3283 gtk_menu_set_tearoff_hints (menu, min_width);
3287 gtk_menu_get_preferred_height (GtkWidget *widget,
3293 /* Menus are height-for-width only, just return the height
3294 * for the minimum width
3296 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
3297 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
3301 gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
3306 GtkStyleContext *context;
3307 GtkStateFlags state;
3308 GtkBorder padding, border;
3309 GtkMenu *menu = GTK_MENU (widget);
3310 GtkMenuPrivate *priv = menu->priv;
3311 guint *min_heights, *nat_heights;
3312 guint vertical_padding, border_width;
3314 gint min_height, nat_height;
3316 gtk_widget_style_get (widget, "vertical-padding", &vertical_padding, NULL);
3317 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3319 context = gtk_widget_get_style_context (widget);
3320 state = gtk_widget_get_state_flags (widget);
3321 gtk_style_context_get_padding (context, state, &padding);
3322 gtk_style_context_get_border (context, state, &border);
3324 min_height = nat_height = (border_width + vertical_padding) * 2 +
3325 padding.left + padding.right + border.left + border.right;
3328 calculate_line_heights (menu, for_size, &min_heights, &nat_heights);
3330 for (i = 0; i < n_heights; i++)
3332 min_height += min_heights[i];
3333 nat_height += nat_heights[i];
3336 if (priv->have_position)
3338 GdkScreen *screen = gtk_widget_get_screen (priv->toplevel);
3339 GdkRectangle monitor;
3341 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
3343 if (priv->position_y + min_height > monitor.y + monitor.height)
3344 min_height = monitor.y + monitor.height - priv->position_y;
3346 if (priv->position_y + nat_height > monitor.y + monitor.height)
3347 nat_height = monitor.y + monitor.height - priv->position_y;
3349 if (priv->position_y < monitor.y)
3351 min_height -= monitor.y - priv->position_y;
3352 nat_height -= monitor.y - priv->position_y;
3357 *minimum_size = min_height;
3360 *natural_size = nat_height;
3362 g_free (min_heights);
3363 g_free (nat_heights);
3369 gtk_menu_button_scroll (GtkMenu *menu,
3370 GdkEventButton *event)
3372 GtkMenuPrivate *priv = menu->priv;
3374 if (priv->upper_arrow_prelight || priv->lower_arrow_prelight)
3376 gboolean touchscreen_mode;
3378 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3379 "gtk-touchscreen-mode", &touchscreen_mode,
3382 if (touchscreen_mode)
3383 gtk_menu_handle_scrolling (menu,
3384 event->x_root, event->y_root,
3385 event->type == GDK_BUTTON_PRESS,
3395 pointer_in_menu_window (GtkWidget *widget,
3399 GtkMenu *menu = GTK_MENU (widget);
3400 GtkMenuPrivate *priv = menu->priv;
3401 GtkAllocation allocation;
3403 if (gtk_widget_get_mapped (priv->toplevel))
3405 GtkMenuShell *menu_shell;
3406 gint window_x, window_y;
3408 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
3409 &window_x, &window_y);
3411 gtk_widget_get_allocation (widget, &allocation);
3412 if (x_root >= window_x && x_root < window_x + allocation.width &&
3413 y_root >= window_y && y_root < window_y + allocation.height)
3416 menu_shell = GTK_MENU_SHELL (widget);
3418 if (GTK_IS_MENU (menu_shell->priv->parent_menu_shell))
3419 return pointer_in_menu_window (menu_shell->priv->parent_menu_shell,
3427 gtk_menu_button_press (GtkWidget *widget,
3428 GdkEventButton *event)
3430 if (event->type != GDK_BUTTON_PRESS)
3433 /* Don't pass down to menu shell for presses over scroll arrows
3435 if (gtk_menu_button_scroll (GTK_MENU (widget), event))
3438 /* Don't pass down to menu shell if a non-menuitem part of the menu
3439 * was clicked. The check for the event_widget being a GtkMenuShell
3440 * works because we have the pointer grabbed on menu_shell->window
3441 * with owner_events=TRUE, so all events that are either outside
3442 * the menu or on its border are delivered relative to
3443 * menu_shell->window.
3445 if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3446 pointer_in_menu_window (widget, event->x_root, event->y_root))
3449 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_press_event (widget, event);
3453 gtk_menu_button_release (GtkWidget *widget,
3454 GdkEventButton *event)
3456 GtkMenuPrivate *priv = GTK_MENU (widget)->priv;
3458 if (priv->ignore_button_release)
3460 priv->ignore_button_release = FALSE;
3464 if (event->type != GDK_BUTTON_RELEASE)
3467 /* Don't pass down to menu shell for releases over scroll arrows
3469 if (gtk_menu_button_scroll (GTK_MENU (widget), event))
3472 /* Don't pass down to menu shell if a non-menuitem part of the menu
3473 * was clicked (see comment in button_press()).
3475 if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3476 pointer_in_menu_window (widget, event->x_root, event->y_root))
3478 /* Ugly: make sure menu_shell->button gets reset to 0 when we
3479 * bail out early here so it is in a consistent state for the
3480 * next button_press/button_release in GtkMenuShell.
3483 if (GTK_MENU_SHELL (widget)->priv->active)
3484 GTK_MENU_SHELL (widget)->priv->button = 0;
3489 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_release_event (widget, event);
3492 static const gchar *
3493 get_accel_path (GtkWidget *menu_item,
3498 GClosure *accel_closure;
3499 GtkAccelGroup *accel_group;
3501 path = _gtk_widget_get_accel_path (menu_item, locked);
3504 path = GTK_MENU_ITEM (menu_item)->priv->accel_path;
3510 label = gtk_bin_get_child (GTK_BIN (menu_item));
3512 if (GTK_IS_ACCEL_LABEL (label))
3514 g_object_get (label,
3515 "accel-closure", &accel_closure,
3519 accel_group = gtk_accel_group_from_accel_closure (accel_closure);
3521 *locked = gtk_accel_group_get_is_locked (accel_group);
3531 gtk_menu_key_press (GtkWidget *widget,
3534 GtkMenuShell *menu_shell;
3536 gboolean delete = FALSE;
3537 gboolean can_change_accels;
3538 gchar *accel = NULL;
3539 guint accel_key, accel_mods;
3540 GdkModifierType consumed_modifiers;
3541 GdkDisplay *display;
3543 g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
3544 g_return_val_if_fail (event != NULL, FALSE);
3546 menu_shell = GTK_MENU_SHELL (widget);
3547 menu = GTK_MENU (widget);
3549 gtk_menu_stop_navigating_submenu (menu);
3551 if (GTK_WIDGET_CLASS (gtk_menu_parent_class)->key_press_event (widget, event))
3554 display = gtk_widget_get_display (widget);
3556 g_object_get (gtk_widget_get_settings (widget),
3557 "gtk-menu-bar-accel", &accel,
3558 "gtk-can-change-accels", &can_change_accels,
3561 if (accel && *accel)
3564 GdkModifierType mods = 0;
3566 gtk_accelerator_parse (accel, &keyval, &mods);
3569 g_warning ("Failed to parse menu bar accelerator '%s'\n", accel);
3571 /* FIXME this is wrong, needs to be in the global accel resolution
3572 * thing, to properly consider i18n etc., but that probably requires
3573 * AccelGroup changes etc.
3575 if (event->keyval == keyval && (mods & event->state) == mods)
3577 gtk_menu_shell_cancel (menu_shell);
3585 switch (event->keyval)
3587 case GDK_KEY_Delete:
3588 case GDK_KEY_KP_Delete:
3589 case GDK_KEY_BackSpace:
3596 /* Figure out what modifiers went into determining the key symbol */
3597 gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
3598 event->hardware_keycode,
3599 event->state, event->group,
3600 NULL, NULL, NULL, &consumed_modifiers);
3602 accel_key = gdk_keyval_to_lower (event->keyval);
3603 accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
3605 /* If lowercasing affects the keysym, then we need to include SHIFT
3606 * in the modifiers, we re-uppercase when we match against the keyval,
3607 * but display and save in caseless form.
3609 if (accel_key != event->keyval)
3610 accel_mods |= GDK_SHIFT_MASK;
3612 /* Modify the accelerators */
3613 if (can_change_accels &&
3614 menu_shell->priv->active_menu_item &&
3615 gtk_bin_get_child (GTK_BIN (menu_shell->priv->active_menu_item)) && /* no separators */
3616 GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu == NULL && /* no submenus */
3617 (delete || gtk_accelerator_valid (accel_key, accel_mods)))
3619 GtkWidget *menu_item = menu_shell->priv->active_menu_item;
3620 gboolean locked, replace_accels = TRUE;
3623 path = get_accel_path (menu_item, &locked);
3624 if (!path || locked)
3626 /* Can't change accelerators on menu_items without paths
3627 * (basically, those items are accelerator-locked).
3629 gtk_widget_error_bell (widget);
3635 /* For the keys that act to delete the current setting,
3636 * we delete the current setting if there is one, otherwise,
3637 * we set the key as the accelerator.
3643 if (gtk_accel_map_lookup_entry (path, &key) &&
3644 (key.accel_key || key.accel_mods))
3650 changed = gtk_accel_map_change_entry (path, accel_key, accel_mods, replace_accels);
3654 /* We failed, probably because this key is in use
3655 * and locked already.
3657 gtk_widget_error_bell (widget);
3666 check_threshold (GtkWidget *widget,
3675 ABS (start_x - x) > THRESHOLD ||
3676 ABS (start_y - y) > THRESHOLD;
3680 definitely_within_item (GtkWidget *widget,
3684 GdkWindow *window = GTK_MENU_ITEM (widget)->priv->event_window;
3687 w = gdk_window_get_width (window);
3688 h = gdk_window_get_height (window);
3691 check_threshold (widget, 0, 0, x, y) &&
3692 check_threshold (widget, w - 1, 0, x, y) &&
3693 check_threshold (widget, w - 1, h - 1, x, y) &&
3694 check_threshold (widget, 0, h - 1, x, y);
3698 gtk_menu_has_navigation_triangle (GtkMenu *menu)
3700 GtkMenuPrivate *priv = menu->priv;
3702 return priv->navigation_height && priv->navigation_width;
3706 gtk_menu_motion_notify (GtkWidget *widget,
3707 GdkEventMotion *event)
3709 GtkWidget *menu_item;
3711 GtkMenuShell *menu_shell;
3714 gboolean need_enter;
3716 if (GTK_IS_MENU (widget))
3718 GtkMenuPrivate *priv = GTK_MENU(widget)->priv;
3720 if (priv->ignore_button_release)
3721 priv->ignore_button_release = FALSE;
3723 gtk_menu_handle_scrolling (GTK_MENU (widget), event->x_root, event->y_root,
3727 /* We received the event for one of two reasons:
3729 * a) We are the active menu, and did gtk_grab_add()
3730 * b) The widget is a child of ours, and the event was propagated
3732 * Since for computation of navigation regions, we want the menu which
3733 * is the parent of the menu item, for a), we need to find that menu,
3734 * which may be different from 'widget'.
3736 menu_item = gtk_get_event_widget ((GdkEvent*) event);
3737 parent = gtk_widget_get_parent (menu_item);
3738 if (!GTK_IS_MENU_ITEM (menu_item) ||
3739 !GTK_IS_MENU (parent))
3742 menu_shell = GTK_MENU_SHELL (parent);
3743 menu = GTK_MENU (menu_shell);
3745 if (definitely_within_item (menu_item, event->x, event->y))
3746 menu_shell->priv->activate_time = 0;
3748 need_enter = (gtk_menu_has_navigation_triangle (menu) || menu_shell->priv->ignore_enter);
3750 /* Check to see if we are within an active submenu's navigation region
3752 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
3755 /* Make sure we pop down if we enter a non-selectable menu item, so we
3756 * don't show a submenu when the cursor is outside the stay-up triangle.
3758 if (!_gtk_menu_item_is_selectable (menu_item))
3760 /* We really want to deselect, but this gives the menushell code
3761 * a chance to do some bookkeeping about the menuitem.
3763 gtk_menu_shell_select_item (menu_shell, menu_item);
3769 /* The menu is now sensitive to enter events on its items, but
3770 * was previously sensitive. So we fake an enter event.
3772 menu_shell->priv->ignore_enter = FALSE;
3774 if (event->x >= 0 && event->x < gdk_window_get_width (event->window) &&
3775 event->y >= 0 && event->y < gdk_window_get_height (event->window))
3777 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
3780 send_event->crossing.window = g_object_ref (event->window);
3781 send_event->crossing.time = event->time;
3782 send_event->crossing.send_event = TRUE;
3783 send_event->crossing.x_root = event->x_root;
3784 send_event->crossing.y_root = event->y_root;
3785 send_event->crossing.x = event->x;
3786 send_event->crossing.y = event->y;
3787 send_event->crossing.state = event->state;
3788 gdk_event_set_device (send_event, gdk_event_get_device ((GdkEvent *) event));
3790 /* We send the event to 'widget', the currently active menu,
3791 * instead of 'menu', the menu that the pointer is in. This
3792 * will ensure that the event will be ignored unless the
3793 * menuitem is a child of the active menu or some parent
3794 * menu of the active menu.
3796 result = gtk_widget_event (widget, send_event);
3797 gdk_event_free (send_event);
3807 get_double_arrows (GtkMenu *menu)
3809 GtkMenuPrivate *priv = menu->priv;
3810 gboolean double_arrows;
3811 GtkArrowPlacement arrow_placement;
3813 gtk_widget_style_get (GTK_WIDGET (menu),
3814 "double-arrows", &double_arrows,
3815 "arrow-placement", &arrow_placement,
3818 if (arrow_placement != GTK_ARROWS_BOTH)
3821 return double_arrows || (priv->initially_pushed_in &&
3822 priv->scroll_offset != 0);
3826 gtk_menu_scroll_by (GtkMenu *menu,
3829 GtkMenuPrivate *priv = menu->priv;
3830 GtkBorder arrow_border;
3834 gboolean double_arrows;
3836 widget = GTK_WIDGET (menu);
3837 offset = priv->scroll_offset + step;
3839 get_arrows_border (menu, &arrow_border);
3841 double_arrows = get_double_arrows (menu);
3843 /* If we scroll upward and the non-visible top part
3844 * is smaller than the scroll arrow it would be
3845 * pretty stupid to show the arrow and taking more
3846 * screen space than just scrolling to the top.
3849 if ((step < 0) && (offset < arrow_border.top))
3852 /* Don't scroll over the top if we weren't before: */
3853 if ((priv->scroll_offset >= 0) && (offset < 0))
3856 view_height = gdk_window_get_height (gtk_widget_get_window (widget));
3858 if (priv->scroll_offset == 0 &&
3859 view_height >= priv->requested_height)
3862 /* Don't scroll past the bottom if we weren't before: */
3863 if (priv->scroll_offset > 0)
3864 view_height -= arrow_border.top;
3866 /* When both arrows are always shown,
3867 * reduce view height even more.
3870 view_height -= arrow_border.bottom;
3872 if ((priv->scroll_offset + view_height <= priv->requested_height) &&
3873 (offset + view_height > priv->requested_height))
3874 offset = priv->requested_height - view_height;
3876 if (offset != priv->scroll_offset)
3877 gtk_menu_scroll_to (menu, offset);
3881 gtk_menu_do_timeout_scroll (GtkMenu *menu,
3882 gboolean touchscreen_mode)
3884 GtkMenuPrivate *priv = menu->priv;
3885 gboolean upper_visible;
3886 gboolean lower_visible;
3888 upper_visible = priv->upper_arrow_visible;
3889 lower_visible = priv->lower_arrow_visible;
3891 gtk_menu_scroll_by (menu, priv->scroll_step);
3893 if (touchscreen_mode &&
3894 (upper_visible != priv->upper_arrow_visible ||
3895 lower_visible != priv->lower_arrow_visible))
3897 /* We are about to hide a scroll arrow while the mouse is pressed,
3898 * this would cause the uncovered menu item to be activated on button
3899 * release. Therefore we need to ignore button release here
3901 GTK_MENU_SHELL (menu)->priv->ignore_enter = TRUE;
3902 priv->ignore_button_release = TRUE;
3907 gtk_menu_scroll_timeout (gpointer data)
3910 gboolean touchscreen_mode;
3912 menu = GTK_MENU (data);
3914 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3915 "gtk-touchscreen-mode", &touchscreen_mode,
3918 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3924 gtk_menu_scroll_timeout_initial (gpointer data)
3928 gboolean touchscreen_mode;
3930 menu = GTK_MENU (data);
3932 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3933 "gtk-timeout-repeat", &timeout,
3934 "gtk-touchscreen-mode", &touchscreen_mode,
3937 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3939 gtk_menu_remove_scroll_timeout (menu);
3941 menu->priv->scroll_timeout =
3942 gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout, menu);
3948 gtk_menu_start_scrolling (GtkMenu *menu)
3951 gboolean touchscreen_mode;
3953 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3954 "gtk-timeout-repeat", &timeout,
3955 "gtk-touchscreen-mode", &touchscreen_mode,
3958 gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3960 menu->priv->scroll_timeout =
3961 gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout_initial, menu);
3965 gtk_menu_scroll (GtkWidget *widget,
3966 GdkEventScroll *event)
3968 GtkMenu *menu = GTK_MENU (widget);
3970 switch (event->direction)
3972 case GDK_SCROLL_RIGHT:
3973 case GDK_SCROLL_DOWN:
3974 gtk_menu_scroll_by (menu, MENU_SCROLL_STEP2);
3976 case GDK_SCROLL_LEFT:
3978 gtk_menu_scroll_by (menu, - MENU_SCROLL_STEP2);
3986 get_arrows_sensitive_area (GtkMenu *menu,
3987 GdkRectangle *upper,
3988 GdkRectangle *lower)
3990 GtkArrowPlacement arrow_placement;
3991 GtkWidget *widget = GTK_WIDGET (menu);
3995 guint vertical_padding;
3997 gint scroll_arrow_height;
3998 GtkStyleContext *context;
3999 GtkStateFlags state;
4002 window = gtk_widget_get_window (widget);
4003 width = gdk_window_get_width (window);
4004 height = gdk_window_get_height (window);
4006 gtk_widget_style_get (widget,
4007 "vertical-padding", &vertical_padding,
4008 "scroll-arrow-vlength", &scroll_arrow_height,
4009 "arrow-placement", &arrow_placement,
4012 border = gtk_container_get_border_width (GTK_CONTAINER (menu)) + vertical_padding;
4014 context = gtk_widget_get_style_context (widget);
4015 state = gtk_widget_get_state_flags (widget);
4016 gtk_style_context_get_padding (context, state, &padding);
4018 gdk_window_get_position (window, &win_x, &win_y);
4020 switch (arrow_placement)
4022 case GTK_ARROWS_BOTH:
4027 upper->width = width;
4028 upper->height = scroll_arrow_height + border + padding.top;
4034 lower->y = win_y + height - border - padding.bottom - scroll_arrow_height;
4035 lower->width = width;
4036 lower->height = scroll_arrow_height + border + padding.bottom;
4040 case GTK_ARROWS_START:
4045 upper->width = width / 2;
4046 upper->height = scroll_arrow_height + border + padding.top;
4051 lower->x = win_x + width / 2;
4053 lower->width = width / 2;
4054 lower->height = scroll_arrow_height + border + padding.bottom;
4058 case GTK_ARROWS_END:
4062 upper->y = win_y + height - border - scroll_arrow_height;
4063 upper->width = width / 2;
4064 upper->height = scroll_arrow_height + border + padding.top;
4069 lower->x = win_x + width / 2;
4070 lower->y = win_y + height - border - scroll_arrow_height;
4071 lower->width = width / 2;
4072 lower->height = scroll_arrow_height + border + padding.bottom;
4080 gtk_menu_handle_scrolling (GtkMenu *menu,
4086 GtkMenuPrivate *priv = menu->priv;
4087 GtkMenuShell *menu_shell;
4090 gboolean scroll_fast = FALSE;
4092 gboolean touchscreen_mode;
4094 menu_shell = GTK_MENU_SHELL (menu);
4096 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4097 "gtk-touchscreen-mode", &touchscreen_mode,
4100 gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
4105 /* upper arrow handling */
4107 get_arrows_sensitive_area (menu, &rect, NULL);
4110 if (priv->upper_arrow_visible && !priv->tearoff_active &&
4111 (x >= rect.x) && (x < rect.x + rect.width) &&
4112 (y >= rect.y) && (y < rect.y + rect.height))
4117 if (touchscreen_mode)
4118 priv->upper_arrow_prelight = in_arrow;
4120 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4122 gboolean arrow_pressed = FALSE;
4124 if (priv->upper_arrow_visible && !priv->tearoff_active)
4126 if (touchscreen_mode)
4128 if (enter && priv->upper_arrow_prelight)
4130 if (priv->scroll_timeout == 0)
4132 /* Deselect the active item so that
4133 * any submenus are popped down
4135 gtk_menu_shell_deselect (menu_shell);
4137 gtk_menu_remove_scroll_timeout (menu);
4138 priv->scroll_step = -MENU_SCROLL_STEP2; /* always fast */
4142 /* Only do stuff on click. */
4143 gtk_menu_start_scrolling (menu);
4144 arrow_pressed = TRUE;
4149 arrow_pressed = TRUE;
4154 gtk_menu_stop_scrolling (menu);
4157 else /* !touchscreen_mode */
4159 scroll_fast = (y < rect.y + MENU_SCROLL_FAST_ZONE);
4161 if (enter && in_arrow &&
4162 (!priv->upper_arrow_prelight ||
4163 priv->scroll_fast != scroll_fast))
4165 priv->upper_arrow_prelight = TRUE;
4166 priv->scroll_fast = scroll_fast;
4168 /* Deselect the active item so that
4169 * any submenus are popped down
4171 gtk_menu_shell_deselect (menu_shell);
4173 gtk_menu_remove_scroll_timeout (menu);
4174 priv->scroll_step = scroll_fast
4175 ? -MENU_SCROLL_STEP2
4176 : -MENU_SCROLL_STEP1;
4178 priv->scroll_timeout =
4179 gdk_threads_add_timeout (scroll_fast
4180 ? MENU_SCROLL_TIMEOUT2
4181 : MENU_SCROLL_TIMEOUT1,
4182 gtk_menu_scroll_timeout, menu);
4184 else if (!enter && !in_arrow && priv->upper_arrow_prelight)
4186 gtk_menu_stop_scrolling (menu);
4191 /* gtk_menu_start_scrolling() might have hit the top of the
4192 * menu, so check if the button isn't insensitive before
4193 * changing it to something else.
4195 if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4197 GtkStateFlags arrow_state = 0;
4200 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4202 if (priv->upper_arrow_prelight)
4203 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4205 if (arrow_state != priv->upper_arrow_state)
4207 priv->upper_arrow_state = arrow_state;
4209 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4215 /* lower arrow handling */
4217 get_arrows_sensitive_area (menu, NULL, &rect);
4220 if (priv->lower_arrow_visible && !priv->tearoff_active &&
4221 (x >= rect.x) && (x < rect.x + rect.width) &&
4222 (y >= rect.y) && (y < rect.y + rect.height))
4227 if (touchscreen_mode)
4228 priv->lower_arrow_prelight = in_arrow;
4230 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4232 gboolean arrow_pressed = FALSE;
4234 if (priv->lower_arrow_visible && !priv->tearoff_active)
4236 if (touchscreen_mode)
4238 if (enter && priv->lower_arrow_prelight)
4240 if (priv->scroll_timeout == 0)
4242 /* Deselect the active item so that
4243 * any submenus are popped down
4245 gtk_menu_shell_deselect (menu_shell);
4247 gtk_menu_remove_scroll_timeout (menu);
4248 priv->scroll_step = MENU_SCROLL_STEP2; /* always fast */
4252 /* Only do stuff on click. */
4253 gtk_menu_start_scrolling (menu);
4254 arrow_pressed = TRUE;
4259 arrow_pressed = TRUE;
4264 gtk_menu_stop_scrolling (menu);
4267 else /* !touchscreen_mode */
4269 scroll_fast = (y > rect.y + rect.height - MENU_SCROLL_FAST_ZONE);
4271 if (enter && in_arrow &&
4272 (!priv->lower_arrow_prelight ||
4273 priv->scroll_fast != scroll_fast))
4275 priv->lower_arrow_prelight = TRUE;
4276 priv->scroll_fast = scroll_fast;
4278 /* Deselect the active item so that
4279 * any submenus are popped down
4281 gtk_menu_shell_deselect (menu_shell);
4283 gtk_menu_remove_scroll_timeout (menu);
4284 priv->scroll_step = scroll_fast
4286 : MENU_SCROLL_STEP1;
4288 priv->scroll_timeout =
4289 gdk_threads_add_timeout (scroll_fast
4290 ? MENU_SCROLL_TIMEOUT2
4291 : MENU_SCROLL_TIMEOUT1,
4292 gtk_menu_scroll_timeout, menu);
4294 else if (!enter && !in_arrow && priv->lower_arrow_prelight)
4296 gtk_menu_stop_scrolling (menu);
4301 /* gtk_menu_start_scrolling() might have hit the bottom of the
4302 * menu, so check if the button isn't insensitive before
4303 * changing it to something else.
4305 if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4307 GtkStateFlags arrow_state = 0;
4310 arrow_state |= GTK_STATE_FLAG_ACTIVE;
4312 if (priv->lower_arrow_prelight)
4313 arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4315 if (arrow_state != priv->lower_arrow_state)
4317 priv->lower_arrow_state = arrow_state;
4319 gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4327 gtk_menu_enter_notify (GtkWidget *widget,
4328 GdkEventCrossing *event)
4330 GtkWidget *menu_item;
4332 gboolean touchscreen_mode;
4334 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4335 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4336 event->mode == GDK_CROSSING_STATE_CHANGED)
4339 g_object_get (gtk_widget_get_settings (widget),
4340 "gtk-touchscreen-mode", &touchscreen_mode,
4343 menu_item = gtk_get_event_widget ((GdkEvent*) event);
4344 if (GTK_IS_MENU (widget))
4346 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
4348 if (!menu_shell->priv->ignore_enter)
4349 gtk_menu_handle_scrolling (GTK_MENU (widget),
4350 event->x_root, event->y_root, TRUE, TRUE);
4353 if (!touchscreen_mode && GTK_IS_MENU_ITEM (menu_item))
4355 GtkWidget *menu = gtk_widget_get_parent (menu_item);
4357 if (GTK_IS_MENU (menu))
4359 GtkMenuPrivate *priv = (GTK_MENU (menu))->priv;
4360 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
4362 if (priv->seen_item_enter)
4364 /* This is the second enter we see for an item
4365 * on this menu. This means a release should always
4368 menu_shell->priv->activate_time = 0;
4370 else if ((event->detail != GDK_NOTIFY_NONLINEAR &&
4371 event->detail != GDK_NOTIFY_NONLINEAR_VIRTUAL))
4373 if (definitely_within_item (menu_item, event->x, event->y))
4375 /* This is an actual user-enter (ie. not a pop-under)
4376 * In this case, the user must either have entered
4377 * sufficiently far enough into the item, or he must move
4378 * far enough away from the enter point. (see
4379 * gtk_menu_motion_notify())
4381 menu_shell->priv->activate_time = 0;
4385 priv->seen_item_enter = TRUE;
4389 /* If this is a faked enter (see gtk_menu_motion_notify), 'widget'
4390 * will not correspond to the event widget's parent. Check to see
4391 * if we are in the parent's navigation region.
4393 parent = gtk_widget_get_parent (menu_item);
4394 if (GTK_IS_MENU_ITEM (menu_item) && GTK_IS_MENU (parent) &&
4395 gtk_menu_navigating_submenu (GTK_MENU (parent),
4396 event->x_root, event->y_root))
4399 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (widget, event);
4403 gtk_menu_leave_notify (GtkWidget *widget,
4404 GdkEventCrossing *event)
4406 GtkMenuShell *menu_shell;
4408 GtkMenuItem *menu_item;
4409 GtkWidget *event_widget;
4411 if (event->mode == GDK_CROSSING_GTK_GRAB ||
4412 event->mode == GDK_CROSSING_GTK_UNGRAB ||
4413 event->mode == GDK_CROSSING_STATE_CHANGED)
4416 menu = GTK_MENU (widget);
4417 menu_shell = GTK_MENU_SHELL (widget);
4419 if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
4422 gtk_menu_handle_scrolling (menu, event->x_root, event->y_root, FALSE, TRUE);
4424 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4426 if (!GTK_IS_MENU_ITEM (event_widget))
4429 menu_item = GTK_MENU_ITEM (event_widget);
4431 /* Here we check to see if we're leaving an active menu item
4432 * with a submenu, in which case we enter submenu navigation mode.
4434 if (menu_shell->priv->active_menu_item != NULL
4435 && menu_item->priv->submenu != NULL
4436 && menu_item->priv->submenu_placement == GTK_LEFT_RIGHT)
4438 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active)
4440 gtk_menu_set_submenu_navigation_region (menu, menu_item, event);
4443 else if (menu_item == GTK_MENU_ITEM (menu_shell->priv->active_menu_item))
4445 /* We are leaving an active menu item with nonactive submenu.
4446 * Deselect it so we don't surprise the user with by popping
4447 * up a submenu _after_ he left the item.
4449 gtk_menu_shell_deselect (menu_shell);
4454 return GTK_WIDGET_CLASS (gtk_menu_parent_class)->leave_notify_event (widget, event);
4458 gtk_menu_stop_navigating_submenu (GtkMenu *menu)
4460 GtkMenuPrivate *priv = menu->priv;
4462 priv->navigation_x = 0;
4463 priv->navigation_y = 0;
4464 priv->navigation_width = 0;
4465 priv->navigation_height = 0;
4467 if (priv->navigation_timeout)
4469 g_source_remove (priv->navigation_timeout);
4470 priv->navigation_timeout = 0;
4474 /* When the timeout is elapsed, the navigation region is destroyed
4475 * and the menuitem under the pointer (if any) is selected.
4478 gtk_menu_stop_navigating_submenu_cb (gpointer user_data)
4480 GtkMenuPopdownData *popdown_data = user_data;
4481 GtkMenu *menu = popdown_data->menu;
4482 GtkMenuPrivate *priv = menu->priv;
4483 GdkWindow *child_window;
4485 gtk_menu_stop_navigating_submenu (menu);
4487 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
4489 child_window = gdk_window_get_device_position (priv->bin_window,
4490 popdown_data->device,
4495 GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
4497 send_event->crossing.window = g_object_ref (child_window);
4498 send_event->crossing.time = GDK_CURRENT_TIME; /* Bogus */
4499 send_event->crossing.send_event = TRUE;
4500 gdk_event_set_device (send_event, popdown_data->device);
4502 GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (GTK_WIDGET (menu), (GdkEventCrossing *)send_event);
4504 gdk_event_free (send_event);
4512 gtk_menu_navigating_submenu (GtkMenu *menu,
4516 GtkMenuPrivate *priv = menu->priv;
4519 if (!gtk_menu_has_navigation_triangle (menu))
4522 width = priv->navigation_width;
4523 height = priv->navigation_height;
4525 /* Check if x/y are in the triangle spanned by the navigation parameters */
4527 /* 1) Move the coordinates so the triangle starts at 0,0 */
4528 event_x -= priv->navigation_x;
4529 event_y -= priv->navigation_y;
4531 /* 2) Ensure both legs move along the positive axis */
4543 /* 3) Check that the given coordinate is inside the triangle. The formula
4544 * is a transformed form of this formula: x/w + y/h <= 1
4546 if (event_x >= 0 && event_y >= 0 &&
4547 event_x * height + event_y * width <= width * height)
4553 gtk_menu_stop_navigating_submenu (menu);
4559 gtk_menu_set_submenu_navigation_region (GtkMenu *menu,
4560 GtkMenuItem *menu_item,
4561 GdkEventCrossing *event)
4563 GtkMenuPrivate *priv = menu->priv;
4564 gint submenu_left = 0;
4565 gint submenu_right = 0;
4566 gint submenu_top = 0;
4567 gint submenu_bottom = 0;
4569 GtkWidget *event_widget;
4570 GtkMenuPopdownData *popdown_data;
4573 g_return_if_fail (menu_item->priv->submenu != NULL);
4574 g_return_if_fail (event != NULL);
4576 event_widget = gtk_get_event_widget ((GdkEvent*) event);
4578 window = gtk_widget_get_window (menu_item->priv->submenu);
4579 gdk_window_get_origin (window, &submenu_left, &submenu_top);
4581 submenu_right = submenu_left + gdk_window_get_width (window);
4582 submenu_bottom = submenu_top + gdk_window_get_height (window);
4584 width = gdk_window_get_width (gtk_widget_get_window (event_widget));
4586 if (event->x >= 0 && event->x < width)
4590 gtk_menu_stop_navigating_submenu (menu);
4592 /* The navigation region is the triangle closest to the x/y
4593 * location of the rectangle. This is why the width or height
4596 if (menu_item->priv->submenu_direction == GTK_DIRECTION_RIGHT)
4599 priv->navigation_x = submenu_left;
4600 priv->navigation_width = event->x_root - submenu_left;
4605 priv->navigation_x = submenu_right;
4606 priv->navigation_width = event->x_root - submenu_right;
4612 priv->navigation_y = event->y_root;
4613 priv->navigation_height = submenu_top - event->y_root - NAVIGATION_REGION_OVERSHOOT;
4615 if (priv->navigation_height >= 0)
4621 priv->navigation_y = event->y_root;
4622 priv->navigation_height = submenu_bottom - event->y_root + NAVIGATION_REGION_OVERSHOOT;
4624 if (priv->navigation_height <= 0)
4628 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4629 "gtk-menu-popdown-delay", &popdown_delay,
4632 popdown_data = g_new (GtkMenuPopdownData, 1);
4633 popdown_data->menu = menu;
4634 popdown_data->device = gdk_event_get_device ((GdkEvent *) event);
4636 priv->navigation_timeout = gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
4638 gtk_menu_stop_navigating_submenu_cb,
4640 (GDestroyNotify) g_free);
4645 gtk_menu_deactivate (GtkMenuShell *menu_shell)
4649 g_return_if_fail (GTK_IS_MENU (menu_shell));
4651 parent = menu_shell->priv->parent_menu_shell;
4653 menu_shell->priv->activate_time = 0;
4654 gtk_menu_popdown (GTK_MENU (menu_shell));
4657 gtk_menu_shell_deactivate (GTK_MENU_SHELL (parent));
4661 gtk_menu_position (GtkMenu *menu,
4662 gboolean set_scroll_offset)
4664 GtkMenuPrivate *priv = menu->priv;
4666 GtkRequisition requisition;
4671 GdkScreen *pointer_screen;
4672 GdkRectangle monitor;
4675 widget = GTK_WIDGET (menu);
4677 screen = gtk_widget_get_screen (widget);
4678 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (menu));
4679 gdk_device_get_position (pointer, &pointer_screen, &x, &y);
4681 /* Get the minimum height for minimum width to figure out
4682 * the right place to popup the menu.
4684 gtk_widget_get_preferred_size (widget, &requisition, NULL);
4686 if (pointer_screen != screen)
4688 /* Pointer is on a different screen; roughly center the
4689 * menu on the screen. If someone was using multiscreen
4690 * + Xinerama together they'd probably want something
4691 * fancier; but that is likely to be vanishingly rare.
4693 x = MAX (0, (gdk_screen_get_width (screen) - requisition.width) / 2);
4694 y = MAX (0, (gdk_screen_get_height (screen) - requisition.height) / 2);
4697 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4698 priv->initially_pushed_in = FALSE;
4700 /* Set the type hint here to allow custom position functions
4701 * to set a different hint
4703 if (!gtk_widget_get_visible (priv->toplevel))
4704 gtk_window_set_type_hint (GTK_WINDOW (priv->toplevel), GDK_WINDOW_TYPE_HINT_POPUP_MENU);
4706 if (priv->position_func)
4708 (* priv->position_func) (menu, &x, &y, &priv->initially_pushed_in,
4709 priv->position_func_data);
4711 if (priv->monitor_num < 0)
4712 priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4714 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
4718 gint space_left, space_right, space_above, space_below;
4722 gboolean rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
4724 get_menu_border (widget, &border);
4726 /* The placement of popup menus horizontally works like this (with
4727 * RTL in parentheses)
4729 * - If there is enough room to the right (left) of the mouse cursor,
4730 * position the menu there.
4732 * - Otherwise, if if there is enough room to the left (right) of the
4733 * mouse cursor, position the menu there.
4735 * - Otherwise if the menu is smaller than the monitor, position it
4736 * on the side of the mouse cursor that has the most space available
4738 * - Otherwise (if there is simply not enough room for the menu on the
4739 * monitor), position it as far left (right) as possible.
4741 * Positioning in the vertical direction is similar: first try below
4742 * mouse cursor, then above.
4744 gdk_screen_get_monitor_geometry (screen, priv->monitor_num, &monitor);
4746 space_left = x - monitor.x;
4747 space_right = monitor.x + monitor.width - x - 1;
4748 space_above = y - monitor.y;
4749 space_below = monitor.y + monitor.height - y - 1;
4751 /* Position horizontally. */
4753 /* the amount of space we need to position the menu.
4754 * Note the menu is offset "thickness" pixels
4756 needed_width = requisition.width - border.left;
4758 if (needed_width <= space_left ||
4759 needed_width <= space_right)
4761 if ((rtl && needed_width <= space_left) ||
4762 (!rtl && needed_width > space_right))
4765 x = x + border.left - requisition.width + 1;
4769 /* position right */
4770 x = x - border.right;
4773 /* x is clamped on-screen further down */
4775 else if (requisition.width <= monitor.width)
4777 /* the menu is too big to fit on either side of the mouse
4778 * cursor, but smaller than the monitor. Position it on
4779 * the side that has the most space
4781 if (space_left > space_right)
4789 x = monitor.x + monitor.width - requisition.width;
4792 else /* menu is simply too big for the monitor */
4797 x = monitor.x + monitor.width - requisition.width;
4806 /* Position vertically.
4807 * The algorithm is the same as above, but simpler
4808 * because we don't have to take RTL into account.
4810 needed_height = requisition.height - border.top;
4812 if (needed_height <= space_above ||
4813 needed_height <= space_below)
4815 if (needed_height <= space_below)
4818 y = y + border.bottom - requisition.height + 1;
4820 y = CLAMP (y, monitor.y,
4821 monitor.y + monitor.height - requisition.height);
4823 else if (needed_height > space_below && needed_height > space_above)
4825 if (space_below >= space_above)
4826 y = monitor.y + monitor.height - requisition.height;
4838 if (priv->initially_pushed_in)
4840 menu_height = requisition.height;
4842 if (y + menu_height > monitor.y + monitor.height)
4844 scroll_offset -= y + menu_height - (monitor.y + monitor.height);
4845 y = (monitor.y + monitor.height) - menu_height;
4850 scroll_offset += monitor.y - y;
4855 /* FIXME: should this be done in the various position_funcs ? */
4856 x = CLAMP (x, monitor.x, MAX (monitor.x, monitor.x + monitor.width - requisition.width));
4858 if (GTK_MENU_SHELL (menu)->priv->active)
4860 priv->have_position = TRUE;
4861 priv->position_x = x;
4862 priv->position_y = y;
4865 if (y + requisition.height > monitor.y + monitor.height)
4866 requisition.height = (monitor.y + monitor.height) - y;
4870 scroll_offset += monitor.y - y;
4871 requisition.height -= monitor.y - y;
4875 if (scroll_offset > 0)
4877 GtkBorder arrow_border;
4879 get_arrows_border (menu, &arrow_border);
4880 scroll_offset += arrow_border.top;
4883 gtk_window_move (GTK_WINDOW (GTK_MENU_SHELL (menu)->priv->active ? priv->toplevel : priv->tearoff_window),
4886 if (!GTK_MENU_SHELL (menu)->priv->active)
4888 gtk_window_resize (GTK_WINDOW (priv->tearoff_window),
4889 requisition.width, requisition.height);
4892 if (set_scroll_offset)
4893 priv->scroll_offset = scroll_offset;
4897 gtk_menu_remove_scroll_timeout (GtkMenu *menu)
4899 GtkMenuPrivate *priv = menu->priv;
4901 if (priv->scroll_timeout)
4903 g_source_remove (priv->scroll_timeout);
4904 priv->scroll_timeout = 0;
4909 gtk_menu_stop_scrolling (GtkMenu *menu)
4911 GtkMenuPrivate *priv = menu->priv;
4912 gboolean touchscreen_mode;
4914 gtk_menu_remove_scroll_timeout (menu);
4916 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4917 "gtk-touchscreen-mode", &touchscreen_mode,
4920 if (!touchscreen_mode)
4922 priv->upper_arrow_prelight = FALSE;
4923 priv->lower_arrow_prelight = FALSE;
4928 gtk_menu_scroll_to (GtkMenu *menu,
4931 GtkMenuPrivate *priv = menu->priv;
4932 GtkAllocation allocation;
4933 GtkBorder arrow_border, border;
4936 gint view_width, view_height;
4939 guint vertical_padding;
4940 guint horizontal_padding;
4941 gboolean double_arrows;
4943 widget = GTK_WIDGET (menu);
4945 if (priv->tearoff_active && priv->tearoff_adjustment)
4946 gtk_adjustment_set_value (priv->tearoff_adjustment, offset);
4948 /* Move/resize the viewport according to arrows: */
4949 gtk_widget_get_allocation (widget, &allocation);
4950 view_width = allocation.width;
4951 view_height = allocation.height;
4953 gtk_widget_style_get (GTK_WIDGET (menu),
4954 "vertical-padding", &vertical_padding,
4955 "horizontal-padding", &horizontal_padding,
4958 get_menu_border (widget, &border);
4959 double_arrows = get_double_arrows (menu);
4961 border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
4963 view_width -= (2 * (border_width + horizontal_padding)) + border.left + border.right;
4964 view_height -= (2 * (border_width + vertical_padding)) + border.top + border.bottom;
4965 menu_height = priv->requested_height - (2 * (border_width + vertical_padding)) -
4966 border.top - border.bottom;
4968 x = border_width + border.left + horizontal_padding;
4969 y = border_width + border.top + vertical_padding;
4971 if (double_arrows && !priv->tearoff_active)
4973 if (view_height < menu_height ||
4974 (offset > 0 && priv->scroll_offset > 0) ||
4975 (offset < 0 && priv->scroll_offset < 0))
4977 GtkStateFlags upper_arrow_previous_state = priv->upper_arrow_state;
4978 GtkStateFlags lower_arrow_previous_state = priv->lower_arrow_state;
4980 if (!priv->upper_arrow_visible || !priv->lower_arrow_visible)
4981 gtk_widget_queue_draw (GTK_WIDGET (menu));
4983 priv->upper_arrow_visible = priv->lower_arrow_visible = TRUE;
4985 get_arrows_border (menu, &arrow_border);
4986 y += arrow_border.top;
4987 view_height -= arrow_border.top;
4988 view_height -= arrow_border.bottom;
4991 priv->upper_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
4994 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
4996 if (priv->upper_arrow_prelight)
4997 priv->upper_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4999 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
5002 if (offset >= menu_height - view_height)
5003 priv->lower_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
5006 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
5008 if (priv->lower_arrow_prelight)
5009 priv->lower_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
5011 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
5014 if ((priv->upper_arrow_state != upper_arrow_previous_state) ||
5015 (priv->lower_arrow_state != lower_arrow_previous_state))
5016 gtk_widget_queue_draw (GTK_WIDGET (menu));
5018 if ((upper_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
5019 (priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
5021 /* At the upper border, possibly remove timeout */
5022 if (priv->scroll_step < 0)
5024 gtk_menu_stop_scrolling (menu);
5025 gtk_widget_queue_draw (GTK_WIDGET (menu));
5029 if ((lower_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
5030 (priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
5032 /* At the lower border, possibly remove timeout */
5033 if (priv->scroll_step > 0)
5035 gtk_menu_stop_scrolling (menu);
5036 gtk_widget_queue_draw (GTK_WIDGET (menu));
5040 else if (priv->upper_arrow_visible || priv->lower_arrow_visible)
5044 priv->upper_arrow_visible = priv->lower_arrow_visible = FALSE;
5045 priv->upper_arrow_prelight = priv->lower_arrow_prelight = FALSE;
5047 gtk_menu_stop_scrolling (menu);
5048 gtk_widget_queue_draw (GTK_WIDGET (menu));
5051 else if (!priv->tearoff_active)
5053 gboolean last_visible;
5055 last_visible = priv->upper_arrow_visible;
5056 priv->upper_arrow_visible = offset > 0;
5058 /* upper_arrow_visible may have changed, so requery the border */
5059 get_arrows_border (menu, &arrow_border);
5060 view_height -= arrow_border.top;
5062 if ((last_visible != priv->upper_arrow_visible) &&
5063 !priv->upper_arrow_visible)
5065 priv->upper_arrow_prelight = FALSE;
5067 /* If we hide the upper arrow, possibly remove timeout */
5068 if (priv->scroll_step < 0)
5070 gtk_menu_stop_scrolling (menu);
5071 gtk_widget_queue_draw (GTK_WIDGET (menu));
5075 last_visible = priv->lower_arrow_visible;
5076 priv->lower_arrow_visible = offset < menu_height - view_height;
5078 /* lower_arrow_visible may have changed, so requery the border */
5079 get_arrows_border (menu, &arrow_border);
5080 view_height -= arrow_border.bottom;
5082 if ((last_visible != priv->lower_arrow_visible) &&
5083 !priv->lower_arrow_visible)
5085 priv->lower_arrow_prelight = FALSE;
5087 /* If we hide the lower arrow, possibly remove timeout */
5088 if (priv->scroll_step > 0)
5090 gtk_menu_stop_scrolling (menu);
5091 gtk_widget_queue_draw (GTK_WIDGET (menu));
5095 y += arrow_border.top;
5098 /* Scroll the menu: */
5099 if (gtk_widget_get_realized (widget))
5100 gdk_window_move (priv->bin_window, 0, -offset);
5102 if (gtk_widget_get_realized (widget))
5103 gdk_window_move_resize (priv->view_window, x, y, view_width, view_height);
5105 priv->scroll_offset = offset;
5109 compute_child_offset (GtkMenu *menu,
5110 GtkWidget *menu_item,
5113 gboolean *is_last_child)
5115 GtkMenuPrivate *priv = menu->priv;
5116 gint item_top_attach;
5117 gint item_bottom_attach;
5118 gint child_offset = 0;
5121 get_effective_child_attach (menu_item, NULL, NULL,
5122 &item_top_attach, &item_bottom_attach);
5124 /* there is a possibility that we get called before _size_request,
5125 * so check the height table for safety.
5127 if (!priv->heights || priv->heights_length < gtk_menu_get_n_rows (menu))
5130 /* when we have a row with only invisible children, it's height will
5131 * be zero, so there's no need to check WIDGET_VISIBLE here
5133 for (i = 0; i < item_top_attach; i++)
5134 child_offset += priv->heights[i];
5137 *is_last_child = (item_bottom_attach == gtk_menu_get_n_rows (menu));
5139 *offset = child_offset;
5141 *height = priv->heights[item_top_attach];
5147 gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
5148 GtkWidget *menu_item)
5150 GtkMenu *menu = GTK_MENU (menu_shell);
5151 GtkMenuPrivate *priv = menu->priv;
5152 GtkWidget *widget = GTK_WIDGET (menu_shell);
5153 gint child_offset, child_height;
5157 gboolean last_child = 0;
5159 /* We need to check if the selected item fully visible.
5160 * If not we need to scroll the menu so that it becomes fully
5163 if (compute_child_offset (menu, menu_item,
5164 &child_offset, &child_height, &last_child))
5166 guint vertical_padding;
5167 gboolean double_arrows;
5168 GtkStyleContext *context;
5169 GtkStateFlags state;
5172 y = priv->scroll_offset;
5173 height = gdk_window_get_height (gtk_widget_get_window (widget));
5175 gtk_widget_style_get (widget,
5176 "vertical-padding", &vertical_padding,
5179 double_arrows = get_double_arrows (menu);
5181 context = gtk_widget_get_style_context (widget);
5182 state = gtk_widget_get_state_flags (widget);
5183 gtk_style_context_get_padding (context, state, &padding);
5185 height -= 2 * gtk_container_get_border_width (GTK_CONTAINER (menu)) +
5186 padding.top + padding.bottom +
5187 2 * vertical_padding;
5188 if (child_offset < y)
5190 /* Ignore the enter event we might get if the pointer
5193 menu_shell->priv->ignore_enter = TRUE;
5194 gtk_menu_scroll_to (menu, child_offset);
5198 GtkBorder arrow_border;
5202 get_arrows_border (menu, &arrow_border);
5203 if (!priv->tearoff_active)
5204 arrow_height = arrow_border.top + arrow_border.bottom;
5206 if (child_offset + child_height > y + height - arrow_height)
5209 if ((!last_child && !priv->tearoff_active) || double_arrows)
5210 arrow_height += arrow_border.bottom;
5212 y = child_offset + child_height - height + arrow_height;
5213 if (((y > 0) && !priv->tearoff_active) || double_arrows)
5215 /* Need upper arrow */
5216 arrow_height += arrow_border.top;
5217 y = child_offset + child_height - height + arrow_height;
5219 /* Ignore the enter event we might get if the pointer
5222 menu_shell->priv->ignore_enter = TRUE;
5223 gtk_menu_scroll_to (menu, y);
5230 gtk_menu_select_item (GtkMenuShell *menu_shell,
5231 GtkWidget *menu_item)
5233 GtkMenu *menu = GTK_MENU (menu_shell);
5235 if (gtk_widget_get_realized (GTK_WIDGET (menu)))
5236 gtk_menu_scroll_item_visible (menu_shell, menu_item);
5238 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->select_item (menu_shell, menu_item);
5242 /* Reparent the menu, taking care of the refcounting
5244 * If unrealize is true we force a unrealize while reparenting the parent.
5245 * This can help eliminate flicker in some cases.
5247 * What happens is that when the menu is unrealized and then re-realized,
5248 * the allocations are as follows:
5250 * parent - 1x1 at (0,0)
5251 * child1 - 100x20 at (0,0)
5252 * child2 - 100x20 at (0,20)
5253 * child3 - 100x20 at (0,40)
5255 * That is, the parent is small but the children are full sized. Then,
5256 * when the queued_resize gets processed, the parent gets resized to
5259 * But in order to eliminate flicker when scrolling, gdkgeometry-x11.c
5260 * contains the following logic:
5262 * - if a move or resize operation on a window would change the clip
5263 * region on the children, then before the window is resized
5264 * the background for children is temporarily set to None, the
5265 * move/resize done, and the background for the children restored.
5267 * So, at the point where the parent is resized to final size, the
5268 * background for the children is temporarily None, and thus they
5269 * are not cleared to the background color and the previous background
5270 * (the image of the menu) is left in place.
5273 gtk_menu_reparent (GtkMenu *menu,
5274 GtkWidget *new_parent,
5277 GObject *object = G_OBJECT (menu);
5278 GtkWidget *widget = GTK_WIDGET (menu);
5279 gboolean was_floating = g_object_is_floating (object);
5281 g_object_ref_sink (object);
5285 g_object_ref (object);
5286 gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (widget)), widget);
5287 gtk_container_add (GTK_CONTAINER (new_parent), widget);
5288 g_object_unref (object);
5291 gtk_widget_reparent (widget, new_parent);
5294 g_object_force_floating (object);
5296 g_object_unref (object);
5300 gtk_menu_show_all (GtkWidget *widget)
5302 /* Show children, but not self. */
5303 gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
5307 * gtk_menu_set_screen:
5309 * @screen: (allow-none): a #GdkScreen, or %NULL if the screen should be
5310 * determined by the widget the menu is attached to
5312 * Sets the #GdkScreen on which the menu will be displayed.
5317 gtk_menu_set_screen (GtkMenu *menu,
5320 g_return_if_fail (GTK_IS_MENU (menu));
5321 g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
5323 g_object_set_data (G_OBJECT (menu), I_("gtk-menu-explicit-screen"), screen);
5327 menu_change_screen (menu, screen);
5331 GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
5333 attach_widget_screen_changed (attach_widget, NULL, menu);
5340 * @child: a #GtkMenuItem
5341 * @left_attach: The column number to attach the left side of the item to
5342 * @right_attach: The column number to attach the right side of the item to
5343 * @top_attach: The row number to attach the top of the item to
5344 * @bottom_attach: The row number to attach the bottom of the item to
5346 * Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
5347 * an item will occupy is specified by @left_attach, @right_attach,
5348 * @top_attach and @bottom_attach. These each represent the leftmost,
5349 * rightmost, uppermost and lower column and row numbers of the table.
5350 * (Columns and rows are indexed from zero).
5352 * Note that this function is not related to gtk_menu_detach().
5357 gtk_menu_attach (GtkMenu *menu,
5362 guint bottom_attach)
5364 GtkMenuShell *menu_shell;
5367 g_return_if_fail (GTK_IS_MENU (menu));
5368 g_return_if_fail (GTK_IS_MENU_ITEM (child));
5369 parent = gtk_widget_get_parent (child);
5370 g_return_if_fail (parent == NULL || parent == GTK_WIDGET (menu));
5371 g_return_if_fail (left_attach < right_attach);
5372 g_return_if_fail (top_attach < bottom_attach);
5374 menu_shell = GTK_MENU_SHELL (menu);
5378 AttachInfo *ai = get_attach_info (child);
5380 ai->left_attach = left_attach;
5381 ai->right_attach = right_attach;
5382 ai->top_attach = top_attach;
5383 ai->bottom_attach = bottom_attach;
5385 menu_shell->priv->children = g_list_append (menu_shell->priv->children, child);
5387 gtk_widget_set_parent (child, GTK_WIDGET (menu));
5389 menu_queue_resize (menu);
5393 gtk_container_child_set (GTK_CONTAINER (parent), child,
5394 "left-attach", left_attach,
5395 "right-attach", right_attach,
5396 "top-attach", top_attach,
5397 "bottom-attach", bottom_attach,
5403 gtk_menu_get_popup_delay (GtkMenuShell *menu_shell)
5407 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
5408 "gtk-menu-popup-delay", &popup_delay,
5415 find_child_containing (GtkMenuShell *menu_shell,
5423 /* find a child which includes the area given by
5424 * left, right, top, bottom.
5426 for (list = menu_shell->priv->children; list; list = list->next)
5430 if (!_gtk_menu_item_is_selectable (list->data))
5433 get_effective_child_attach (list->data, &l, &r, &t, &b);
5435 if (l <= left && right <= r && t <= top && bottom <= b)
5436 return GTK_WIDGET (list->data);
5443 gtk_menu_move_current (GtkMenuShell *menu_shell,
5444 GtkMenuDirectionType direction)
5446 GtkMenu *menu = GTK_MENU (menu_shell);
5449 GtkWidget *match = NULL;
5451 if (gtk_widget_get_direction (GTK_WIDGET (menu_shell)) == GTK_TEXT_DIR_RTL)
5455 case GTK_MENU_DIR_CHILD:
5456 direction = GTK_MENU_DIR_PARENT;
5458 case GTK_MENU_DIR_PARENT:
5459 direction = GTK_MENU_DIR_CHILD;
5465 /* use special table menu key bindings */
5466 if (menu_shell->priv->active_menu_item && gtk_menu_get_n_columns (menu) > 1)
5468 get_effective_child_attach (menu_shell->priv->active_menu_item, &l, &r, &t, &b);
5470 if (direction == GTK_MENU_DIR_NEXT)
5472 for (i = b; i < gtk_menu_get_n_rows (menu); i++)
5474 match = find_child_containing (menu_shell, l, l + 1, i, i + 1);
5482 for (i = 0; i < t; i++)
5484 match = find_child_containing (menu_shell,
5485 l, l + 1, i, i + 1);
5491 else if (direction == GTK_MENU_DIR_PREV)
5493 for (i = t; i > 0; i--)
5495 match = find_child_containing (menu_shell,
5496 l, l + 1, i - 1, i);
5504 for (i = gtk_menu_get_n_rows (menu); i > b; i--)
5506 match = find_child_containing (menu_shell,
5507 l, l + 1, i - 1, i);
5513 else if (direction == GTK_MENU_DIR_PARENT)
5515 /* we go one left if possible */
5517 match = find_child_containing (menu_shell,
5518 l - 1, l, t, t + 1);
5522 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5525 || g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1)
5526 match = menu_shell->priv->active_menu_item;
5529 else if (direction == GTK_MENU_DIR_CHILD)
5531 /* we go one right if possible */
5532 if (r < gtk_menu_get_n_columns (menu))
5533 match = find_child_containing (menu_shell, r, r + 1, t, t + 1);
5537 GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5539 if (! GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu &&
5541 g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1))
5542 match = menu_shell->priv->active_menu_item;
5548 gtk_menu_shell_select_item (menu_shell, match);
5553 GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->move_current (menu_shell, direction);
5557 get_visible_size (GtkMenu *menu)
5559 GtkMenuPrivate *priv = menu->priv;
5560 GtkAllocation allocation;
5561 GtkWidget *widget = GTK_WIDGET (menu);
5562 GtkContainer *container = GTK_CONTAINER (menu);
5563 GtkStyleContext *context;
5564 GtkStateFlags state;
5568 gtk_widget_get_allocation (widget, &allocation);
5570 context = gtk_widget_get_style_context (widget);
5571 state = gtk_widget_get_state_flags (widget);
5572 gtk_style_context_get_padding (context, state, &padding);
5574 menu_height = (allocation.height -
5575 (2 * gtk_container_get_border_width (container)) -
5576 padding.top - padding.bottom);
5578 if (!priv->tearoff_active)
5580 GtkBorder arrow_border;
5582 get_arrows_border (menu, &arrow_border);
5583 menu_height -= arrow_border.top;
5584 menu_height -= arrow_border.bottom;
5590 /* Find the sensitive on-screen child containing @y, or if none,
5591 * the nearest selectable onscreen child. (%NULL if none)
5594 child_at (GtkMenu *menu,
5597 GtkMenuPrivate *priv = menu->priv;
5598 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5599 GtkWidget *child = NULL;
5600 gint child_offset = 0;
5603 gint lower, upper; /* Onscreen bounds */
5605 menu_height = get_visible_size (menu);
5606 lower = priv->scroll_offset;
5607 upper = priv->scroll_offset + menu_height;
5609 for (children = menu_shell->priv->children; children; children = children->next)
5611 if (gtk_widget_get_visible (children->data))
5613 GtkRequisition child_requisition;
5615 gtk_widget_get_preferred_size (children->data,
5616 &child_requisition, NULL);
5618 if (_gtk_menu_item_is_selectable (children->data) &&
5619 child_offset >= lower &&
5620 child_offset + child_requisition.height <= upper)
5622 child = children->data;
5624 if (child_offset + child_requisition.height > y &&
5625 !GTK_IS_TEAROFF_MENU_ITEM (child))
5629 child_offset += child_requisition.height;
5637 get_menu_height (GtkMenu *menu)
5639 GtkMenuPrivate *priv = menu->priv;
5640 GtkAllocation allocation;
5641 GtkWidget *widget = GTK_WIDGET (menu);
5642 GtkStyleContext *context;
5643 GtkStateFlags state;
5644 GtkBorder padding, border;
5647 gtk_widget_get_allocation (widget, &allocation);
5649 context = gtk_widget_get_style_context (widget);
5650 state = gtk_widget_get_state_flags (widget);
5651 gtk_style_context_get_padding (context, state, &padding);
5652 gtk_style_context_get_border (context, state, &border);
5654 height = allocation.height;
5655 height -= (gtk_container_get_border_width (GTK_CONTAINER (widget)) * 2) +
5656 padding.top + padding.bottom + border.top + border.bottom;
5658 if (!priv->tearoff_active)
5660 GtkBorder arrow_border;
5662 get_arrows_border (menu, &arrow_border);
5663 height -= arrow_border.top;
5664 height -= arrow_border.bottom;
5671 gtk_menu_real_move_scroll (GtkMenu *menu,
5674 GtkMenuPrivate *priv = menu->priv;
5675 gint page_size = get_visible_size (menu);
5676 gint end_position = get_menu_height (menu);
5677 GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5681 case GTK_SCROLL_PAGE_UP:
5682 case GTK_SCROLL_PAGE_DOWN:
5686 gint child_offset = 0;
5687 gboolean old_upper_arrow_visible;
5690 if (type == GTK_SCROLL_PAGE_UP)
5695 if (menu_shell->priv->active_menu_item)
5699 compute_child_offset (menu, menu_shell->priv->active_menu_item,
5700 &child_offset, &child_height, NULL);
5701 child_offset += child_height / 2;
5704 menu_shell->priv->ignore_enter = TRUE;
5705 old_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5706 old_offset = priv->scroll_offset;
5708 new_offset = priv->scroll_offset + step;
5709 new_offset = CLAMP (new_offset, 0, end_position - page_size);
5711 gtk_menu_scroll_to (menu, new_offset);
5713 if (menu_shell->priv->active_menu_item)
5715 GtkWidget *new_child;
5716 gboolean new_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5717 GtkBorder arrow_border;
5718 get_arrows_border (menu, &arrow_border);
5720 if (priv->scroll_offset != old_offset)
5721 step = priv->scroll_offset - old_offset;
5723 step -= (new_upper_arrow_visible - old_upper_arrow_visible) * arrow_border.top;
5725 new_child = child_at (menu, child_offset + step);
5727 gtk_menu_shell_select_item (menu_shell, new_child);
5731 case GTK_SCROLL_START:
5732 /* Ignore the enter event we might get if the pointer is on the menu */
5733 menu_shell->priv->ignore_enter = TRUE;
5734 gtk_menu_scroll_to (menu, 0);
5735 gtk_menu_shell_select_first (menu_shell, TRUE);
5737 case GTK_SCROLL_END:
5738 /* Ignore the enter event we might get if the pointer is on the menu */
5739 menu_shell->priv->ignore_enter = TRUE;
5740 gtk_menu_scroll_to (menu, end_position - page_size);
5741 _gtk_menu_shell_select_last (menu_shell, TRUE);
5750 * gtk_menu_set_monitor:
5752 * @monitor_num: the number of the monitor on which the menu should
5755 * Informs GTK+ on which monitor a menu should be popped up.
5756 * See gdk_screen_get_monitor_geometry().
5758 * This function should be called from a #GtkMenuPositionFunc
5759 * if the menu should not appear on the same monitor as the pointer.
5760 * This information can't be reliably inferred from the coordinates
5761 * returned by a #GtkMenuPositionFunc, since, for very long menus,
5762 * these coordinates may extend beyond the monitor boundaries or even
5763 * the screen boundaries.
5768 gtk_menu_set_monitor (GtkMenu *menu,
5771 GtkMenuPrivate *priv = menu->priv;
5773 g_return_if_fail (GTK_IS_MENU (menu));
5775 priv->monitor_num = monitor_num;
5779 * gtk_menu_get_monitor:
5782 * Retrieves the number of the monitor on which to show the menu.
5784 * Returns: the number of the monitor on which the menu should
5785 * be popped up or -1, if no monitor has been set
5790 gtk_menu_get_monitor (GtkMenu *menu)
5792 g_return_val_if_fail (GTK_IS_MENU (menu), -1);
5794 return menu->priv->monitor_num;
5798 * gtk_menu_get_for_attach_widget:
5799 * @widget: a #GtkWidget
5801 * Returns a list of the menus which are attached to this widget.
5802 * This list is owned by GTK+ and must not be modified.
5804 * Return value: (element-type GtkWidget) (transfer none): the list
5805 * of menus attached to his widget.
5810 gtk_menu_get_for_attach_widget (GtkWidget *widget)
5814 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5816 list = g_object_get_data (G_OBJECT (widget), ATTACHED_MENUS);
5822 gtk_menu_grab_notify (GtkWidget *widget,
5823 gboolean was_grabbed)
5825 GtkWidget *toplevel;
5826 GtkWindowGroup *group;
5830 pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (widget));
5833 !gtk_widget_device_is_shadowed (widget, pointer))
5836 toplevel = gtk_widget_get_toplevel (widget);
5838 if (!GTK_IS_WINDOW (toplevel))
5841 group = gtk_window_get_group (GTK_WINDOW (toplevel));
5842 grab = gtk_window_group_get_current_device_grab (group, pointer);
5844 if (GTK_MENU_SHELL (widget)->priv->active && !GTK_IS_MENU_SHELL (grab))
5845 gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
5849 * gtk_menu_set_reserve_toggle_size:
5851 * @reserve_toggle_size: whether to reserve size for toggles
5853 * Sets whether the menu should reserve space for drawing toggles
5854 * or icons, regardless of their actual presence.
5859 gtk_menu_set_reserve_toggle_size (GtkMenu *menu,
5860 gboolean reserve_toggle_size)
5862 GtkMenuPrivate *priv = menu->priv;
5863 gboolean no_toggle_size;
5865 g_return_if_fail (GTK_IS_MENU (menu));
5867 no_toggle_size = !reserve_toggle_size;
5869 if (priv->no_toggle_size != no_toggle_size)
5871 priv->no_toggle_size = no_toggle_size;
5873 g_object_notify (G_OBJECT (menu), "reserve-toggle-size");
5878 * gtk_menu_get_reserve_toggle_size:
5881 * Returns whether the menu reserves space for toggles and
5882 * icons, regardless of their actual presence.
5884 * Returns: Whether the menu reserves toggle space
5889 gtk_menu_get_reserve_toggle_size (GtkMenu *menu)
5891 g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
5893 return !menu->priv->no_toggle_size;