gtkmenushell.c 50.4 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27 28
#define GTK_MENU_INTERNALS

29
#include "config.h"
30 31
#include "gdk/gdkkeysyms.h"
#include "gtkbindings.h"
32
#include "gtkkeyhash.h"
Elliot Lee's avatar
Elliot Lee committed
33
#include "gtkmain.h"
34
#include "gtkmarshalers.h"
35
#include "gtkmenu.h"
36
#include "gtkmenubar.h"
Elliot Lee's avatar
Elliot Lee committed
37 38
#include "gtkmenuitem.h"
#include "gtkmenushell.h"
39
#include "gtkmnemonichash.h"
40
#include "gtktearoffmenuitem.h"
41
#include "gtkwindow.h"
42 43
#include "gtkprivate.h"
#include "gtkintl.h"
44
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
45 46 47

#define MENU_SHELL_TIMEOUT   500

48 49 50 51 52
#define PACK_DIRECTION(m)                                 \
   (GTK_IS_MENU_BAR (m)                                   \
     ? gtk_menu_bar_get_pack_direction (GTK_MENU_BAR (m)) \
     : GTK_PACK_DIRECTION_LTR)

Elliot Lee's avatar
Elliot Lee committed
53 54
enum {
  DEACTIVATE,
Tim Janik's avatar
Tim Janik committed
55
  SELECTION_DONE,
56 57 58
  MOVE_CURRENT,
  ACTIVATE_CURRENT,
  CANCEL,
59
  CYCLE_FOCUS,
60
  MOVE_SELECTED,
Elliot Lee's avatar
Elliot Lee committed
61 62 63
  LAST_SIGNAL
};

64 65 66 67 68
enum {
  PROP_0,
  PROP_TAKE_FOCUS
};

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
/* Terminology:
 * 
 * A menu item can be "selected", this means that it is displayed
 * in the prelight state, and if it has a submenu, that submenu
 * will be popped up. 
 * 
 * A menu is "active" when it is visible onscreen and the user
 * is selecting from it. A menubar is not active until the user
 * clicks on one of its menuitems. When a menu is active,
 * passing the mouse over a submenu will pop it up.
 *
 * menu_shell->active_menu_item, is however, not an "active"
 * menu item (there is no such thing) but rather, the selected
 * menu item in that MenuShell, if there is one.
 *
 * There is also is a concept of the current menu and a current
 * menu item. The current menu item is the selected menu item
 * that is furthest down in the heirarchy. (Every active menu_shell
 * does not necessarily contain a selected menu item, but if
 * it does, then menu_shell->parent_menu_shell must also contain
 * a selected menu item. The current menu is the menu that 
 * contains the current menu_item. It will always have a GTK
 * grab and receive all key presses.
 *
 *
 * Action signals:
 *
 *  ::move_current (GtkMenuDirection *dir)
 *     Moves the current menu item in direction 'dir':
 *
 *       GTK_MENU_DIR_PARENT: To the parent menu shell
 *       GTK_MENU_DIR_CHILD: To the child menu shell (if this item has
 *          a submenu.
 *       GTK_MENU_DIR_NEXT/PREV: To the next or previous item
 *          in this menu.
 * 
 *     As a a bit of a hack to get movement between menus and
 *     menubars working, if submenu_placement is different for
 *     the menu and its MenuShell then the following apply:
 * 
 *       - For 'parent' the current menu is not just moved to
 *         the parent, but moved to the previous entry in the parent
 *       - For 'child', if there is no child, then current is
 *         moved to the next item in the parent.
 *
114 115 116 117
 *    Note that the above explanation of ::move_current was written
 *    before menus and menubars had support for RTL flipping and
 *    different packing directions, and therefore only applies for
 *    when text direction and packing direction are both left-to-right.
118 119 120 121 122 123 124 125 126
 * 
 *  ::activate_current (GBoolean *force_hide)
 *     Activate the current item. If 'force_hide' is true, hide
 *     the current menu item always. Otherwise, only hide
 *     it if menu_item->klass->hide_on_activate is true.
 *
 *  ::cancel ()
 *     Cancels the current selection
 */
Elliot Lee's avatar
Elliot Lee committed
127

128 129 130 131 132 133 134 135
#define GTK_MENU_SHELL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MENU_SHELL, GtkMenuShellPrivate))

typedef struct _GtkMenuShellPrivate GtkMenuShellPrivate;

struct _GtkMenuShellPrivate
{
  GtkMnemonicHash *mnemonic_hash;
  GtkKeyHash *key_hash;
136

137 138
  guint take_focus : 1;
  guint activated_submenu : 1;
139 140
};

141 142 143 144 145 146 147 148
static void gtk_menu_shell_set_property      (GObject           *object,
                                              guint              prop_id,
                                              const GValue      *value,
                                              GParamSpec        *pspec);
static void gtk_menu_shell_get_property      (GObject           *object,
                                              guint              prop_id,
                                              GValue            *value,
                                              GParamSpec        *pspec);
Elliot Lee's avatar
Elliot Lee committed
149
static void gtk_menu_shell_realize           (GtkWidget         *widget);
150
static void gtk_menu_shell_finalize          (GObject           *object);
Elliot Lee's avatar
Elliot Lee committed
151 152 153 154
static gint gtk_menu_shell_button_press      (GtkWidget         *widget,
					      GdkEventButton    *event);
static gint gtk_menu_shell_button_release    (GtkWidget         *widget,
					      GdkEventButton    *event);
155 156
static gint gtk_menu_shell_key_press         (GtkWidget	        *widget,
					      GdkEventKey       *event);
Elliot Lee's avatar
Elliot Lee committed
157 158 159 160
static gint gtk_menu_shell_enter_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
static gint gtk_menu_shell_leave_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
161 162
static void gtk_menu_shell_screen_changed    (GtkWidget         *widget,
					      GdkScreen         *previous_screen);
163 164
static gboolean gtk_menu_shell_grab_broken       (GtkWidget         *widget,
					      GdkEventGrabBroken *event);
Elliot Lee's avatar
Elliot Lee committed
165 166 167 168
static void gtk_menu_shell_add               (GtkContainer      *container,
					      GtkWidget         *widget);
static void gtk_menu_shell_remove            (GtkContainer      *container,
					      GtkWidget         *widget);
169 170
static void gtk_menu_shell_forall            (GtkContainer      *container,
					      gboolean		 include_internals,
Elliot Lee's avatar
Elliot Lee committed
171 172
					      GtkCallback        callback,
					      gpointer           callback_data);
