1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26 * SECTION:gtkmenushell
27 * @Title: GtkMenuShell
28 * @Short_description: A base class for menu objects
30 * A #GtkMenuShell is the abstract base class used to derive the
31 * #GtkMenu and #GtkMenuBar subclasses.
33 * A #GtkMenuShell is a container of #GtkMenuItem objects arranged
34 * in a list which can be navigated, selected, and activated by the
35 * user to perform application functions. A #GtkMenuItem can have a
36 * submenu associated with it, allowing for nested hierarchical menus.
40 #include "gtkbindings.h"
41 #include "gtkkeyhash.h"
44 #include "gtkmarshalers.h"
45 #include "gtkmenubar.h"
46 #include "gtkmenuitemprivate.h"
47 #include "gtkmenushellprivate.h"
48 #include "gtkmenuprivate.h"
49 #include "gtkmnemonichash.h"
50 #include "gtkwindow.h"
51 #include "gtkprivate.h"
54 #include "gtktypebuiltins.h"
56 #include "deprecated/gtktearoffmenuitem.h"
58 #include "a11y/gtkmenushellaccessible.h"
61 #define MENU_SHELL_TIMEOUT 500
63 #define PACK_DIRECTION(m) \
64 (GTK_IS_MENU_BAR (m) \
65 ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
66 : GTK_PACK_DIRECTION_LTR)
87 * A menu item can be "selected", this means that it is displayed
88 * in the prelight state, and if it has a submenu, that submenu
91 * A menu is "active" when it is visible onscreen and the user
92 * is selecting from it. A menubar is not active until the user
93 * clicks on one of its menuitems. When a menu is active,
94 * passing the mouse over a submenu will pop it up.
96 * menu_shell->active_menu_item, is however, not an "active"
97 * menu item (there is no such thing) but rather, the selected
98 * menu item in that MenuShell, if there is one.
100 * There is also is a concept of the current menu and a current
101 * menu item. The current menu item is the selected menu item
102 * that is furthest down in the hierarchy. (Every active menu_shell
103 * does not necessarily contain a selected menu item, but if
104 * it does, then menu_shell->parent_menu_shell must also contain
105 * a selected menu item. The current menu is the menu that
106 * contains the current menu_item. It will always have a GTK
107 * grab and receive all key presses.
112 * ::move_current (GtkMenuDirection *dir)
113 * Moves the current menu item in direction 'dir':
115 * GTK_MENU_DIR_PARENT: To the parent menu shell
116 * GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
118 * GTK_MENU_DIR_NEXT/PREV: To the next or previous item
121 * As a a bit of a hack to get movement between menus and
122 * menubars working, if submenu_placement is different for
123 * the menu and its MenuShell then the following apply:
125 * - For 'parent' the current menu is not just moved to
126 * the parent, but moved to the previous entry in the parent
127 * - For 'child', if there is no child, then current is
128 * moved to the next item in the parent.
130 * Note that the above explanation of ::move_current was written
131 * before menus and menubars had support for RTL flipping and
132 * different packing directions, and therefore only applies for
133 * when text direction and packing direction are both left-to-right.
135 * ::activate_current (GBoolean *force_hide)
136 * Activate the current item. If 'force_hide' is true, hide
137 * the current menu item always. Otherwise, only hide
138 * it if menu_item->klass->hide_on_activate is true.
141 * Cancels the current selection
145 static void gtk_menu_shell_set_property (GObject *object,
149 static void gtk_menu_shell_get_property (GObject *object,
153 static void gtk_menu_shell_realize (GtkWidget *widget);
154 static void gtk_menu_shell_finalize (GObject *object);
155 static void gtk_menu_shell_dispose (GObject *object);
156 static gint gtk_menu_shell_button_press (GtkWidget *widget,
157 GdkEventButton *event);
158 static gint gtk_menu_shell_button_release (GtkWidget *widget,
159 GdkEventButton *event);
160 static gint gtk_menu_shell_key_press (GtkWidget *widget,
162 static gint gtk_menu_shell_enter_notify (GtkWidget *widget,
163 GdkEventCrossing *event);
164 static gint gtk_menu_shell_leave_notify (GtkWidget *widget,
165 GdkEventCrossing *event);
166 static void gtk_menu_shell_screen_changed (GtkWidget *widget,
167 GdkScreen *previous_screen);
168 static gboolean gtk_menu_shell_grab_broken (GtkWidget *widget,
169 GdkEventGrabBroken *event);
170 static void gtk_menu_shell_add (GtkContainer *container,
172 static void gtk_menu_shell_remove (GtkContainer *container,
174 static void gtk_menu_shell_forall (GtkContainer *container,
175 gboolean include_internals,
176 GtkCallback callback,
177 gpointer callback_data);
178 static void gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
181 static void gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell);
182 static gint gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
184 static GtkWidget *gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
186 static GType gtk_menu_shell_child_type (GtkContainer *container);
187 static void gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
188 GtkWidget *menu_item);
189 static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell);
191 static void gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
192 GtkMenuDirectionType direction);
193 static void gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
194 gboolean force_hide);
195 static void gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell);
196 static void gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
197 GtkDirectionType dir);
199 static void gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell);
200 static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
202 static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
205 static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
207 G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
210 gtk_menu_shell_class_init (GtkMenuShellClass *klass)
212 GObjectClass *object_class;
213 GtkWidgetClass *widget_class;
214 GtkContainerClass *container_class;
216 GtkBindingSet *binding_set;
218 object_class = (GObjectClass*) klass;
219 widget_class = (GtkWidgetClass*) klass;
220 container_class = (GtkContainerClass*) klass;
222 object_class->set_property = gtk_menu_shell_set_property;
223 object_class->get_property = gtk_menu_shell_get_property;
224 object_class->finalize = gtk_menu_shell_finalize;
225 object_class->dispose = gtk_menu_shell_dispose;
227 widget_class->realize = gtk_menu_shell_realize;
228 widget_class->button_press_event = gtk_menu_shell_button_press;
229 widget_class->button_release_event = gtk_menu_shell_button_release;
230 widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
231 widget_class->key_press_event = gtk_menu_shell_key_press;
232 widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
233 widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
234 widget_class->screen_changed = gtk_menu_shell_screen_changed;
236 container_class->add = gtk_menu_shell_add;
237 container_class->remove = gtk_menu_shell_remove;
238 container_class->forall = gtk_menu_shell_forall;
239 container_class->child_type = gtk_menu_shell_child_type;
241 klass->submenu_placement = GTK_TOP_BOTTOM;
242 klass->deactivate = gtk_real_menu_shell_deactivate;
243 klass->selection_done = NULL;
244 klass->move_current = gtk_real_menu_shell_move_current;
245 klass->activate_current = gtk_real_menu_shell_activate_current;
246 klass->cancel = gtk_real_menu_shell_cancel;
247 klass->select_item = gtk_menu_shell_real_select_item;
248 klass->insert = gtk_menu_shell_real_insert;
249 klass->move_selected = gtk_menu_shell_real_move_selected;
252 * GtkMenuShell::deactivate:
253 * @menushell: the object which received the signal
255 * This signal is emitted when a menu shell is deactivated.
257 menu_shell_signals[DEACTIVATE] =
258 g_signal_new (I_("deactivate"),
259 G_OBJECT_CLASS_TYPE (object_class),
261 G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
263 _gtk_marshal_VOID__VOID,
267 * GtkMenuShell::selection-done:
268 * @menushell: the object which received the signal
270 * This signal is emitted when a selection has been
271 * completed within a menu shell.
273 menu_shell_signals[SELECTION_DONE] =
274 g_signal_new (I_("selection-done"),
275 G_OBJECT_CLASS_TYPE (object_class),
277 G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
279 _gtk_marshal_VOID__VOID,
283 * GtkMenuShell::move-current:
284 * @menushell: the object which received the signal
285 * @direction: the direction to move
287 * An keybinding signal which moves the current menu item
288 * in the direction specified by @direction.
290 menu_shell_signals[MOVE_CURRENT] =
291 g_signal_new (I_("move-current"),
292 G_OBJECT_CLASS_TYPE (object_class),
293 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
294 G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
296 _gtk_marshal_VOID__ENUM,
298 GTK_TYPE_MENU_DIRECTION_TYPE);
301 * GtkMenuShell::activate-current:
302 * @menushell: the object which received the signal
303 * @force_hide: if %TRUE, hide the menu after activating the menu item
305 * An action signal that activates the current menu item within
308 menu_shell_signals[ACTIVATE_CURRENT] =
309 g_signal_new (I_("activate-current"),
310 G_OBJECT_CLASS_TYPE (object_class),
311 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
312 G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
314 _gtk_marshal_VOID__BOOLEAN,
319 * GtkMenuShell::cancel:
320 * @menushell: the object which received the signal
322 * An action signal which cancels the selection within the menu shell.
323 * Causes the #GtkMenuShell::selection-done signal to be emitted.
325 menu_shell_signals[CANCEL] =
326 g_signal_new (I_("cancel"),
327 G_OBJECT_CLASS_TYPE (object_class),
328 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
329 G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
331 _gtk_marshal_VOID__VOID,
335 * GtkMenuShell::cycle-focus:
336 * @menushell: the object which received the signal
337 * @direction: the direction to cycle in
339 * A keybinding signal which moves the focus in the
342 menu_shell_signals[CYCLE_FOCUS] =
343 g_signal_new_class_handler (I_("cycle-focus"),
344 G_OBJECT_CLASS_TYPE (object_class),
345 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
346 G_CALLBACK (gtk_real_menu_shell_cycle_focus),
348 _gtk_marshal_VOID__ENUM,
350 GTK_TYPE_DIRECTION_TYPE);
353 * GtkMenuShell::move-selected:
354 * @menu_shell: the object on which the signal is emitted
355 * @distance: +1 to move to the next item, -1 to move to the previous
357 * The ::move-selected signal is emitted to move the selection to
360 * Returns: %TRUE to stop the signal emission, %FALSE to continue
364 menu_shell_signals[MOVE_SELECTED] =
365 g_signal_new (I_("move-selected"),
366 G_OBJECT_CLASS_TYPE (object_class),
368 G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
369 _gtk_boolean_handled_accumulator, NULL,
370 _gtk_marshal_BOOLEAN__INT,
375 * GtkMenuShell::insert:
376 * @menu_shell: the object on which the signal is emitted
377 * @child: the #GtkMenuItem that is being inserted
378 * @position: the position at which the insert occurs
380 * The ::insert signal is emitted when a new #GtkMenuItem is added to
381 * a #GtkMenuShell. A separate signal is used instead of
382 * GtkContainer::add because of the need for an additional position
385 * The inverse of this signal is the GtkContainer::removed signal.
389 menu_shell_signals[INSERT] =
390 g_signal_new (I_("insert"),
391 G_OBJECT_CLASS_TYPE (object_class),
393 G_STRUCT_OFFSET (GtkMenuShellClass, insert),
395 _gtk_marshal_VOID__OBJECT_INT,
396 G_TYPE_NONE, 2, GTK_TYPE_WIDGET, G_TYPE_INT);
399 binding_set = gtk_binding_set_by_class (klass);
400 gtk_binding_entry_add_signal (binding_set,
403 gtk_binding_entry_add_signal (binding_set,
405 "activate-current", 1,
408 gtk_binding_entry_add_signal (binding_set,
409 GDK_KEY_ISO_Enter, 0,
410 "activate-current", 1,
413 gtk_binding_entry_add_signal (binding_set,
415 "activate-current", 1,
418 gtk_binding_entry_add_signal (binding_set,
420 "activate-current", 1,
423 gtk_binding_entry_add_signal (binding_set,
425 "activate-current", 1,
428 gtk_binding_entry_add_signal (binding_set,
431 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
432 gtk_binding_entry_add_signal (binding_set,
433 GDK_KEY_F10, GDK_SHIFT_MASK,
435 GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
438 * GtkMenuShell:take-focus:
440 * A boolean that determines whether the menu and its submenus grab the
441 * keyboard focus. See gtk_menu_shell_set_take_focus() and
442 * gtk_menu_shell_get_take_focus().
446 g_object_class_install_property (object_class,
448 g_param_spec_boolean ("take-focus",
450 P_("A boolean that determines whether the menu grabs the keyboard focus"),
452 GTK_PARAM_READWRITE));
454 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_MENU_SHELL_ACCESSIBLE);
456 g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
460 gtk_menu_shell_child_type (GtkContainer *container)
462 return GTK_TYPE_MENU_ITEM;
466 gtk_menu_shell_init (GtkMenuShell *menu_shell)
468 GtkMenuShellPrivate *priv;
470 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_shell,
472 GtkMenuShellPrivate);
473 menu_shell->priv = priv;
474 priv->take_focus = TRUE;
478 gtk_menu_shell_set_property (GObject *object,
483 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
487 case PROP_TAKE_FOCUS:
488 gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
491 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
497 gtk_menu_shell_get_property (GObject *object,
502 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
506 case PROP_TAKE_FOCUS:
507 g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
510 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
516 gtk_menu_shell_finalize (GObject *object)
518 GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
519 GtkMenuShellPrivate *priv = menu_shell->priv;
521 if (priv->mnemonic_hash)
522 _gtk_mnemonic_hash_free (priv->mnemonic_hash);
524 _gtk_key_hash_free (priv->key_hash);
526 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
531 gtk_menu_shell_dispose (GObject *object)
533 gtk_menu_shell_deactivate (GTK_MENU_SHELL (object));
535 G_OBJECT_CLASS (gtk_menu_shell_parent_class)->dispose (object);
539 * gtk_menu_shell_append:
540 * @menu_shell: a #GtkMenuShell
541 * @child: The #GtkMenuItem to add
543 * Adds a new #GtkMenuItem to the end of the menu shell's
547 gtk_menu_shell_append (GtkMenuShell *menu_shell,
550 gtk_menu_shell_insert (menu_shell, child, -1);
554 * gtk_menu_shell_prepend:
555 * @menu_shell: a #GtkMenuShell
556 * @child: The #GtkMenuItem to add
558 * Adds a new #GtkMenuItem to the beginning of the menu shell's
562 gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
565 gtk_menu_shell_insert (menu_shell, child, 0);
569 * gtk_menu_shell_insert:
570 * @menu_shell: a #GtkMenuShell
571 * @child: The #GtkMenuItem to add
572 * @position: The position in the item list where @child
573 * is added. Positions are numbered from 0 to n-1
575 * Adds a new #GtkMenuItem to the menu shell's item list
576 * at the position indicated by @position.
579 gtk_menu_shell_insert (GtkMenuShell *menu_shell,
583 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
584 g_return_if_fail (GTK_IS_MENU_ITEM (child));
586 g_signal_emit (menu_shell, menu_shell_signals[INSERT], 0, child, position);
590 gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
594 GtkMenuShellPrivate *priv = menu_shell->priv;
596 priv->children = g_list_insert (priv->children, child, position);
598 gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
602 * gtk_menu_shell_deactivate:
603 * @menu_shell: a #GtkMenuShell
605 * Deactivates the menu shell.
607 * Typically this results in the menu shell being erased
611 gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
613 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
615 if (menu_shell->priv->active)
616 g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
620 gtk_menu_shell_realize (GtkWidget *widget)
622 GtkAllocation allocation;
624 GdkWindowAttr attributes;
625 gint attributes_mask;
626 GtkStyleContext *context;
628 gtk_widget_set_realized (widget, TRUE);
630 gtk_widget_get_allocation (widget, &allocation);
632 attributes.x = allocation.x;
633 attributes.y = allocation.y;
634 attributes.width = allocation.width;
635 attributes.height = allocation.height;
636 attributes.window_type = GDK_WINDOW_CHILD;
637 attributes.wclass = GDK_INPUT_OUTPUT;
638 attributes.visual = gtk_widget_get_visual (widget);
639 attributes.event_mask = gtk_widget_get_events (widget);
640 attributes.event_mask |= (GDK_EXPOSURE_MASK |
641 GDK_BUTTON_PRESS_MASK |
642 GDK_BUTTON_RELEASE_MASK |
644 GDK_ENTER_NOTIFY_MASK |
645 GDK_LEAVE_NOTIFY_MASK);
647 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
649 window = gdk_window_new (gtk_widget_get_parent_window (widget),
650 &attributes, attributes_mask);
651 gtk_widget_set_window (widget, window);
652 gtk_widget_register_window (widget, window);
654 context = gtk_widget_get_style_context (widget);
655 gtk_style_context_set_background (context, window);
659 gtk_menu_shell_activate (GtkMenuShell *menu_shell)
661 GtkMenuShellPrivate *priv = menu_shell->priv;
667 device = gtk_get_current_event_device ();
669 _gtk_menu_shell_set_grab_device (menu_shell, device);
670 gtk_device_grab_add (GTK_WIDGET (menu_shell), device, TRUE);
672 priv->have_grab = TRUE;
678 gtk_menu_shell_button_press (GtkWidget *widget,
679 GdkEventButton *event)
681 GtkMenuShell *menu_shell;
682 GtkMenuShellPrivate *priv;
683 GtkWidget *menu_item;
686 if (event->type != GDK_BUTTON_PRESS)
689 menu_shell = GTK_MENU_SHELL (widget);
690 priv = menu_shell->priv;
692 if (priv->parent_menu_shell)
693 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
695 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
697 if (menu_item && _gtk_menu_item_is_selectable (menu_item))
699 parent = gtk_widget_get_parent (menu_item);
701 if (menu_item != GTK_MENU_SHELL (parent)->priv->active_menu_item)
703 /* select the menu item *before* activating the shell, so submenus
704 * which might be open are closed the friendly way. If we activate
705 * (and thus grab) this menu shell first, we might get grab_broken
706 * events which will close the entire menu hierarchy. Selecting the
707 * menu item also fixes up the state as if enter_notify() would
708 * have run before (which normally selects the item).
710 if (GTK_MENU_SHELL_GET_CLASS (parent)->submenu_placement != GTK_TOP_BOTTOM)
711 gtk_menu_shell_select_item (GTK_MENU_SHELL (parent), menu_item);
715 if (!priv->active || !priv->button)
717 gboolean initially_active = priv->active;
719 priv->button = event->button;
723 if (_gtk_menu_item_is_selectable (menu_item) &&
724 gtk_widget_get_parent (menu_item) == widget &&
725 menu_item != priv->active_menu_item)
727 gtk_menu_shell_activate (menu_shell);
728 priv->button = event->button;
730 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
732 priv->activate_time = event->time;
733 gtk_menu_shell_select_item (menu_shell, menu_item);
739 if (!initially_active)
741 gboolean window_drag = FALSE;
743 gtk_widget_style_get (widget,
744 "window-dragging", &window_drag,
749 gtk_menu_shell_deactivate (menu_shell);
750 gtk_window_begin_move_drag (GTK_WINDOW (gtk_widget_get_toplevel (widget)),
761 widget = gtk_get_event_widget ((GdkEvent*) event);
762 if (widget == GTK_WIDGET (menu_shell))
764 gtk_menu_shell_deactivate (menu_shell);
765 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
770 _gtk_menu_item_is_selectable (menu_item) &&
771 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL &&
772 !gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
774 _gtk_menu_item_popup_submenu (menu_item, FALSE);
775 priv->activated_submenu = TRUE;
782 gtk_menu_shell_grab_broken (GtkWidget *widget,
783 GdkEventGrabBroken *event)
785 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
786 GtkMenuShellPrivate *priv = menu_shell->priv;
788 if (priv->have_xgrab && event->grab_window == NULL)
790 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
791 gtk_menu_shell_deselect (menu_shell);
792 gtk_menu_shell_deactivate (menu_shell);
793 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
800 gtk_menu_shell_button_release (GtkWidget *widget,
801 GdkEventButton *event)
803 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
804 GtkMenuShellPrivate *priv = menu_shell->priv;
808 GtkWidget *menu_item;
809 gboolean deactivate = TRUE;
811 if (priv->button && (event->button != priv->button))
814 if (priv->parent_menu_shell)
815 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
819 menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
821 if ((event->time - priv->activate_time) > MENU_SHELL_TIMEOUT)
823 if (menu_item && (priv->active_menu_item == menu_item) &&
824 _gtk_menu_item_is_selectable (menu_item))
826 GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->priv->submenu;
830 gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
833 else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
834 priv->activated_submenu)
837 GTimeVal *popup_time;
838 gint64 usec_since_popup = 0;
840 g_object_get (gtk_widget_get_settings (widget),
841 "gtk-menu-popdown-delay", &popdown_delay,
844 popup_time = g_object_get_data (G_OBJECT (submenu),
845 "gtk-menu-exact-popup-time");
849 GTimeVal current_time;
851 g_get_current_time (¤t_time);
853 usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
854 (gint64) current_time.tv_usec -
855 (gint64) popup_time->tv_sec * 1000 * 1000 -
856 (gint64) popup_time->tv_usec);
858 g_object_set_data (G_OBJECT (submenu),
859 "gtk-menu-exact-popup-time", NULL);
862 /* Only close the submenu on click if we opened the
863 * menu explicitely (usec_since_popup == 0) or
864 * enough time has passed since it was opened by
865 * GtkMenuItem's timeout (usec_since_popup > delay).
867 if (!priv->activated_submenu &&
868 (usec_since_popup == 0 ||
869 usec_since_popup > popdown_delay * 1000))
871 _gtk_menu_item_popdown_submenu (menu_item);
875 gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
881 else if (menu_item &&
882 !_gtk_menu_item_is_selectable (menu_item) &&
883 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
887 else if (priv->parent_menu_shell)
890 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
894 /* If we ended up on an item with a submenu, leave the menu up. */
896 (priv->active_menu_item == menu_item) &&
897 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
902 else /* a very fast press-release */
904 /* We only ever want to prevent deactivation on the first
905 * press/release. Setting the time to zero is a bit of a
906 * hack, since we could be being triggered in the first
907 * few fractions of a second after a server time wraparound.
908 * the chances of that happening are ~1/10^6, without
909 * serious harm if we lose.
911 priv->activate_time = 0;
917 gtk_menu_shell_deactivate (menu_shell);
918 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
921 priv->activated_submenu = FALSE;
928 _gtk_menu_shell_set_keyboard_mode (GtkMenuShell *menu_shell,
929 gboolean keyboard_mode)
931 menu_shell->priv->keyboard_mode = keyboard_mode;
935 _gtk_menu_shell_get_keyboard_mode (GtkMenuShell *menu_shell)
937 return menu_shell->priv->keyboard_mode;
941 _gtk_menu_shell_update_mnemonics (GtkMenuShell *menu_shell)
943 GtkMenuShell *target;
944 gboolean auto_mnemonics;
946 gboolean mnemonics_visible;
948 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
949 "gtk-auto-mnemonics", &auto_mnemonics,
959 GtkMenuShellPrivate *priv = target->priv;
960 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (target));
962 /* The idea with keyboard mode is that once you start using
963 * the keyboard to navigate the menus, we show mnemonics
964 * until the menu navigation is over. To that end, we spread
965 * the keyboard mode upwards in the menu hierarchy here.
966 * Also see gtk_menu_popup, where we inherit it downwards.
968 if (menu_shell->priv->keyboard_mode)
969 target->priv->keyboard_mode = TRUE;
971 /* While navigating menus, the first parent menu with an active
972 * item is the one where mnemonics are effective, as can be seen
973 * in gtk_menu_shell_key_press below.
974 * We also show mnemonics in context menus. The grab condition is
975 * necessary to ensure we remove underlines from menu bars when
978 mnemonics_visible = target->priv->keyboard_mode &&
979 (((target->priv->active_menu_item || priv->in_unselectable_item) && !found) ||
980 (target == menu_shell &&
981 !target->priv->parent_menu_shell &&
982 gtk_widget_has_grab (GTK_WIDGET (target))));
984 /* While menus are up, only show underlines inside the menubar,
985 * not in the entire window.
987 if (GTK_IS_MENU_BAR (target))
989 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), FALSE);
990 _gtk_label_mnemonics_visible_apply_recursively (GTK_WIDGET (target),
994 gtk_window_set_mnemonics_visible (GTK_WINDOW (toplevel), mnemonics_visible);
996 if (target->priv->active_menu_item || priv->in_unselectable_item)
999 target = GTK_MENU_SHELL (target->priv->parent_menu_shell);
1004 gtk_menu_shell_key_press (GtkWidget *widget,
1007 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1008 GtkMenuShellPrivate *priv = menu_shell->priv;
1009 gboolean enable_mnemonics;
1011 priv->keyboard_mode = TRUE;
1013 if (!(priv->active_menu_item || priv->in_unselectable_item) &&
1014 priv->parent_menu_shell)
1015 return gtk_widget_event (priv->parent_menu_shell, (GdkEvent *)event);
1017 if (gtk_bindings_activate_event (G_OBJECT (widget), event))
1020 g_object_get (gtk_widget_get_settings (widget),
1021 "gtk-enable-mnemonics", &enable_mnemonics,
1024 if (enable_mnemonics)
1025 return gtk_menu_shell_activate_mnemonic (menu_shell, event);
1031 gtk_menu_shell_enter_notify (GtkWidget *widget,
1032 GdkEventCrossing *event)
1034 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1035 GtkMenuShellPrivate *priv = menu_shell->priv;
1037 if (event->mode == GDK_CROSSING_GTK_GRAB ||
1038 event->mode == GDK_CROSSING_GTK_UNGRAB ||
1039 event->mode == GDK_CROSSING_STATE_CHANGED)
1044 GtkWidget *menu_item;
1047 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1052 if (GTK_IS_MENU_ITEM (menu_item) &&
1053 !_gtk_menu_item_is_selectable (menu_item))
1055 priv->in_unselectable_item = TRUE;
1059 parent = gtk_widget_get_parent (menu_item);
1060 if (parent == widget &&
1061 GTK_IS_MENU_ITEM (menu_item))
1063 if (priv->ignore_enter)
1066 if (event->detail != GDK_NOTIFY_INFERIOR)
1068 if ((gtk_widget_get_state_flags (menu_item) & GTK_STATE_FLAG_PRELIGHT) == 0)
1069 gtk_menu_shell_select_item (menu_shell, menu_item);
1071 /* If any mouse button is down, and there is a submenu
1072 * that is not yet visible, activate it. It's sufficient
1073 * to check for any button's mask (not only the one
1074 * matching menu_shell->button), because there is no
1075 * situation a mouse button could be pressed while
1076 * entering a menu item where we wouldn't want to show
1079 if ((event->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK|GDK_BUTTON3_MASK)) &&
1080 GTK_MENU_ITEM (menu_item)->priv->submenu != NULL)
1082 GTK_MENU_SHELL (parent)->priv->activated_submenu = TRUE;
1084 if (!gtk_widget_get_visible (GTK_MENU_ITEM (menu_item)->priv->submenu))
1086 GdkDevice *source_device;
1088 source_device = gdk_event_get_source_device ((GdkEvent *) event);
1090 if (gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
1091 _gtk_menu_item_popup_submenu (menu_item, TRUE);
1096 else if (priv->parent_menu_shell)
1098 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1106 gtk_menu_shell_leave_notify (GtkWidget *widget,
1107 GdkEventCrossing *event)
1109 if (event->mode == GDK_CROSSING_GTK_GRAB ||
1110 event->mode == GDK_CROSSING_GTK_UNGRAB ||
1111 event->mode == GDK_CROSSING_STATE_CHANGED)
1114 if (gtk_widget_get_visible (widget))
1116 GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
1117 GtkMenuShellPrivate *priv = menu_shell->priv;
1118 GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
1119 GtkMenuItem *menu_item;
1121 if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
1124 menu_item = GTK_MENU_ITEM (event_widget);
1126 if (!_gtk_menu_item_is_selectable (event_widget))
1128 priv->in_unselectable_item = TRUE;
1132 if ((priv->active_menu_item == event_widget) &&
1133 (menu_item->priv->submenu == NULL))
1135 if ((event->detail != GDK_NOTIFY_INFERIOR) &&
1136 (gtk_widget_get_state_flags (GTK_WIDGET (menu_item)) & GTK_STATE_FLAG_PRELIGHT) != 0)
1138 gtk_menu_shell_deselect (menu_shell);
1141 else if (priv->parent_menu_shell)
1143 gtk_widget_event (priv->parent_menu_shell, (GdkEvent*) event);
1151 gtk_menu_shell_screen_changed (GtkWidget *widget,
1152 GdkScreen *previous_screen)
1154 gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
1158 gtk_menu_shell_add (GtkContainer *container,
1161 gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
1165 gtk_menu_shell_remove (GtkContainer *container,
1168 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1169 GtkMenuShellPrivate *priv = menu_shell->priv;
1172 was_visible = gtk_widget_get_visible (widget);
1173 priv->children = g_list_remove (priv->children, widget);
1175 if (widget == priv->active_menu_item)
1177 g_signal_emit_by_name (priv->active_menu_item, "deselect");
1178 priv->active_menu_item = NULL;
1181 gtk_widget_unparent (widget);
1183 /* Queue resize regardless of gtk_widget_get_visible (container),
1184 * since that's what is needed by toplevels.
1187 gtk_widget_queue_resize (GTK_WIDGET (container));
1191 gtk_menu_shell_forall (GtkContainer *container,
1192 gboolean include_internals,
1193 GtkCallback callback,
1194 gpointer callback_data)
1196 GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
1200 children = menu_shell->priv->children;
1203 child = children->data;
1204 children = children->next;
1206 (* callback) (child, callback_data);
1212 gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
1214 GtkMenuShellPrivate *priv = menu_shell->priv;
1219 priv->active = FALSE;
1220 priv->activate_time = 0;
1222 if (priv->active_menu_item)
1224 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1225 priv->active_menu_item = NULL;
1228 if (priv->have_grab)
1230 priv->have_grab = FALSE;
1231 gtk_device_grab_remove (GTK_WIDGET (menu_shell), priv->grab_pointer);
1233 if (priv->have_xgrab)
1235 GdkDevice *keyboard;
1237 gdk_device_ungrab (priv->grab_pointer, GDK_CURRENT_TIME);
1238 keyboard = gdk_device_get_associated_device (priv->grab_pointer);
1241 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1243 priv->have_xgrab = FALSE;
1246 priv->keyboard_mode = FALSE;
1247 _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1249 _gtk_menu_shell_update_mnemonics (menu_shell);
1254 gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
1259 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1260 g_return_val_if_fail (child != NULL, FALSE);
1262 parent = gtk_widget_get_parent (child);
1263 while (GTK_IS_MENU_SHELL (parent))
1265 if (parent == (GtkWidget*) menu_shell)
1267 parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1274 gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
1277 GtkWidget *menu_item;
1279 menu_item = gtk_get_event_widget ((GdkEvent*) event);
1281 while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
1282 menu_item = gtk_widget_get_parent (menu_item);
1284 if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
1290 /* Handlers for action signals */
1293 * gtk_menu_shell_select_item:
1294 * @menu_shell: a #GtkMenuShell
1295 * @menu_item: The #GtkMenuItem to select
1297 * Selects the menu item from the menu shell.
1300 gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
1301 GtkWidget *menu_item)
1303 GtkMenuShellPrivate *priv = menu_shell->priv;
1304 GtkMenuShellClass *class;
1306 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1307 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1309 class = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1311 if (class->select_item &&
1313 priv->active_menu_item == menu_item))
1314 class->select_item (menu_shell, menu_item);
1317 void _gtk_menu_item_set_placement (GtkMenuItem *menu_item,
1318 GtkSubmenuPlacement placement);
1321 gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
1322 GtkWidget *menu_item)
1324 GtkMenuShellPrivate *priv = menu_shell->priv;
1325 GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);
1327 if (priv->active_menu_item)
1329 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1330 priv->active_menu_item = NULL;
1333 if (!_gtk_menu_item_is_selectable (menu_item))
1335 priv->in_unselectable_item = TRUE;
1336 _gtk_menu_shell_update_mnemonics (menu_shell);
1340 gtk_menu_shell_activate (menu_shell);
1342 priv->active_menu_item = menu_item;
1343 if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
1344 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1347 _gtk_menu_item_set_placement (GTK_MENU_ITEM (priv->active_menu_item),
1348 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1349 gtk_menu_item_select (GTK_MENU_ITEM (priv->active_menu_item));
1351 _gtk_menu_shell_update_mnemonics (menu_shell);
1353 /* This allows the bizarre radio buttons-with-submenus-display-history
1356 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1357 gtk_widget_activate (priv->active_menu_item);
1361 * gtk_menu_shell_deselect:
1362 * @menu_shell: a #GtkMenuShell
1364 * Deselects the currently selected item from the menu shell,
1368 gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1370 GtkMenuShellPrivate *priv = menu_shell->priv;
1372 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1374 if (priv->active_menu_item)
1376 gtk_menu_item_deselect (GTK_MENU_ITEM (priv->active_menu_item));
1377 priv->active_menu_item = NULL;
1378 _gtk_menu_shell_update_mnemonics (menu_shell);
1383 * gtk_menu_shell_activate_item:
1384 * @menu_shell: a #GtkMenuShell
1385 * @menu_item: the #GtkMenuItem to activate
1386 * @force_deactivate: if %TRUE, force the deactivation of the
1387 * menu shell after the menu item is activated
1389 * Activates the menu item within the menu shell.
1392 gtk_menu_shell_activate_item (GtkMenuShell *menu_shell,
1393 GtkWidget *menu_item,
1394 gboolean force_deactivate)
1396 GSList *slist, *shells = NULL;
1397 gboolean deactivate = force_deactivate;
1399 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1400 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
1403 deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1405 g_object_ref (menu_shell);
1406 g_object_ref (menu_item);
1410 GtkMenuShell *parent_menu_shell = menu_shell;
1414 g_object_ref (parent_menu_shell);
1415 shells = g_slist_prepend (shells, parent_menu_shell);
1416 parent_menu_shell = (GtkMenuShell*) parent_menu_shell->priv->parent_menu_shell;
1418 while (parent_menu_shell);
1419 shells = g_slist_reverse (shells);
1421 gtk_menu_shell_deactivate (menu_shell);
1423 /* Flush the x-queue, so any grabs are removed and
1424 * the menu is actually taken down
1426 gdk_display_sync (gtk_widget_get_display (menu_item));
1429 gtk_widget_activate (menu_item);
1431 for (slist = shells; slist; slist = slist->next)
1433 g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
1434 g_object_unref (slist->data);
1436 g_slist_free (shells);
1438 g_object_unref (menu_shell);
1439 g_object_unref (menu_item);
1442 /* Distance should be +/- 1 */
1444 gtk_menu_shell_real_move_selected (GtkMenuShell *menu_shell,
1447 GtkMenuShellPrivate *priv = menu_shell->priv;
1449 if (priv->active_menu_item)
1451 GList *node = g_list_find (priv->children, priv->active_menu_item);
1452 GList *start_node = node;
1453 gboolean wrap_around;
1455 g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
1456 "gtk-keynav-wrap-around", &wrap_around,
1462 while (node != start_node &&
1463 (!node || !_gtk_menu_item_is_selectable (node->data)))
1467 else if (wrap_around)
1468 node = priv->children;
1471 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1479 while (node != start_node &&
1480 (!node || !_gtk_menu_item_is_selectable (node->data)))
1484 else if (wrap_around)
1485 node = g_list_last (priv->children);
1488 gtk_widget_error_bell (GTK_WIDGET (menu_shell));
1495 gtk_menu_shell_select_item (menu_shell, node->data);
1501 /* Distance should be +/- 1 */
1503 gtk_menu_shell_move_selected (GtkMenuShell *menu_shell,
1506 gboolean handled = FALSE;
1508 g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
1509 distance, &handled);
1513 * gtk_menu_shell_select_first:
1514 * @menu_shell: a #GtkMenuShell
1515 * @search_sensitive: if %TRUE, search for the first selectable
1516 * menu item, otherwise select nothing if
1517 * the first item isn't sensitive. This
1518 * should be %FALSE if the menu is being
1519 * popped up initially.
1521 * Select the first visible or selectable child of the menu shell;
1522 * don't select tearoff items unless the only item is a tearoff
1528 gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
1529 gboolean search_sensitive)
1531 GtkMenuShellPrivate *priv = menu_shell->priv;
1532 GtkWidget *to_select = NULL;
1535 tmp_list = priv->children;
1538 GtkWidget *child = tmp_list->data;
1540 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1541 _gtk_menu_item_is_selectable (child))
1544 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1548 tmp_list = tmp_list->next;
1552 gtk_menu_shell_select_item (menu_shell, to_select);
1556 _gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
1557 gboolean search_sensitive)
1559 GtkMenuShellPrivate *priv = menu_shell->priv;
1560 GtkWidget *to_select = NULL;
1563 tmp_list = g_list_last (priv->children);
1566 GtkWidget *child = tmp_list->data;
1568 if ((!search_sensitive && gtk_widget_get_visible (child)) ||
1569 _gtk_menu_item_is_selectable (child))
1572 if (!GTK_IS_TEAROFF_MENU_ITEM (child))
1576 tmp_list = tmp_list->prev;
1580 gtk_menu_shell_select_item (menu_shell, to_select);
1584 gtk_menu_shell_select_submenu_first (GtkMenuShell *menu_shell)
1586 GtkMenuShellPrivate *priv = menu_shell->priv;
1587 GtkMenuItem *menu_item;
1589 if (priv->active_menu_item == NULL)
1592 menu_item = GTK_MENU_ITEM (priv->active_menu_item);
1594 if (menu_item->priv->submenu)
1596 _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1597 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->priv->submenu), TRUE);
1598 if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active_menu_item)
1606 gtk_real_menu_shell_move_current (GtkMenuShell *menu_shell,
1607 GtkMenuDirectionType direction)
1609 GtkMenuShellPrivate *priv = menu_shell->priv;
1610 GtkMenuShell *parent_menu_shell = NULL;
1611 gboolean had_selection;
1613 priv->in_unselectable_item = FALSE;
1615 had_selection = priv->active_menu_item != NULL;
1617 if (priv->parent_menu_shell)
1618 parent_menu_shell = GTK_MENU_SHELL (priv->parent_menu_shell);
1622 case GTK_MENU_DIR_PARENT:
1623 if (parent_menu_shell)
1625 if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1626 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1627 gtk_menu_shell_deselect (menu_shell);
1630 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1631 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1633 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1634 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1637 /* If there is no parent and the submenu is in the opposite direction
1638 * to the menu, then make the PARENT direction wrap around to
1639 * the bottom of the submenu.
1641 else if (priv->active_menu_item &&
1642 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1643 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1645 GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu);
1647 if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
1648 GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
1649 _gtk_menu_shell_select_last (submenu, TRUE);
1653 case GTK_MENU_DIR_CHILD:
1654 if (priv->active_menu_item &&
1655 _gtk_menu_item_is_selectable (priv->active_menu_item) &&
1656 GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu)
1658 if (gtk_menu_shell_select_submenu_first (menu_shell))
1662 /* Try to find a menu running the opposite direction */
1663 while (parent_menu_shell &&
1664 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
1665 GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1667 parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->priv->parent_menu_shell);
1670 if (parent_menu_shell)
1672 if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
1673 gtk_menu_shell_move_selected (parent_menu_shell, 1);
1675 gtk_menu_shell_move_selected (parent_menu_shell, -1);
1677 gtk_menu_shell_select_submenu_first (parent_menu_shell);
1681 case GTK_MENU_DIR_PREV:
1682 gtk_menu_shell_move_selected (menu_shell, -1);
1683 if (!had_selection && !priv->active_menu_item && priv->children)
1684 _gtk_menu_shell_select_last (menu_shell, TRUE);
1687 case GTK_MENU_DIR_NEXT:
1688 gtk_menu_shell_move_selected (menu_shell, 1);
1689 if (!had_selection && !priv->active_menu_item && priv->children)
1690 gtk_menu_shell_select_first (menu_shell, TRUE);
1696 gtk_real_menu_shell_activate_current (GtkMenuShell *menu_shell,
1697 gboolean force_hide)
1699 GtkMenuShellPrivate *priv = menu_shell->priv;
1701 if (priv->active_menu_item &&
1702 _gtk_menu_item_is_selectable (priv->active_menu_item))
1704 if (GTK_MENU_ITEM (priv->active_menu_item)->priv->submenu == NULL)
1705 gtk_menu_shell_activate_item (menu_shell,
1706 priv->active_menu_item,
1709 _gtk_menu_item_popup_submenu (priv->active_menu_item, FALSE);
1714 gtk_real_menu_shell_cancel (GtkMenuShell *menu_shell)
1716 /* Unset the active menu item so gtk_menu_popdown() doesn't see it. */
1717 gtk_menu_shell_deselect (menu_shell);
1718 gtk_menu_shell_deactivate (menu_shell);
1719 g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1723 gtk_real_menu_shell_cycle_focus (GtkMenuShell *menu_shell,
1724 GtkDirectionType dir)
1726 while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1728 if (menu_shell->priv->parent_menu_shell)
1729 menu_shell = GTK_MENU_SHELL (menu_shell->priv->parent_menu_shell);
1735 _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
1739 _gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
1741 GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
1743 if (klass->get_popup_delay)
1745 return klass->get_popup_delay (menu_shell);
1750 GtkWidget *widget = GTK_WIDGET (menu_shell);
1752 g_object_get (gtk_widget_get_settings (widget),
1753 "gtk-menu-popup-delay", &popup_delay,
1761 * gtk_menu_shell_cancel:
1762 * @menu_shell: a #GtkMenuShell
1764 * Cancels the selection within the menu shell.
1769 gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
1771 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1773 g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
1776 static GtkMnemonicHash *
1777 gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
1780 GtkMenuShellPrivate *priv = menu_shell->priv;
1782 if (!priv->mnemonic_hash && create)
1783 priv->mnemonic_hash = _gtk_mnemonic_hash_new ();
1785 return priv->mnemonic_hash;
1789 menu_shell_add_mnemonic_foreach (guint keyval,
1793 GtkKeyHash *key_hash = data;
1795 _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
1799 gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
1802 GtkMenuShellPrivate *priv = menu_shell->priv;
1803 GtkWidget *widget = GTK_WIDGET (menu_shell);
1805 if (!priv->key_hash && create && gtk_widget_has_screen (widget))
1807 GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1808 GdkScreen *screen = gtk_widget_get_screen (widget);
1809 GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));
1814 priv->key_hash = _gtk_key_hash_new (keymap, NULL);
1816 _gtk_mnemonic_hash_foreach (mnemonic_hash,
1817 menu_shell_add_mnemonic_foreach,
1821 return priv->key_hash;
1825 gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
1827 GtkMenuShellPrivate *priv = menu_shell->priv;
1831 _gtk_key_hash_free (priv->key_hash);
1832 priv->key_hash = NULL;
1837 gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
1840 GtkMnemonicHash *mnemonic_hash;
1841 GtkKeyHash *key_hash;
1843 gboolean result = FALSE;
1845 mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
1849 key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
1853 entries = _gtk_key_hash_lookup (key_hash,
1854 event->hardware_keycode,
1856 gtk_accelerator_get_default_mod_mask (),
1861 result = _gtk_mnemonic_hash_activate (mnemonic_hash,
1862 GPOINTER_TO_UINT (entries->data));
1863 g_slist_free (entries);
1870 _gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
1874 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1875 g_return_if_fail (GTK_IS_WIDGET (target));
1877 _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1879 gtk_menu_shell_reset_key_hash (menu_shell);
1883 _gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
1887 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1888 g_return_if_fail (GTK_IS_WIDGET (target));
1890 _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
1892 gtk_menu_shell_reset_key_hash (menu_shell);
1896 _gtk_menu_shell_set_grab_device (GtkMenuShell *menu_shell,
1899 GtkMenuShellPrivate *priv = menu_shell->priv;
1901 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1902 g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1905 priv->grab_pointer = NULL;
1906 else if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1907 priv->grab_pointer = gdk_device_get_associated_device (device);
1909 priv->grab_pointer = device;
1913 _gtk_menu_shell_get_grab_device (GtkMenuShell *menu_shell)
1915 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
1917 return menu_shell->priv->grab_pointer;
1921 * gtk_menu_shell_get_take_focus:
1922 * @menu_shell: a #GtkMenuShell
1924 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
1926 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1931 gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
1933 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
1935 return menu_shell->priv->take_focus;
1939 * gtk_menu_shell_set_take_focus:
1940 * @menu_shell: a #GtkMenuShell
1941 * @take_focus: %TRUE if the menu shell should take the keyboard
1944 * If @take_focus is %TRUE (the default) the menu shell will take
1945 * the keyboard focus so that it will receive all keyboard events
1946 * which is needed to enable keyboard navigation in menus.
1948 * Setting @take_focus to %FALSE is useful only for special applications
1949 * like virtual keyboard implementations which should not take keyboard
1952 * The @take_focus state of a menu or menu bar is automatically
1953 * propagated to submenus whenever a submenu is popped up, so you
1954 * don't have to worry about recursively setting it for your entire
1955 * menu hierarchy. Only when programmatically picking a submenu and
1956 * popping it up manually, the @take_focus property of the submenu
1957 * needs to be set explicitely.
1959 * Note that setting it to %FALSE has side-effects:
1961 * If the focus is in some other app, it keeps the focus and keynav in
1962 * the menu doesn't work. Consequently, keynav on the menu will only
1963 * work if the focus is on some toplevel owned by the onscreen keyboard.
1965 * To avoid confusing the user, menus with @take_focus set to %FALSE
1966 * should not display mnemonics or accelerators, since it cannot be
1967 * guaranteed that they will work.
1969 * See also gdk_keyboard_grab()
1974 gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
1975 gboolean take_focus)
1977 GtkMenuShellPrivate *priv = menu_shell->priv;
1979 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
1981 if (priv->take_focus != take_focus)
1983 priv->take_focus = take_focus;
1984 g_object_notify (G_OBJECT (menu_shell), "take-focus");
1989 * gtk_menu_shell_get_selected_item:
1990 * @menu_shell: a #GtkMenuShell
1992 * Gets the currently selected item.
1994 * Returns: (transfer none): the currently selected item
1999 gtk_menu_shell_get_selected_item (GtkMenuShell *menu_shell)
2001 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
2003 return menu_shell->priv->active_menu_item;
2007 * gtk_menu_shell_get_parent_shell:
2008 * @menu_shell: a #GtkMenuShell
2010 * Gets the parent menu shell.
2012 * The parent menu shell of a submenu is the #GtkMenu or #GtkMenuBar
2013 * from which it was opened up.
2015 * Returns: (transfer none): the parent #GtkMenuShell
2020 gtk_menu_shell_get_parent_shell (GtkMenuShell *menu_shell)
2022 g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), NULL);
2024 return menu_shell->priv->parent_menu_shell;