173 174 175
static void gtk_menu_shell_real_insert       (GtkMenuShell *menu_shell,
					      GtkWidget    *child,
					      gint          position);
Elliot Lee's avatar
Elliot Lee committed
176 177 178
static void gtk_real_menu_shell_deactivate   (GtkMenuShell      *menu_shell);
static gint gtk_menu_shell_is_item           (GtkMenuShell      *menu_shell,
					      GtkWidget         *child);
Owen Taylor's avatar
Owen Taylor committed
179 180
static GtkWidget *gtk_menu_shell_get_item    (GtkMenuShell      *menu_shell,
					      GdkEvent          *event);
Manish Singh's avatar
Manish Singh committed
181
static GType    gtk_menu_shell_child_type  (GtkContainer      *container);
182 183
static void gtk_menu_shell_real_select_item  (GtkMenuShell      *menu_shell,
					      GtkWidget         *menu_item);
184
static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell   *menu_shell); 
Elliot Lee's avatar
Elliot Lee committed
185

186 187 188 189 190
static void gtk_real_menu_shell_move_current (GtkMenuShell      *menu_shell,
					      GtkMenuDirectionType direction);
static void gtk_real_menu_shell_activate_current (GtkMenuShell      *menu_shell,
						  gboolean           force_hide);
static void gtk_real_menu_shell_cancel           (GtkMenuShell      *menu_shell);
191 192
static void gtk_real_menu_shell_cycle_focus      (GtkMenuShell      *menu_shell,
						  GtkDirectionType   dir);
Elliot Lee's avatar
Elliot Lee committed
193

194 195 196
static void     gtk_menu_shell_reset_key_hash    (GtkMenuShell *menu_shell);
static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
						  GdkEventKey  *event);
197 198
static gboolean gtk_menu_shell_real_move_selected (GtkMenuShell  *menu_shell, 
						   gint           distance);
199

200
static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
201

Matthias Clasen's avatar
Matthias Clasen committed
202
G_DEFINE_ABSTRACT_TYPE (GtkMenuShell, gtk_menu_shell, GTK_TYPE_CONTAINER)
Elliot Lee's avatar
Elliot Lee committed
203 204 205 206

static void
gtk_menu_shell_class_init (GtkMenuShellClass *klass)
{
Manish Singh's avatar
Manish Singh committed
207
  GObjectClass *object_class;
Elliot Lee's avatar
Elliot Lee committed
208 209 210
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

211 212
  GtkBindingSet *binding_set;

Manish Singh's avatar
Manish Singh committed
213
  object_class = (GObjectClass*) klass;
Elliot Lee's avatar
Elliot Lee committed
214 215 216
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;

217 218
  object_class->set_property = gtk_menu_shell_set_property;
  object_class->get_property = gtk_menu_shell_get_property;
219 220
  object_class->finalize = gtk_menu_shell_finalize;

221 222 223
  widget_class->realize = gtk_menu_shell_realize;
  widget_class->button_press_event = gtk_menu_shell_button_press;
  widget_class->button_release_event = gtk_menu_shell_button_release;
224
  widget_class->grab_broken_event = gtk_menu_shell_grab_broken;
225 226 227
  widget_class->key_press_event = gtk_menu_shell_key_press;
  widget_class->enter_notify_event = gtk_menu_shell_enter_notify;
  widget_class->leave_notify_event = gtk_menu_shell_leave_notify;
228
  widget_class->screen_changed = gtk_menu_shell_screen_changed;
229 230 231 232 233 234 235 236 237 238 239 240 241 242

  container_class->add = gtk_menu_shell_add;
  container_class->remove = gtk_menu_shell_remove;
  container_class->forall = gtk_menu_shell_forall;
  container_class->child_type = gtk_menu_shell_child_type;

  klass->submenu_placement = GTK_TOP_BOTTOM;
  klass->deactivate = gtk_real_menu_shell_deactivate;
  klass->selection_done = NULL;
  klass->move_current = gtk_real_menu_shell_move_current;
  klass->activate_current = gtk_real_menu_shell_activate_current;
  klass->cancel = gtk_real_menu_shell_cancel;
  klass->select_item = gtk_menu_shell_real_select_item;
  klass->insert = gtk_menu_shell_real_insert;
243
  klass->move_selected = gtk_menu_shell_real_move_selected;
244

Elliot Lee's avatar
Elliot Lee committed
245
  menu_shell_signals[DEACTIVATE] =
Matthias Clasen's avatar
Matthias Clasen committed
246
    g_signal_new (I_("deactivate"),
Manish Singh's avatar
Manish Singh committed
247 248 249 250 251 252
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkMenuShellClass, deactivate),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
253

Tim Janik's avatar
Tim Janik committed
254
  menu_shell_signals[SELECTION_DONE] =
Matthias Clasen's avatar
Matthias Clasen committed
255
    g_signal_new (I_("selection-done"),
Manish Singh's avatar
Manish Singh committed
256 257 258 259 260 261
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkMenuShellClass, selection_done),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
262

263
  menu_shell_signals[MOVE_CURRENT] =
Matthias Clasen's avatar
Matthias Clasen committed
264
    g_signal_new (I_("move_current"),
Manish Singh's avatar
Manish Singh committed
265 266 267 268 269
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkMenuShellClass, move_current),
		  NULL, NULL,
		  _gtk_marshal_VOID__ENUM,
270
		  G_TYPE_NONE, 1,
Manish Singh's avatar
Manish Singh committed
271
		  GTK_TYPE_MENU_DIRECTION_TYPE);
272

273
  menu_shell_signals[ACTIVATE_CURRENT] =
Matthias Clasen's avatar
Matthias Clasen committed
274
    g_signal_new (I_("activate_current"),
Manish Singh's avatar
Manish Singh committed
275 276 277 278 279
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkMenuShellClass, activate_current),
		  NULL, NULL,
		  _gtk_marshal_VOID__BOOLEAN,
280
		  G_TYPE_NONE, 1,
Manish Singh's avatar
Manish Singh committed
281
		  G_TYPE_BOOLEAN);
282

283
  menu_shell_signals[CANCEL] =
Matthias Clasen's avatar
Matthias Clasen committed
284
    g_signal_new (I_("cancel"),
Manish Singh's avatar
Manish Singh committed
285 286 287 288 289 290
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkMenuShellClass, cancel),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
291

292
  menu_shell_signals[CYCLE_FOCUS] =
293 294 295 296 297 298 299 300 301
    g_signal_new_class_handler (I_("cycle_focus"),
                                G_OBJECT_CLASS_TYPE (object_class),
                                G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
                                G_CALLBACK (gtk_real_menu_shell_cycle_focus),
                                NULL, NULL,
                                _gtk_marshal_VOID__ENUM,
                                G_TYPE_NONE, 1,
                                GTK_TYPE_DIRECTION_TYPE);

Matthias Clasen's avatar
Matthias Clasen committed
302 303 304 305 306 307
  /**
   * GtkMenuShell::move-selected:
   * @menu_shell: the object on which the signal is emitted
   * @distance: +1 to move to the next item, -1 to move to the previous
   *
   * The ::move-selected signal is emitted to move the selection to
308 309
   * another item.
   *
Matthias Clasen's avatar
Matthias Clasen committed
310 311 312
   * Returns: %TRUE to stop the signal emission, %FALSE to continue
   *
   * Since: 2.12
313
   */
314 315 316 317 318 319 320 321 322
  menu_shell_signals[MOVE_SELECTED] =
    g_signal_new (I_("move_selected"),
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkMenuShellClass, move_selected),
		  _gtk_boolean_handled_accumulator, NULL,
		  _gtk_marshal_BOOLEAN__INT,
		  G_TYPE_BOOLEAN, 1,
		  G_TYPE_INT);
323 324 325 326 327 328 329 330

  binding_set = gtk_binding_set_by_class (klass);
  gtk_binding_entry_add_signal (binding_set,
				GDK_Escape, 0,
				"cancel", 0);
  gtk_binding_entry_add_signal (binding_set,
				GDK_Return, 0,
				"activate_current", 1,
Manish Singh's avatar
Manish Singh committed
331
				G_TYPE_BOOLEAN,
332
				TRUE);
333 334 335 336 337
  gtk_binding_entry_add_signal (binding_set,
				GDK_ISO_Enter, 0,
				"activate_current", 1,
				G_TYPE_BOOLEAN,
				TRUE);
338 339 340
  gtk_binding_entry_add_signal (binding_set,
				GDK_KP_Enter, 0,
				"activate_current", 1,
Manish Singh's avatar
Manish Singh committed
341
				G_TYPE_BOOLEAN,
342
				TRUE);
343 344 345
  gtk_binding_entry_add_signal (binding_set,
				GDK_space, 0,
				"activate_current", 1,
Manish Singh's avatar
Manish Singh committed
346
				G_TYPE_BOOLEAN,
347
				FALSE);
348 349 350
  gtk_binding_entry_add_signal (binding_set,
				GDK_KP_Space, 0,
				"activate_current", 1,
Manish Singh's avatar
Manish Singh committed
351
				G_TYPE_BOOLEAN,
352
				FALSE);
353
  gtk_binding_entry_add_signal (binding_set,
354
				GDK_F10, 0,
355 356 357
				"cycle_focus", 1,
                                GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_FORWARD);
  gtk_binding_entry_add_signal (binding_set,
358
				GDK_F10, GDK_SHIFT_MASK,
359 360
				"cycle_focus", 1,
                                GTK_TYPE_DIRECTION_TYPE, GTK_DIR_TAB_BACKWARD);
361

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
  /**
   * GtkMenuShell:take-focus:
   *
   * A boolean that determines whether the menu and its submenus grab the
   * keyboard focus. See gtk_menu_shell_set_take_focus() and
   * gtk_menu_shell_get_take_focus().
   *
   * Since: 2.8
   **/
  g_object_class_install_property (object_class,
                                   PROP_TAKE_FOCUS,
                                   g_param_spec_boolean ("take-focus",
							 P_("Take Focus"),
							 P_("A boolean that determines whether the menu grabs the keyboard focus"),
							 TRUE,
							 GTK_PARAM_READWRITE));

379
  g_type_class_add_private (object_class, sizeof (GtkMenuShellPrivate));
Elliot Lee's avatar
Elliot Lee committed
380 381
}

Manish Singh's avatar
Manish Singh committed
382
static GType
383 384 385 386 387
gtk_menu_shell_child_type (GtkContainer     *container)
{
  return GTK_TYPE_MENU_ITEM;
}

Elliot Lee's avatar
Elliot Lee committed
388 389 390
static void
gtk_menu_shell_init (GtkMenuShell *menu_shell)
{
391 392
  GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

Elliot Lee's avatar
Elliot Lee committed
393 394 395 396 397 398 399 400
  menu_shell->children = NULL;
  menu_shell->active_menu_item = NULL;
  menu_shell->parent_menu_shell = NULL;
  menu_shell->active = FALSE;
  menu_shell->have_grab = FALSE;
  menu_shell->have_xgrab = FALSE;
  menu_shell->button = 0;
  menu_shell->activate_time = 0;
401 402 403

  priv->mnemonic_hash = NULL;
  priv->key_hash = NULL;
404
  priv->take_focus = TRUE;
405
  priv->activated_submenu = FALSE;
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
}

static void
gtk_menu_shell_set_property (GObject      *object,
                             guint         prop_id,
                             const GValue *value,
                             GParamSpec   *pspec)
{
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);

  switch (prop_id)
    {
    case PROP_TAKE_FOCUS:
      gtk_menu_shell_set_take_focus (menu_shell, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_menu_shell_get_property (GObject     *object,
                             guint        prop_id,
                             GValue      *value,
                             GParamSpec  *pspec)
{
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);

  switch (prop_id)
    {
    case PROP_TAKE_FOCUS:
      g_value_set_boolean (value, gtk_menu_shell_get_take_focus (menu_shell));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
Elliot Lee's avatar
Elliot Lee committed
444 445
}

446 447 448 449 450 451 452 453 454 455 456
static void
gtk_menu_shell_finalize (GObject *object)
{
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (object);
  GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

  if (priv->mnemonic_hash)
    _gtk_mnemonic_hash_free (priv->mnemonic_hash);
  if (priv->key_hash)
    _gtk_key_hash_free (priv->key_hash);

Matthias Clasen's avatar
Matthias Clasen committed
457
  G_OBJECT_CLASS (gtk_menu_shell_parent_class)->finalize (object);
458 459 460
}


Elliot Lee's avatar
Elliot Lee committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
void
gtk_menu_shell_append (GtkMenuShell *menu_shell,
		       GtkWidget    *child)
{
  gtk_menu_shell_insert (menu_shell, child, -1);
}

void
gtk_menu_shell_prepend (GtkMenuShell *menu_shell,
			GtkWidget    *child)
{
  gtk_menu_shell_insert (menu_shell, child, 0);
}

void
gtk_menu_shell_insert (GtkMenuShell *menu_shell,
		       GtkWidget    *child,
		       gint          position)
{
480 481
  GtkMenuShellClass *class;

Elliot Lee's avatar
Elliot Lee committed
482 483 484
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_MENU_ITEM (child));

485 486 487 488 489 490 491 492 493 494 495
  class = GTK_MENU_SHELL_GET_CLASS (menu_shell);

  if (class->insert)
    class->insert (menu_shell, child, position);
}

static void
gtk_menu_shell_real_insert (GtkMenuShell *menu_shell,
			    GtkWidget    *child,
			    gint          position)
{
496 497
  menu_shell->children = g_list_insert (menu_shell->children, child, position);

Elliot Lee's avatar
Elliot Lee committed
498 499 500 501 502 503 504 505
  gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));
}

void
gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
{
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));

Manish Singh's avatar
Manish Singh committed
506
  g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
Elliot Lee's avatar
Elliot Lee committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
}

static void
gtk_menu_shell_realize (GtkWidget *widget)
{
  GdkWindowAttr attributes;
  gint attributes_mask;

  GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);

  attributes.x = widget->allocation.x;
  attributes.y = widget->allocation.y;
  attributes.width = widget->allocation.width;
  attributes.height = widget->allocation.height;
  attributes.window_type = GDK_WINDOW_CHILD;
  attributes.wclass = GDK_INPUT_OUTPUT;
  attributes.visual = gtk_widget_get_visual (widget);
  attributes.colormap = gtk_widget_get_colormap (widget);
  attributes.event_mask = gtk_widget_get_events (widget);
  attributes.event_mask |= (GDK_EXPOSURE_MASK |
			    GDK_BUTTON_PRESS_MASK |
			    GDK_BUTTON_RELEASE_MASK |
529
			    GDK_KEY_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
530 531 532 533
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

  attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
534
  widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
Elliot Lee's avatar
Elliot Lee committed
535 536 537 538 539 540
  gdk_window_set_user_data (widget->window, widget);

  widget->style = gtk_style_attach (widget->style, widget->window);
  gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
}

541 542 543 544 545 546 547 548 549 550 551
void
_gtk_menu_shell_activate (GtkMenuShell *menu_shell)
{
  if (!menu_shell->active)
    {
      gtk_grab_add (GTK_WIDGET (menu_shell));
      menu_shell->have_grab = TRUE;
      menu_shell->active = TRUE;
    }
}

Elliot Lee's avatar
Elliot Lee committed
552 553 554 555 556 557 558 559 560 561 562 563 564
static gint
gtk_menu_shell_button_press (GtkWidget      *widget,
			     GdkEventButton *event)
{
  GtkMenuShell *menu_shell;
  GtkWidget *menu_item;

  if (event->type != GDK_BUTTON_PRESS)
    return FALSE;

  menu_shell = GTK_MENU_SHELL (widget);

  if (menu_shell->parent_menu_shell)
565 566 567 568 569 570
    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);

  menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);

  if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
      menu_item != GTK_MENU_SHELL (menu_item->parent)->active_menu_item)
Elliot Lee's avatar
Elliot Lee committed
571
    {
572 573 574 575 576 577 578 579 580 581 582
      /*  select the menu item *before* activating the shell, so submenus
       *  which might be open are closed the friendly way. If we activate
       *  (and thus grab) this menu shell first, we might get grab_broken
       *  events which will close the entire menu hierarchy. Selecting the
       *  menu item also fixes up the state as if enter_notify() would
       *  have run before (which normally selects the item).
       */
      if (GTK_MENU_SHELL_GET_CLASS (menu_item->parent)->submenu_placement != GTK_TOP_BOTTOM)
        {
          gtk_menu_shell_select_item (GTK_MENU_SHELL (menu_item->parent), menu_item);
        }
Elliot Lee's avatar
Elliot Lee committed
583
    }
584 585

  if (!menu_shell->active || !menu_shell->button)
Elliot Lee's avatar
Elliot Lee committed
586
    {
587
      _gtk_menu_shell_activate (menu_shell);
588

589
      menu_shell->button = event->button;
590

591 592 593 594 595 596 597 598 599 600
      if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
	  menu_item->parent == widget &&
          menu_item != menu_shell->active_menu_item)
        {
          if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
            {
              menu_shell->activate_time = event->time;
              gtk_menu_shell_select_item (menu_shell, menu_item);
            }
        }
Elliot Lee's avatar
Elliot Lee committed
601 602 603 604 605
    }
  else
    {
      widget = gtk_get_event_widget ((GdkEvent*) event);
      if (widget == GTK_WIDGET (menu_shell))
Tim Janik's avatar
Tim Janik committed
606 607
	{
	  gtk_menu_shell_deactivate (menu_shell);
Manish Singh's avatar
Manish Singh committed
608
	  g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
Tim Janik's avatar
Tim Janik committed
609
	}
Elliot Lee's avatar
Elliot Lee committed
610 611
    }

612 613 614 615 616 617 618 619 620 621 622 623
  if (menu_item && _gtk_menu_item_is_selectable (menu_item) &&
      GTK_MENU_ITEM (menu_item)->submenu != NULL &&
      !GTK_WIDGET_VISIBLE (GTK_MENU_ITEM (menu_item)->submenu))
    {
      GtkMenuShellPrivate *priv;

      _gtk_menu_item_popup_submenu (menu_item, FALSE);

      priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
      priv->activated_submenu = TRUE;
    }

Elliot Lee's avatar
Elliot Lee committed
624 625 626
  return TRUE;
}

627 628 629 630
static gboolean
gtk_menu_shell_grab_broken (GtkWidget          *widget,
			    GdkEventGrabBroken *event)
{
631
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
632

633
  if (menu_shell->have_xgrab && event->grab_window == NULL)
634
    {
635 636 637 638 639
      /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
       */
      
      gtk_menu_shell_deselect (menu_shell);
      
640 641 642 643 644 645 646
      gtk_menu_shell_deactivate (menu_shell);
      g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
    }

  return TRUE;
}

Elliot Lee's avatar
Elliot Lee committed
647 648 649 650
static gint
gtk_menu_shell_button_release (GtkWidget      *widget,
			       GdkEventButton *event)
{
651 652
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
  GtkMenuShellPrivate *priv = GTK_MENU_SHELL_GET_PRIVATE (widget);
Elliot Lee's avatar
Elliot Lee committed
653 654 655

  if (menu_shell->active)
    {
656 657 658
      GtkWidget *menu_item;
      gboolean   deactivate = TRUE;

659
      if (menu_shell->button && (event->button != menu_shell->button))
Elliot Lee's avatar
Elliot Lee committed
660
	{
661
	  menu_shell->button = 0;
Elliot Lee's avatar
Elliot Lee committed
662
	  if (menu_shell->parent_menu_shell)
663
	    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
Elliot Lee's avatar
Elliot Lee committed
664
	}
665

Elliot Lee's avatar
Elliot Lee committed
666
      menu_shell->button = 0;
Owen Taylor's avatar
Owen Taylor committed
667
      menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
668

Elliot Lee's avatar
Elliot Lee committed
669
      if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
670 671 672 673 674
        {
          if (menu_item && (menu_shell->active_menu_item == menu_item) &&
              _gtk_menu_item_is_selectable (menu_item))
            {
              GtkWidget *submenu = GTK_MENU_ITEM (menu_item)->submenu;
675

676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
              if (submenu == NULL)
                {
                  gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);

                  deactivate = FALSE;
                }
              else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM ||
                       priv->activated_submenu)
                {
                  gint popdown_delay;
                  GTimeVal *popup_time;
                  gint64 usec_since_popup = 0;

                  g_object_get (gtk_widget_get_settings (widget),
                                "gtk-menu-popdown-delay", &popdown_delay,
                                NULL);

                  popup_time = g_object_get_data (G_OBJECT (submenu),
                                                  "gtk-menu-exact-popup-time");

                  if (popup_time)
                    {
                      GTimeVal current_time;

                      g_get_current_time (&current_time);

                      usec_since_popup = ((gint64) current_time.tv_sec * 1000 * 1000 +
                                          (gint64) current_time.tv_usec -
                                          (gint64) popup_time->tv_sec * 1000 * 1000 -
                                          (gint64) popup_time->tv_usec);

                      g_object_set_data (G_OBJECT (submenu),
                                         "gtk-menu-exact-popup-time", NULL);
                    }

                  /*  only close the submenu on click if we opened the
                   *  menu explicitely (usec_since_popup == 0) or
                   *  enough time has passed since it was opened by
                   *  GtkMenuItem's timeout (usec_since_popup > delay).
                   */
                  if (!priv->activated_submenu &&
                      (usec_since_popup == 0 ||
                       usec_since_popup > popdown_delay * 1000))
                    {
                      _gtk_menu_item_popdown_submenu (menu_item);
                    }
                  else
                    {
                      gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
                    }

                  deactivate = FALSE;
                }
            }
          else if (menu_item &&
                   !_gtk_menu_item_is_selectable (menu_item) &&
                   GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
            {
              deactivate = FALSE;
            }
          else if (menu_shell->parent_menu_shell)
            {
              menu_shell->active = TRUE;
              gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
              deactivate = FALSE;
            }

          /* If we ended up on an item with a submenu, leave the menu up.
           */
          if (menu_item && (menu_shell->active_menu_item == menu_item) &&
              GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
            {
              deactivate = FALSE;
            }
        }
751
      else /* a very fast press-release */
752 753
        {
          /* We only ever want to prevent deactivation on the first
Owen Taylor's avatar
Owen Taylor committed
754
           * press/release. Setting the time to zero is a bit of a
755 756 757 758 759 760 761 762 763
           * hack, since we could be being triggered in the first
           * few fractions of a second after a server time wraparound.
           * the chances of that happening are ~1/10^6, without
           * serious harm if we lose.
           */
          menu_shell->activate_time = 0;
          deactivate = FALSE;
        }

Elliot Lee's avatar
Elliot Lee committed
764
      if (deactivate)
765 766 767 768 769 770
        {
          gtk_menu_shell_deactivate (menu_shell);
          g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
        }

      priv->activated_submenu = FALSE;
Elliot Lee's avatar
Elliot Lee committed
771 772 773 774 775
    }

  return TRUE;
}

776
static gint
777
gtk_menu_shell_key_press (GtkWidget   *widget,
778 779
			  GdkEventKey *event)
{
780
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
781
  gboolean enable_mnemonics;
782 783 784 785

  if (!menu_shell->active_menu_item && menu_shell->parent_menu_shell)
    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent *)event);
  
786
  if (gtk_bindings_activate_event (GTK_OBJECT (widget), event))
787 788
    return TRUE;

789 790 791 792 793 794 795 796
  g_object_get (gtk_widget_get_settings (widget),
		"gtk-enable-mnemonics", &enable_mnemonics,
		NULL);

  if (enable_mnemonics)
    return gtk_menu_shell_activate_mnemonic (menu_shell, event);

  return FALSE;
797 798
}

Elliot Lee's avatar
Elliot Lee committed
799 800 801 802
static gint
gtk_menu_shell_enter_notify (GtkWidget        *widget,
			     GdkEventCrossing *event)
{
803
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
804

805
  if (menu_shell->active)
Elliot Lee's avatar
Elliot Lee committed
806
    {
807 808
      GtkWidget *menu_item;

Elliot Lee's avatar
Elliot Lee committed
809 810
      menu_item = gtk_get_event_widget ((GdkEvent*) event);

811 812 813
      if (!menu_item ||
	  (GTK_IS_MENU_ITEM (menu_item) && 
	   !_gtk_menu_item_is_selectable (menu_item)))
Elliot Lee's avatar
Elliot Lee committed
814
	return TRUE;
Michael Natterer's avatar
Michael Natterer committed
815 816

      if (menu_item->parent == widget &&
Elliot Lee's avatar
Elliot Lee committed
817 818
	  GTK_IS_MENU_ITEM (menu_item))
	{
819 820
	  if (menu_shell->ignore_enter)
	    return TRUE;
Michael Natterer's avatar
Michael Natterer committed
821 822 823 824 825

	  if (event->detail != GDK_NOTIFY_INFERIOR)
            {
	      if (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT)
                gtk_menu_shell_select_item (menu_shell, menu_item);
826 827 828 829 830 831 832 833 834

              /* If any mouse button is down, and there is a submenu
               * that is not yet visible, activate it. It's sufficient
               * to check for any button's mask (not only the one
               * matching menu_shell->button), because there is no
               * situation a mouse button could be pressed while
               * entering a menu item where we wouldn't want to show
               * its submenu.
               */
835 836
              if ((event->state & (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)) &&
                  GTK_MENU_ITEM (menu_item)->submenu != NULL)
837 838 839 840
                {
                  GtkMenuShellPrivate *priv;

                  priv = GTK_MENU_SHELL_GET_PRIVATE (menu_item->parent);
841
                  priv->activated_submenu = TRUE;
842

843 844 845
                  if (!GTK_WIDGET_VISIBLE (GTK_MENU_ITEM (menu_item)->submenu))
                    {
                      gboolean touchscreen_mode;
846

847 848 849 850 851 852 853
                      g_object_get (gtk_widget_get_settings (widget),
                                    "gtk-touchscreen-mode", &touchscreen_mode,
                                    NULL);

                      if (touchscreen_mode)
                        _gtk_menu_item_popup_submenu (menu_item, TRUE);
                    }
854
                }
Elliot Lee's avatar
Elliot Lee committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
	    }
	}
      else if (menu_shell->parent_menu_shell)
	{
	  gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	}
    }

  return TRUE;
}

static gint
gtk_menu_shell_leave_notify (GtkWidget        *widget,
			     GdkEventCrossing *event)
{
  if (GTK_WIDGET_VISIBLE (widget))
    {
872 873 874
      GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
      GtkWidget *event_widget = gtk_get_event_widget ((GdkEvent*) event);
      GtkMenuItem *menu_item;
Elliot Lee's avatar
Elliot Lee committed
875

876
      if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
Elliot Lee's avatar
Elliot Lee committed
877 878 879 880
	return TRUE;

      menu_item = GTK_MENU_ITEM (event_widget);

881
      if (!_gtk_menu_item_is_selectable (event_widget))
Tim Janik's avatar
Tim Janik committed
882 883
	return TRUE;

Elliot Lee's avatar
Elliot Lee committed
884 885 886 887 888 889
      if ((menu_shell->active_menu_item == event_widget) &&
	  (menu_item->submenu == NULL))
	{
	  if ((event->detail != GDK_NOTIFY_INFERIOR) &&
	      (GTK_WIDGET_STATE (menu_item) != GTK_STATE_NORMAL))
	    {
890
	      gtk_menu_shell_deselect (menu_shell);
Elliot Lee's avatar
Elliot Lee committed
891 892 893 894 895 896 897 898 899 900 901
	    }
	}
      else if (menu_shell->parent_menu_shell)
	{
	  gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	}
    }

  return TRUE;
}

902 903 904 905 906 907 908
static void
gtk_menu_shell_screen_changed (GtkWidget *widget,
			       GdkScreen *previous_screen)
{
  gtk_menu_shell_reset_key_hash (GTK_MENU_SHELL (widget));
}

Elliot Lee's avatar
Elliot Lee committed
909 910 911 912 913 914 915 916 917 918 919
static void
gtk_menu_shell_add (GtkContainer *container,
		    GtkWidget    *widget)
{
  gtk_menu_shell_append (GTK_MENU_SHELL (container), widget);
}

static void
gtk_menu_shell_remove (GtkContainer *container,
		       GtkWidget    *widget)
{
920
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
921
  gint was_visible;
922

923
  was_visible = GTK_WIDGET_VISIBLE (widget);
Elliot Lee's avatar
Elliot Lee committed
924
  menu_shell->children = g_list_remove (menu_shell->children, widget);
925
  
926 927 928 929 930 931
  if (widget == menu_shell->active_menu_item)
    {
      gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
      menu_shell->active_menu_item = NULL;
    }

932 933
  gtk_widget_unparent (widget);
  
934 935 936 937
  /* queue resize regardless of GTK_WIDGET_VISIBLE (container),
   * since that's what is needed by toplevels.
   */
  if (was_visible)
Elliot Lee's avatar
Elliot Lee committed
938 939 940 941
    gtk_widget_queue_resize (GTK_WIDGET (container));
}

static void
942 943 944 945
gtk_menu_shell_forall (GtkContainer *container,
		       gboolean      include_internals,
		       GtkCallback   callback,
		       gpointer      callback_data)
Elliot Lee's avatar
Elliot Lee committed
946
{
947
  GtkMenuShell *menu_shell = GTK_MENU_SHELL (container);
Elliot Lee's avatar
Elliot Lee committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
  GtkWidget *child;
  GList *children;

  children = menu_shell->children;
  while (children)
    {
      child = children->data;
      children = children->next;

      (* callback) (child, callback_data);
    }
}


static void
gtk_real_menu_shell_deactivate (GtkMenuShell *menu_shell)
{
  if (menu_shell->active)
    {
      menu_shell->button = 0;
      menu_shell->active = FALSE;
969
      menu_shell->activate_time = 0;
Elliot Lee's avatar
Elliot Lee committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983

      if (menu_shell->active_menu_item)
	{
	  gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
	  menu_shell->active_menu_item = NULL;
	}

      if (menu_shell->have_grab)
	{
	  menu_shell->have_grab = FALSE;
	  gtk_grab_remove (GTK_WIDGET (menu_shell));
	}
      if (menu_shell->have_xgrab)
	{
984 985
	  GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET (menu_shell));
	  
Elliot Lee's avatar
Elliot Lee committed
986
	  menu_shell->have_xgrab = FALSE;
987 988
	  gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
	  gdk_display_keyboard_ungrab (display, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
989 990 991 992 993 994 995 996
	}
    }
}

static gint
gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
			GtkWidget    *child)
{
997
  GtkWidget *parent;
Elliot Lee's avatar
Elliot Lee committed
998 999 1000 1001

  g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);
  g_return_val_if_fail (child != NULL, FALSE);

1002
  parent = child->parent;
1003
  while (GTK_IS_MENU_SHELL (parent))
Elliot Lee's avatar
Elliot Lee committed
1004
    {
1005
      if (parent == (GtkWidget*) menu_shell)
Elliot Lee's avatar
Elliot Lee committed
1006
	return TRUE;
1007
      parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
Elliot Lee's avatar
Elliot Lee committed
1008 1009 1010 1011
    }

  return FALSE;
}
Owen Taylor's avatar
Owen Taylor committed
1012

1013
static GtkWidget*
Owen Taylor's avatar
Owen Taylor committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
gtk_menu_shell_get_item (GtkMenuShell *menu_shell,
			 GdkEvent     *event)
{
  GtkWidget *menu_item;

  menu_item = gtk_get_event_widget ((GdkEvent*) event);
  
  while (menu_item && !GTK_IS_MENU_ITEM (menu_item))
    menu_item = menu_item->parent;

  if (menu_item && gtk_menu_shell_is_item (menu_shell, menu_item))
    return menu_item;
  else
    return NULL;
}

1030 1031 1032
/* Handlers for action signals */

void
1033 1034
gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
			    GtkWidget    *menu_item)
1035
{
1036 1037
  GtkMenuShellClass *class;

1038 1039 1040
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

1041 1042
  class = GTK_MENU_SHELL_GET_CLASS (menu_shell);

1043 1044 1045
  if (class->select_item &&
      !(menu_shell->active &&
	menu_shell->active_menu_item == menu_item))
1046 1047 1048
    class->select_item (menu_shell, menu_item);
}

1049 1050
void _gtk_menu_item_set_placement (GtkMenuItem         *menu_item,
				   GtkSubmenuPlacement  placement);
1051 1052 1053 1054 1055

static void
gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
				 GtkWidget    *menu_item)
{
1056 1057
  GtkPackDirection pack_dir = PACK_DIRECTION (menu_shell);

1058
  gtk_menu_shell_deselect (menu_shell);
1059

1060 1061 1062
  if (!_gtk_menu_item_is_selectable (menu_item))
    return;

1063
  menu_shell->active_menu_item = menu_item;
1064 1065 1066 1067 1068 1069
  if (pack_dir == GTK_PACK_DIRECTION_TTB || pack_dir == GTK_PACK_DIRECTION_BTT)
    _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
				  GTK_LEFT_RIGHT);
  else
    _gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
				  GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
1070 1071 1072 1073 1074 1075 1076 1077 1078
  gtk_menu_item_select (GTK_MENU_ITEM (menu_shell->active_menu_item));

  /* This allows the bizarre radio buttons-with-submenus-display-history
   * behavior
   */
  if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
    gtk_widget_activate (menu_shell->active_menu_item);
}

1079 1080
void
gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
1081
{
1082 1083 1084 1085 1086 1087 1088
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));

  if (menu_shell->active_menu_item)
    {
      gtk_menu_item_deselect (GTK_MENU_ITEM (menu_shell->active_menu_item));
      menu_shell->active_menu_item = NULL;
    }
1089 1090 1091 1092 1093 1094 1095
}

void
gtk_menu_shell_activate_item (GtkMenuShell      *menu_shell,
			      GtkWidget         *menu_item,
			      gboolean           force_deactivate)
{
1096
  GSList *slist, *shells = NULL;
1097 1098 1099 1100 1101 1102
  gboolean deactivate = force_deactivate;

  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  if (!deactivate)
1103
    deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1104

Manish Singh's avatar
Manish Singh committed
1105
  g_object_ref (menu_shell);
1106
  g_object_ref (menu_item);
1107 1108 1109

  if (deactivate)
    {
1110 1111 1112 1113
      GtkMenuShell *parent_menu_shell = menu_shell;

      do
	{
Manish Singh's avatar
Manish Singh committed
1114
	  g_object_ref (parent_menu_shell);
1115 1116 1117 1118 1119 1120
	  shells = g_slist_prepend (shells, parent_menu_shell);
	  parent_menu_shell = (GtkMenuShell*) parent_menu_shell->parent_menu_shell;
	}
      while (parent_menu_shell);
      shells = g_slist_reverse (shells);

1121 1122 1123 1124 1125
      gtk_menu_shell_deactivate (menu_shell);
  
      /* flush the x-queue, so any grabs are removed and
       * the menu is actually taken down
       */
1126
      gdk_display_sync (gtk_widget_get_display (menu_item));
1127
    }
1128

1129 1130
  gtk_widget_activate (menu_item);

1131 1132
  for (slist = shells; slist; slist = slist->next)
    {
Manish Singh's avatar
Manish Singh committed
1133 1134
      g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
      g_object_unref (slist->data);
1135 1136 1137
    }
  g_slist_free (shells);

Manish Singh's avatar
Manish Singh committed
1138
  g_object_unref (menu_shell);
1139
  g_object_unref (menu_item);
1140 1141 1142
}

/* Distance should be +/- 1 */
1143 1144 1145
static gboolean
gtk_menu_shell_real_move_selected (GtkMenuShell  *menu_shell, 
				   gint           distance)
1146 1147 1148 1149 1150 1151
{
  if (menu_shell->active_menu_item)
    {
      GList *node = g_list_find (menu_shell->children,
				 menu_shell->active_menu_item);
      GList *start_node = node;
1152 1153 1154 1155 1156 1157
      gboolean wrap_around;

      g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
                    "gtk-keynav-wrap-around", &wrap_around,
                    NULL);

1158 1159 1160 1161
      if (distance > 0)
	{
	  node = node->next;
	  while (node != start_node && 
1162
		 (!node || !_gtk_menu_item_is_selectable (node->data)))
1163
	    {
1164
	      if (node)
1165
		node = node->next;
1166 1167 1168 1169 1170 1171 1172
              else if (wrap_around)
		node = menu_shell->children;
              else
                {
                  gtk_widget_error_bell (GTK_WIDGET (menu_shell));
                  break;
                }
1173 1174 1175 1176 1177 1178
	    }
	}
      else
	{
	  node = node->prev;
	  while (node != start_node &&
1179
		 (!node || !_gtk_menu_item_is_selectable (node->data)))
1180
	    {
1181
	      if (node)
1182
		node = node->prev;
1183 1184 1185 1186 1187 1188 1189
              else if (wrap_around)
		node = g_list_last (menu_shell->children);
              else
                {
                  gtk_widget_error_bell (GTK_WIDGET (menu_shell));
                  break;
                }
1190 1191 1192 1193 1194 1195
	    }
	}
      
      if (node)
	gtk_menu_shell_select_item (menu_shell, node->data);
    }
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208

  return TRUE;
}

/* Distance should be +/- 1 */
static void
gtk_menu_shell_move_selected (GtkMenuShell  *menu_shell, 
			      gint           distance)
{
  gboolean handled = FALSE;

  g_signal_emit (menu_shell, menu_shell_signals[MOVE_SELECTED], 0,
		 distance, &handled);
1209 1210
}

1211
/**
1212
 * gtk_menu_shell_select_first:
1213
 * @menu_shell: a #GtkMenuShell
1214 1215 1216 1217 1218
 * @search_sensitive: if %TRUE, search for the first selectable
 *                    menu item, otherwise select nothing if
 *                    the first item isn't sensitive. This
 *                    should be %FALSE if the menu is being
 *                    popped up initially.
1219
 * 
1220 1221 1222
 * Select the first visible or selectable child of the menu shell;
 * don't select tearoff items unless the only item is a tearoff
 * item.
1223 1224
 *
 * Since: 2.2
1225 1226
 **/
void
1227 1228
gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
			     gboolean      search_sensitive)
1229 1230 1231 1232 1233 1234 1235 1236 1237
{
  GtkWidget *to_select = NULL;
  GList *tmp_list;

  tmp_list = menu_shell->children;
  while (tmp_list)
    {
      GtkWidget *child = tmp_list->data;
      
1238 1239
      if ((!search_sensitive && GTK_WIDGET_VISIBLE (child)) ||
	  _gtk_menu_item_is_selectable (child))
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
	{
	  to_select = child;
	  if (!GTK_IS_TEAROFF_MENU_ITEM (child))
	    break;
	}
      
      tmp_list = tmp_list->next;
    }

  if (to_select)
    gtk_menu_shell_select_item (menu_shell, to_select);
}

1253 1254 1255
void
_gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
			     gboolean      search_sensitive)
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
{
  GtkWidget *to_select = NULL;
  GList *tmp_list;

  tmp_list = g_list_last (menu_shell->children);
  while (tmp_list)
    {
      GtkWidget *child = tmp_list->data;
      
      if ((!search_sensitive && GTK_WIDGET_VISIBLE (child)) ||
	  _gtk_menu_item_is_selectable (child))
	{
	  to_select = child;
	  if (!GTK_IS_TEAROFF_MENU_ITEM (child))
	    break;
	}
      
      tmp_list = tmp_list->prev;
    }

  if (to_select)
    gtk_menu_shell_select_item (menu_shell, to_select);
}

1280
static gboolean
1281 1282 1283 1284
gtk_menu_shell_select_submenu_first (GtkMenuShell     *menu_shell)
{
  GtkMenuItem *menu_item;

1285 1286 1287
  if (menu_shell->active_menu_item == NULL)
    return FALSE;

1288 1289 1290
  menu_item = GTK_MENU_ITEM (menu_shell->active_menu_item); 
  
  if (menu_item->submenu)
1291
    {
1292
      _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item), FALSE);
1293
      gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1294 1295
      if (GTK_MENU_SHELL (menu_item->submenu)->active_menu_item)
	return TRUE;
1296
    }
1297 1298

  return FALSE;
1299 1300
}

1301
static void
1302 1303
gtk_real_menu_shell_move_current (GtkMenuShell         *menu_shell,
				  GtkMenuDirectionType  direction)
1304 1305
{
  GtkMenuShell *parent_menu_shell = NULL;
1306
  gboolean had_selection;
1307
  gboolean touchscreen_mode;
1308 1309

  had_selection = menu_shell->active_menu_item != NULL;
1310

1311 1312 1313 1314
  g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
                "gtk-touchscreen-mode", &touchscreen_mode,
                NULL);

1315 1316
  if (menu_shell->parent_menu_shell)
    parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1317

1318 1319 1320
  switch (direction)
    {
    case GTK_MENU_DIR_PARENT:
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
      if (touchscreen_mode &&
          menu_shell->active_menu_item &&
          GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu &&
          GTK_WIDGET_VISIBLE (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu))
        {
          /* if we are on a menu item that has an open submenu but the
           * focus is not in that submenu (e.g. because it's empty or
           * has only insensitive items), close that submenu instead
           * of running into the code below which would close *this*
           * menu.
           */
          _gtk_menu_item_popdown_submenu (menu_shell->active_menu_item);
        }
      else if (parent_menu_shell)
1335
	{
1336 1337 1338 1339 1340 1341 1342
          if (touchscreen_mode)
            {
              /* close menu when returning from submenu. */
              _gtk_menu_item_popdown_submenu (GTK_MENU (menu_shell)->parent_menu_item);
              break;
            }

1343 1344
	  if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
              GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1345
	    gtk_menu_shell_deselect (menu_shell);
1346
	  else
1347
	    {
1348 1349 1350 1351
	      if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
		gtk_menu_shell_move_selected (parent_menu_shell, -1);
	      else
		gtk_menu_shell_move_selected (parent_menu_shell, 1);
1352
	      gtk_menu_shell_select_submenu_first (parent_menu_shell);
1353
	    }
1354
	}
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
      /* If there is no parent and the submenu is in the opposite direction
       * to the menu, then make the PARENT direction wrap around to
       * the bottom of the submenu.
       */
      else if (menu_shell->active_menu_item &&
	       _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
	       GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
	{
	  GtkMenuShell *submenu = GTK_MENU_SHELL (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu);

	  if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement !=
	      GTK_MENU_SHELL_GET_CLASS (submenu)->submenu_placement)
	    _gtk_menu_shell_select_last (submenu, TRUE);
	}
1369
      break;
1370

1371
    case GTK_MENU_DIR_CHILD:
1372
      if (menu_shell->active_menu_item &&
1373
	  _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1374 1375
	  GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
	{
1376 1377
	  if (gtk_menu_shell_select_submenu_first (menu_shell))
	    break;
1378
	}
1379 1380

      /* Try to find a menu running the opposite direction */
1381
      while (parent_menu_shell &&
1382 1383
	     (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
	      GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1384
	{
1385
	  parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->parent_menu_shell);
1386
	}
1387

1388 1389
      if (parent_menu_shell)
	{
1390 1391 1392 1393 1394
	  if (PACK_DIRECTION (parent_menu_shell) == GTK_PACK_DIRECTION_LTR)
	    gtk_menu_shell_move_selected (parent_menu_shell, 1);
	  else
	    gtk_menu_shell_move_selected (parent_menu_shell, -1);

1395
	  gtk_menu_shell_select_submenu_first (parent_menu_shell);
1396 1397
	}
      break;
1398