gtkmenushell.c 43.8 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * 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 "gtkmenubar.h"
Elliot Lee's avatar
Elliot Lee committed
36 37
#include "gtkmenuitem.h"
#include "gtkmenushell.h"
38
#include "gtkmnemonichash.h"
39
#include "gtktearoffmenuitem.h"
40
#include "gtkwindow.h"
41 42
#include "gtkprivate.h"
#include "gtkintl.h"
43
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
44 45 46

#define MENU_SHELL_TIMEOUT   500

47 48 49 50 51
#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
52 53
enum {
  DEACTIVATE,
Tim Janik's avatar
Tim Janik committed
54
  SELECTION_DONE,
55 56 57
  MOVE_CURRENT,
  ACTIVATE_CURRENT,
  CANCEL,
58
  CYCLE_FOCUS,
Elliot Lee's avatar
Elliot Lee committed
59 60 61
  LAST_SIGNAL
};

62 63 64 65 66
enum {
  PROP_0,
  PROP_TAKE_FOCUS
};

67 68 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 114 115 116 117 118
typedef void (*GtkMenuShellSignal1) (GtkObject           *object,
				     GtkMenuDirectionType arg1,
				     gpointer             data);
typedef void (*GtkMenuShellSignal2) (GtkObject *object,
				     gboolean   arg1,
				     gpointer   data);

/* 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.
 *
119 120 121 122
 *    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.
123 124 125 126 127 128 129 130 131
 * 
 *  ::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
132

133 134 135 136 137 138 139 140
#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;
141 142

  gboolean take_focus;
143 144
};

Elliot Lee's avatar
Elliot Lee committed
145 146
static void gtk_menu_shell_class_init        (GtkMenuShellClass *klass);
static void gtk_menu_shell_init              (GtkMenuShell      *menu_shell);
147 148 149 150 151 152 153 154
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
155
static void gtk_menu_shell_realize           (GtkWidget         *widget);
156
static void gtk_menu_shell_finalize          (GObject           *object);
Elliot Lee's avatar
Elliot Lee committed
157 158 159 160
static gint gtk_menu_shell_button_press      (GtkWidget         *widget,
					      GdkEventButton    *event);
static gint gtk_menu_shell_button_release    (GtkWidget         *widget,
					      GdkEventButton    *event);
161 162
static gint gtk_menu_shell_key_press         (GtkWidget	        *widget,
					      GdkEventKey       *event);
Elliot Lee's avatar
Elliot Lee committed
163 164 165 166
static gint gtk_menu_shell_enter_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
static gint gtk_menu_shell_leave_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
167 168
static void gtk_menu_shell_screen_changed    (GtkWidget         *widget,
					      GdkScreen         *previous_screen);
Elliot Lee's avatar
Elliot Lee committed
169 170 171 172
static void gtk_menu_shell_add               (GtkContainer      *container,
					      GtkWidget         *widget);
static void gtk_menu_shell_remove            (GtkContainer      *container,
					      GtkWidget         *widget);
173 174
static void gtk_menu_shell_forall            (GtkContainer      *container,
					      gboolean		 include_internals,
Elliot Lee's avatar
Elliot Lee committed
175 176
					      GtkCallback        callback,
					      gpointer           callback_data);
177 178 179
static void gtk_menu_shell_real_insert       (GtkMenuShell *menu_shell,
					      GtkWidget    *child,
					      gint          position);
Elliot Lee's avatar
Elliot Lee committed
180 181 182
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
183 184
static GtkWidget *gtk_menu_shell_get_item    (GtkMenuShell      *menu_shell,
					      GdkEvent          *event);
Manish Singh's avatar
Manish Singh committed
185
static GType    gtk_menu_shell_child_type  (GtkContainer      *container);
186 187
static void gtk_menu_shell_real_select_item  (GtkMenuShell      *menu_shell,
					      GtkWidget         *menu_item);
188
static gboolean gtk_menu_shell_select_submenu_first (GtkMenuShell   *menu_shell); 
Elliot Lee's avatar
Elliot Lee committed
189

190 191 192 193 194
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);
195 196
static void gtk_real_menu_shell_cycle_focus      (GtkMenuShell      *menu_shell,
						  GtkDirectionType   dir);
Elliot Lee's avatar
Elliot Lee committed
197

198 199 200 201
static void     gtk_menu_shell_reset_key_hash    (GtkMenuShell *menu_shell);
static gboolean gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
						  GdkEventKey  *event);

Elliot Lee's avatar
Elliot Lee committed
202
static GtkContainerClass *parent_class = NULL;
203
static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
204 205


Manish Singh's avatar
Manish Singh committed
206
GType
207
gtk_menu_shell_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
208
{
Manish Singh's avatar
Manish Singh committed
209
  static GType menu_shell_type = 0;
Elliot Lee's avatar
Elliot Lee committed
210 211 212

  if (!menu_shell_type)
    {
213
      static const GTypeInfo menu_shell_info =
Elliot Lee's avatar
Elliot Lee committed
214 215
      {
	sizeof (GtkMenuShellClass),
216 217
	NULL,		/* base_init */
	NULL,		/* base_finalize */
Manish Singh's avatar
Manish Singh committed
218
	(GClassInitFunc) gtk_menu_shell_class_init,
219 220 221
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkMenuShell),
Manish Singh's avatar
Manish Singh committed
222 223 224
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_menu_shell_init,
	NULL,		/* value_table */
Elliot Lee's avatar
Elliot Lee committed
225 226
      };

Manish Singh's avatar
Manish Singh committed
227 228 229
      menu_shell_type =
	g_type_register_static (GTK_TYPE_CONTAINER, "GtkMenuShell",
				&menu_shell_info, G_TYPE_FLAG_ABSTRACT);
Elliot Lee's avatar
Elliot Lee committed
230 231 232 233 234 235 236 237
    }

  return menu_shell_type;
}

static void
gtk_menu_shell_class_init (GtkMenuShellClass *klass)
{
Manish Singh's avatar
Manish Singh committed
238
  GObjectClass *object_class;
Elliot Lee's avatar
Elliot Lee committed
239 240 241
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

242 243
  GtkBindingSet *binding_set;

Manish Singh's avatar
Manish Singh committed
244
  object_class = (GObjectClass*) klass;
Elliot Lee's avatar
Elliot Lee committed
245 246 247
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;

Manish Singh's avatar
Manish Singh committed
248
  parent_class = g_type_class_peek_parent (klass);
Elliot Lee's avatar
Elliot Lee committed
249

250 251
  object_class->set_property = gtk_menu_shell_set_property;
  object_class->get_property = gtk_menu_shell_get_property;
252 253
  object_class->finalize = gtk_menu_shell_finalize;

254 255 256 257 258 259
  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;
  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;
260
  widget_class->screen_changed = gtk_menu_shell_screen_changed;
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

  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;

Elliot Lee's avatar
Elliot Lee committed
276
  menu_shell_signals[DEACTIVATE] =
Manish Singh's avatar
Manish Singh committed
277 278 279 280 281 282 283
    g_signal_new ("deactivate",
		  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);
Tim Janik's avatar
Tim Janik committed
284
  menu_shell_signals[SELECTION_DONE] =
Manish Singh's avatar
Manish Singh committed
285 286 287 288 289 290 291
    g_signal_new ("selection-done",
		  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);
292
  menu_shell_signals[MOVE_CURRENT] =
Manish Singh's avatar
Manish Singh committed
293 294 295 296 297 298 299 300
    g_signal_new ("move_current",
		  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,
		  G_TYPE_NONE, 1, 
		  GTK_TYPE_MENU_DIRECTION_TYPE);
301
  menu_shell_signals[ACTIVATE_CURRENT] =
Manish Singh's avatar
Manish Singh committed
302 303 304 305 306 307 308 309
    g_signal_new ("activate_current",
		  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,
		  G_TYPE_NONE, 1, 
		  G_TYPE_BOOLEAN);
310
  menu_shell_signals[CANCEL] =
Manish Singh's avatar
Manish Singh committed
311 312 313 314 315 316 317
    g_signal_new ("cancel",
		  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);
318
  menu_shell_signals[CYCLE_FOCUS] =
319 320 321 322 323 324 325 326
    _gtk_binding_signal_new ("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);
327

328 329 330 331 332 333 334 335

  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
336
				G_TYPE_BOOLEAN,
337
				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 405 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
  priv->take_focus = TRUE;
}

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
443 444
}

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
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);

  G_OBJECT_CLASS (parent_class)->finalize (object);
}


Elliot Lee's avatar
Elliot Lee committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
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)
{
479 480
  GtkMenuShellClass *class;

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

484 485 486 487 488 489 490 491 492 493 494
  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)
{
495 496
  menu_shell->children = g_list_insert (menu_shell->children, child, position);

Elliot Lee's avatar
Elliot Lee committed
497 498 499 500 501 502 503 504
  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
505
  g_signal_emit (menu_shell, menu_shell_signals[DEACTIVATE], 0);
Elliot Lee's avatar
Elliot Lee committed
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
}

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

  g_return_if_fail (GTK_IS_MENU_SHELL (widget));

  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 |
530
			    GDK_KEY_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
531 532 533 534
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

  attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
535
  widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
Elliot Lee's avatar
Elliot Lee committed
536 537 538 539 540 541
  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);
}

542 543 544 545 546 547 548 549 550 551 552
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
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
static gint
gtk_menu_shell_button_press (GtkWidget      *widget,
			     GdkEventButton *event)
{
  GtkMenuShell *menu_shell;
  GtkWidget *menu_item;

  g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

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

  menu_shell = GTK_MENU_SHELL (widget);

  if (menu_shell->parent_menu_shell)
    {
570
      return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
Elliot Lee's avatar
Elliot Lee committed
571 572 573
    }
  else if (!menu_shell->active || !menu_shell->button)
    {
574 575
      _gtk_menu_shell_activate (menu_shell);
      
576 577
      menu_shell->button = event->button;

Owen Taylor's avatar
Owen Taylor committed
578
      menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent *)event);
579

580
      if (menu_item && _gtk_menu_item_is_selectable (menu_item))
Elliot Lee's avatar
Elliot Lee committed
581 582 583
	{
	  if ((menu_item->parent == widget) &&
	      (menu_item != menu_shell->active_menu_item))
584 585
	    {
	      if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement == GTK_TOP_BOTTOM)
586 587 588 589
		{
		  menu_shell->activate_time = event->time;
		}
      
590 591
	      gtk_menu_shell_select_item (menu_shell, menu_item);
	    }
Elliot Lee's avatar
Elliot Lee committed
592 593 594 595 596 597
	}
    }
  else
    {
      widget = gtk_get_event_widget ((GdkEvent*) event);
      if (widget == GTK_WIDGET (menu_shell))
Tim Janik's avatar
Tim Janik committed
598 599
	{
	  gtk_menu_shell_deactivate (menu_shell);
Manish Singh's avatar
Manish Singh committed
600
	  g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
Tim Janik's avatar
Tim Janik committed
601
	}
Elliot Lee's avatar
Elliot Lee committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
    }

  return TRUE;
}

static gint
gtk_menu_shell_button_release (GtkWidget      *widget,
			       GdkEventButton *event)
{
  GtkMenuShell *menu_shell;
  GtkWidget *menu_item;
  gint deactivate;

  g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  menu_shell = GTK_MENU_SHELL (widget);
  if (menu_shell->active)
    {
621
      if (menu_shell->button && (event->button != menu_shell->button))
Elliot Lee's avatar
Elliot Lee committed
622
	{
623
	  menu_shell->button = 0;
Elliot Lee's avatar
Elliot Lee committed
624
	  if (menu_shell->parent_menu_shell)
625
	    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
Elliot Lee's avatar
Elliot Lee committed
626
	}
627

Elliot Lee's avatar
Elliot Lee committed
628
      menu_shell->button = 0;
Owen Taylor's avatar
Owen Taylor committed
629
      menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
630

Elliot Lee's avatar
Elliot Lee committed
631 632 633 634
      deactivate = TRUE;

      if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
	{
635
	  if (menu_item && (menu_shell->active_menu_item == menu_item) &&
636
	      _gtk_menu_item_is_selectable (menu_item))
Elliot Lee's avatar
Elliot Lee committed
637 638
	    {
	      if (GTK_MENU_ITEM (menu_item)->submenu == NULL)
639 640 641 642 643 644 645 646 647
		{
		  gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
		  return TRUE;
		}
	      else if (GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
		{
		  gtk_menu_item_select (GTK_MENU_ITEM (menu_item));
		  return TRUE;
		}
Elliot Lee's avatar
Elliot Lee committed
648
	    }
649 650 651 652 653 654
	  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;
	    }
Elliot Lee's avatar
Elliot Lee committed
655 656 657 658 659 660
	  else if (menu_shell->parent_menu_shell)
	    {
	      menu_shell->active = TRUE;
	      gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	      return TRUE;
	    }
661 662 663

	  /* If we ended up on an item with a submenu, leave the menu up.
	   */
664 665 666 667 668
	  if (menu_item && (menu_shell->active_menu_item == menu_item) &&
	      GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement != GTK_TOP_BOTTOM)
	    {
	      deactivate = FALSE;
	    }
Elliot Lee's avatar
Elliot Lee committed
669
	}
670
      else /* a very fast press-release */
Owen Taylor's avatar
Owen Taylor committed
671 672 673 674 675 676 677 678 679 680 681
	{
	  /* We only ever want to prevent deactivation on the first
           * press/release. Setting the time to zero is a bit of a
	   * 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;
	}
Owen Taylor's avatar
Owen Taylor committed
682
      
Elliot Lee's avatar
Elliot Lee committed
683
      if (deactivate)
Tim Janik's avatar
Tim Janik committed
684 685
	{
	  gtk_menu_shell_deactivate (menu_shell);
Manish Singh's avatar
Manish Singh committed
686
	  g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
Tim Janik's avatar
Tim Janik committed
687
	}
Elliot Lee's avatar
Elliot Lee committed
688 689 690 691 692
    }

  return TRUE;
}

693
static gint
694
gtk_menu_shell_key_press (GtkWidget   *widget,
695 696 697 698 699 700 701 702 703 704 705 706
			  GdkEventKey *event)
{
  GtkMenuShell *menu_shell;
  
  g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);
      
  menu_shell = GTK_MENU_SHELL (widget);

  if (!menu_shell->active_menu_item && menu_shell->parent_menu_shell)
    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent *)event);
  
707
  if (gtk_bindings_activate_event (GTK_OBJECT (widget), event))
708 709
    return TRUE;

710
  return gtk_menu_shell_activate_mnemonic (menu_shell, event);
711 712
}

Elliot Lee's avatar
Elliot Lee committed
713 714 715 716 717 718 719 720 721 722 723
static gint
gtk_menu_shell_enter_notify (GtkWidget        *widget,
			     GdkEventCrossing *event)
{
  GtkMenuShell *menu_shell;
  GtkWidget *menu_item;

  g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  menu_shell = GTK_MENU_SHELL (widget);
724

725
  if (menu_shell->active)
Elliot Lee's avatar
Elliot Lee committed
726 727 728
    {
      menu_item = gtk_get_event_widget ((GdkEvent*) event);

729 730 731
      if (!menu_item ||
	  (GTK_IS_MENU_ITEM (menu_item) && 
	   !_gtk_menu_item_is_selectable (menu_item)))
Elliot Lee's avatar
Elliot Lee committed
732
	return TRUE;
733
      
Elliot Lee's avatar
Elliot Lee committed
734 735 736 737
      if ((menu_item->parent == widget) &&
	  (menu_shell->active_menu_item != menu_item) &&
	  GTK_IS_MENU_ITEM (menu_item))
	{
738 739 740
	  if (menu_shell->ignore_enter)
	    return TRUE;
	  
Elliot Lee's avatar
Elliot Lee committed
741 742 743
	  if ((event->detail != GDK_NOTIFY_INFERIOR) &&
	      (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT))
	    {
744
	      gtk_menu_shell_select_item (menu_shell, menu_item);
Elliot Lee's avatar
Elliot Lee committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
	    }
	}
      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)
{
  GtkMenuShell *menu_shell;
  GtkMenuItem *menu_item;
  GtkWidget *event_widget;

  g_return_val_if_fail (GTK_IS_MENU_SHELL (widget), FALSE);
  g_return_val_if_fail (event != NULL, FALSE);

  if (GTK_WIDGET_VISIBLE (widget))
    {
      menu_shell = GTK_MENU_SHELL (widget);
      event_widget = gtk_get_event_widget ((GdkEvent*) event);

772
      if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
Elliot Lee's avatar
Elliot Lee committed
773 774 775 776
	return TRUE;

      menu_item = GTK_MENU_ITEM (event_widget);

777
      if (!_gtk_menu_item_is_selectable (event_widget))
Tim Janik's avatar
Tim Janik committed
778 779
	return TRUE;

Elliot Lee's avatar
Elliot Lee committed
780 781 782 783 784 785
      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))
	    {
786
	      gtk_menu_shell_deselect (menu_shell);
Elliot Lee's avatar
Elliot Lee committed
787 788 789 790 791 792 793 794 795 796 797
	    }
	}
      else if (menu_shell->parent_menu_shell)
	{
	  gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	}
    }

  return TRUE;
}

798 799 800 801 802 803 804
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
805 806 807 808 809 810 811 812 813 814 815 816
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)
{
  GtkMenuShell *menu_shell;
817 818
  gint was_visible;
  
Elliot Lee's avatar
Elliot Lee committed
819 820
  g_return_if_fail (GTK_IS_MENU_SHELL (container));
  g_return_if_fail (GTK_IS_MENU_ITEM (widget));
821 822
  
  was_visible = GTK_WIDGET_VISIBLE (widget);
Elliot Lee's avatar
Elliot Lee committed
823 824
  menu_shell = GTK_MENU_SHELL (container);
  menu_shell->children = g_list_remove (menu_shell->children, widget);
825
  
826 827 828 829 830 831
  if (widget == menu_shell->active_menu_item)
    {
      gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
      menu_shell->active_menu_item = NULL;
    }

832 833
  gtk_widget_unparent (widget);
  
834 835 836 837
  /* 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
838 839 840 841
    gtk_widget_queue_resize (GTK_WIDGET (container));
}

static void
842 843 844 845
gtk_menu_shell_forall (GtkContainer *container,
		       gboolean      include_internals,
		       GtkCallback   callback,
		       gpointer      callback_data)
Elliot Lee's avatar
Elliot Lee committed
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
{
  GtkMenuShell *menu_shell;
  GtkWidget *child;
  GList *children;

  g_return_if_fail (GTK_IS_MENU_SHELL (container));
  g_return_if_fail (callback != NULL);

  menu_shell = GTK_MENU_SHELL (container);

  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;
874
      menu_shell->activate_time = 0;
Elliot Lee's avatar
Elliot Lee committed
875 876 877 878 879 880 881 882 883 884 885 886 887 888

      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)
	{
889 890
	  GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET (menu_shell));
	  
Elliot Lee's avatar
Elliot Lee committed
891
	  menu_shell->have_xgrab = FALSE;
892 893
	  gdk_display_pointer_ungrab (display, GDK_CURRENT_TIME);
	  gdk_display_keyboard_ungrab (display, GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
894 895 896 897 898 899 900 901
	}
    }
}

static gint
gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
			GtkWidget    *child)
{
902
  GtkWidget *parent;
Elliot Lee's avatar
Elliot Lee committed
903 904 905 906

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

907
  parent = child->parent;
Elliot Lee's avatar
Elliot Lee committed
908 909
  while (parent && GTK_IS_MENU_SHELL (parent))
    {
910
      if (parent == (GtkWidget*) menu_shell)
Elliot Lee's avatar
Elliot Lee committed
911
	return TRUE;
912
      parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
Elliot Lee's avatar
Elliot Lee committed
913 914 915 916
    }

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

918
static GtkWidget*
Owen Taylor's avatar
Owen Taylor committed
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
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;
}

935 936 937
/* Handlers for action signals */

void
938 939
gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
			    GtkWidget    *menu_item)
940
{
941 942
  GtkMenuShellClass *class;

943 944 945
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

946 947
  class = GTK_MENU_SHELL_GET_CLASS (menu_shell);

948 949 950
  if (class->select_item &&
      !(menu_shell->active &&
	menu_shell->active_menu_item == menu_item))
951 952 953
    class->select_item (menu_shell, menu_item);
}

954 955
void _gtk_menu_item_set_placement (GtkMenuItem         *menu_item,
				   GtkSubmenuPlacement  placement);
956 957 958 959 960

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

963
  gtk_menu_shell_deselect (menu_shell);
964

965 966 967
  if (!_gtk_menu_item_is_selectable (menu_item))
    return;

968
  menu_shell->active_menu_item = menu_item;
969 970 971 972 973 974
  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);
975 976 977 978 979 980 981 982 983
  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);
}

984 985
void
gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
986
{
987 988 989 990 991 992 993
  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;
    }
994 995 996 997 998 999 1000
}

void
gtk_menu_shell_activate_item (GtkMenuShell      *menu_shell,
			      GtkWidget         *menu_item,
			      gboolean           force_deactivate)
{
1001
  GSList *slist, *shells = NULL;
1002 1003 1004 1005 1006 1007
  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)
1008
    deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
1009

Manish Singh's avatar
Manish Singh committed
1010
  g_object_ref (menu_shell);
1011
  g_object_ref (menu_item);
1012 1013 1014

  if (deactivate)
    {
1015 1016 1017 1018
      GtkMenuShell *parent_menu_shell = menu_shell;

      do
	{
Manish Singh's avatar
Manish Singh committed
1019
	  g_object_ref (parent_menu_shell);
1020 1021 1022 1023 1024 1025
	  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);

1026 1027 1028 1029 1030
      gtk_menu_shell_deactivate (menu_shell);
  
      /* flush the x-queue, so any grabs are removed and
       * the menu is actually taken down
       */
1031
      gdk_display_sync (gtk_widget_get_display (menu_item));
1032
    }
1033

1034 1035
  gtk_widget_activate (menu_item);

1036 1037
  for (slist = shells; slist; slist = slist->next)
    {
Manish Singh's avatar
Manish Singh committed
1038 1039
      g_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE], 0);
      g_object_unref (slist->data);
1040 1041 1042
    }
  g_slist_free (shells);

Manish Singh's avatar
Manish Singh committed
1043
  g_object_unref (menu_shell);
1044
  g_object_unref (menu_item);
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
}

/* Distance should be +/- 1 */
static void
gtk_menu_shell_move_selected (GtkMenuShell  *menu_shell, 
			      gint           distance)
{
  if (menu_shell->active_menu_item)
    {
      GList *node = g_list_find (menu_shell->children,
				 menu_shell->active_menu_item);
      GList *start_node = node;
      
      if (distance > 0)
	{
	  node = node->next;
	  while (node != start_node && 
1062
		 (!node || !_gtk_menu_item_is_selectable (node->data)))
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
	    {
	      if (!node)
		node = menu_shell->children;
	      else
		node = node->next;
	    }
	}
      else
	{
	  node = node->prev;
	  while (node != start_node &&
1074
		 (!node || !_gtk_menu_item_is_selectable (node->data)))
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
	    {
	      if (!node)
		node = g_list_last (menu_shell->children);
	      else
		node = node->prev;
	    }
	}
      
      if (node)
	gtk_menu_shell_select_item (menu_shell, node->data);
    }
}

1088
/**
1089
 * gtk_menu_shell_select_first:
1090
 * @menu_shell: a #GtkMenuShell
1091 1092 1093 1094 1095
 * @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.
1096
 * 
1097 1098 1099
 * Select the first visible or selectable child of the menu shell;
 * don't select tearoff items unless the only item is a tearoff
 * item.
1100 1101
 *
 * Since: 2.2
1102 1103
 **/
void
1104 1105
gtk_menu_shell_select_first (GtkMenuShell *menu_shell,
			     gboolean      search_sensitive)
1106 1107 1108 1109 1110 1111 1112 1113 1114
{
  GtkWidget *to_select = NULL;
  GList *tmp_list;

  tmp_list = menu_shell->children;
  while (tmp_list)
    {
      GtkWidget *child = tmp_list->data;
      
1115 1116
      if ((!search_sensitive && GTK_WIDGET_VISIBLE (child)) ||
	  _gtk_menu_item_is_selectable (child))
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
	{
	  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);
}

1130 1131 1132
void
_gtk_menu_shell_select_last (GtkMenuShell *menu_shell,
			     gboolean      search_sensitive)
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
{
  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);
}

1157
static gboolean
1158 1159 1160 1161 1162 1163 1164
gtk_menu_shell_select_submenu_first (GtkMenuShell     *menu_shell)
{
  GtkMenuItem *menu_item;

  menu_item = GTK_MENU_ITEM (menu_shell->active_menu_item); 
  
  if (menu_item->submenu)
1165
    {
Matthias Clasen's avatar
Matthias Clasen committed
1166
      _gtk_menu_item_popup_submenu (GTK_WIDGET (menu_item));
1167
      gtk_menu_shell_select_first (GTK_MENU_SHELL (menu_item->submenu), TRUE);
1168 1169
      if (GTK_MENU_SHELL (menu_item->submenu)->active_menu_item)
	return TRUE;
1170
    }
1171 1172

  return FALSE;
1173 1174
}

1175 1176 1177 1178 1179
static void
gtk_real_menu_shell_move_current (GtkMenuShell      *menu_shell,
				  GtkMenuDirectionType direction)
{
  GtkMenuShell *parent_menu_shell = NULL;
1180 1181 1182
  gboolean had_selection;

  had_selection = menu_shell->active_menu_item != NULL;
1183 1184 1185

  if (menu_shell->parent_menu_shell)
    parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
1186

1187 1188 1189 1190 1191
  switch (direction)
    {
    case GTK_MENU_DIR_PARENT:
      if (parent_menu_shell)
	{
1192 1193
	  if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement == 
		       GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
1194
	    gtk_menu_shell_deselect (menu_shell);
1195 1196
	  else 
	    {
1197 1198 1199 1200
	      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);
1201 1202
	      gtk_menu_shell_select_submenu_first (parent_menu_shell); 
	    }
1203
	}
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
      /* 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);
	}
1218 1219 1220
      break;
      
    case GTK_MENU_DIR_CHILD:
1221
      if (menu_shell->active_menu_item &&
1222
	  _gtk_menu_item_is_selectable (menu_shell->active_menu_item) &&
1223 1224
	  GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
	{
1225 1226
	  if (gtk_menu_shell_select_submenu_first (menu_shell))
	    break;
1227
	}
1228 1229 1230 1231 1232

      /* Try to find a menu running the opposite direction */
      while (parent_menu_shell && 
	     (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
	      GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1233
	{
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
	  GtkWidget *tmp_widget = parent_menu_shell->parent_menu_shell;
	  
	  if (tmp_widget)
	    parent_menu_shell = GTK_MENU_SHELL (tmp_widget);
	  else
	    parent_menu_shell = NULL;
	}
      
      if (parent_menu_shell)
	{
1244 1245 1246 1247 1248
	  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);

1249
	  gtk_menu_shell_select_submenu_first (parent_menu_shell);
1250 1251
	}
      break;
1252
      
1253 1254
    case GTK_MENU_DIR_PREV:
      gtk_menu_shell_move_selected (menu_shell, -1);
1255 1256 1257
      if (!had_selection &&
	  !menu_shell->active_menu_item &&
	  menu_shell->children)
1258
	_gtk_menu_shell_select_last (menu_shell, TRUE);
1259 1260 1261
      break;
    case GTK_MENU_DIR_NEXT:
      gtk_menu_shell_move_selected (menu_shell, 1);
1262 1263 1264
      if (!had_selection &&
	  !menu_shell->active_menu_item &&
	  menu_shell->children)
1265
	gtk_menu_shell_select_first (menu_shell, TRUE);
1266 1267 1268 1269 1270 1271 1272 1273 1274
      break;
    }
}

static void
gtk_real_menu_shell_activate_current (GtkMenuShell      *menu_shell,
				      gboolean           force_hide)
{
  if (menu_shell->active_menu_item &&
1275 1276 1277 1278
      _gtk_menu_item_is_selectable (menu_shell->active_menu_item))
  {
   
    if (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu == NULL)
1279 1280 1281
      gtk_menu_shell_activate_item (menu_shell,
				    menu_shell->active_menu_item,
				    force_hide);
1282 1283 1284
    else
      _gtk_menu_item_popup_submenu (menu_shell->active_menu_item);
  }
1285 1286 1287 1288 1289
}

static void
gtk_real_menu_shell_cancel (GtkMenuShell      *menu_shell)
{
1290 1291 1292 1293
  /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
   */
  gtk_menu_shell_deselect (menu_shell);
  
1294
  gtk_menu_shell_deactivate (menu_shell);
Manish Singh's avatar
Manish Singh committed
1295
  g_signal_emit (menu_shell, menu_shell_signals[SELECTION_DONE], 0);
1296
}
1297 1298 1299 1300 1301 1302

static void
gtk_real_menu_shell_cycle_focus (GtkMenuShell      *menu_shell,
				 GtkDirectionType   dir)
{
  while (menu_shell && !GTK_IS_MENU_BAR (menu_shell))
1303 1304 1305 1306 1307 1308
    {
      if (menu_shell->parent_menu_shell)
	menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
      else
	menu_shell = NULL;
    }
1309 1310 1311 1312

  if (menu_shell)
    _gtk_menu_bar_cycle_focus (GTK_MENU_BAR (menu_shell), dir);
}
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

gint
_gtk_menu_shell_get_popup_delay (GtkMenuShell *menu_shell)
{
  GtkMenuShellClass *klass = GTK_MENU_SHELL_GET_CLASS (menu_shell);
  
  if (klass->get_popup_delay)
    {
      return klass->get_popup_delay (menu_shell);
    }
  else
    {
      gint popup_delay;
      GtkWidget *widget = GTK_WIDGET (menu_shell);
      
1328
      g_object_get (gtk_widget_get_settings (widget),
1329 1330 1331 1332 1333 1334
		    "gtk-menu-popup-delay", &popup_delay,
		    NULL);
      
      return popup_delay;
    }
}
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350

/**
 * gtk_menu_shell_cancel:
 * @menu_shell: a #GtkMenuShell
 * 
 * Cancels the selection within the menu shell.  
 * 
 * Since: 2.4
 */
void
gtk_menu_shell_cancel (GtkMenuShell *menu_shell)
{
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));

  g_signal_emit (menu_shell, menu_shell_signals[CANCEL], 0);
}
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467

static GtkMnemonicHash *
gtk_menu_shell_get_mnemonic_hash (GtkMenuShell *menu_shell,
				  gboolean      create)
{
  GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

  if (!private->mnemonic_hash && create)
    private->mnemonic_hash = _gtk_mnemonic_hash_new ();
  
  return private->mnemonic_hash;
}

static void
menu_shell_add_mnemonic_foreach (guint    keyval,
				 GSList  *targets,
				 gpointer data)
{
  GtkKeyHash *key_hash = data;

  _gtk_key_hash_add_entry (key_hash, keyval, 0, GUINT_TO_POINTER (keyval));
}

static GtkKeyHash *
gtk_menu_shell_get_key_hash (GtkMenuShell *menu_shell,
			     gboolean      create)
{
  GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);
  GtkWidget *widget = GTK_WIDGET (menu_shell);

  if (!private->key_hash && create && gtk_widget_has_screen (widget))
    {
      GtkMnemonicHash *mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
      GdkScreen *screen = gtk_widget_get_screen (widget);
      GdkKeymap *keymap = gdk_keymap_get_for_display (gdk_screen_get_display (screen));

      if (!mnemonic_hash)
	return NULL;
      
      private->key_hash = _gtk_key_hash_new (keymap, NULL);

      _gtk_mnemonic_hash_foreach (mnemonic_hash,
				  menu_shell_add_mnemonic_foreach,
				  private->key_hash);
    }
  
  return private->key_hash;
}

static void
gtk_menu_shell_reset_key_hash (GtkMenuShell *menu_shell)
{
  GtkMenuShellPrivate *private = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

  if (private->key_hash)
    {
      _gtk_key_hash_free (private->key_hash);
      private->key_hash = NULL;
    }
}

static gboolean
gtk_menu_shell_activate_mnemonic (GtkMenuShell *menu_shell,
				  GdkEventKey  *event)
{
  GtkMnemonicHash *mnemonic_hash;
  GtkKeyHash *key_hash;
  GSList *entries;
  gboolean result = FALSE;

  mnemonic_hash = gtk_menu_shell_get_mnemonic_hash (menu_shell, FALSE);
  if (!mnemonic_hash)
    return FALSE;

  key_hash = gtk_menu_shell_get_key_hash (menu_shell, TRUE);
  if (!key_hash)
    return FALSE;
  
  entries = _gtk_key_hash_lookup (key_hash,
				  event->hardware_keycode,
				  event->state,
				  gtk_accelerator_get_default_mod_mask (),
				  event->group);

  if (entries)
    result = _gtk_mnemonic_hash_activate (mnemonic_hash,
					  GPOINTER_TO_UINT (entries->data));

  return result;
}

void
_gtk_menu_shell_add_mnemonic (GtkMenuShell *menu_shell,
			      guint      keyval,
			      GtkWidget *target)
{
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_WIDGET (target));

  _gtk_mnemonic_hash_add (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
			  keyval, target);
  gtk_menu_shell_reset_key_hash (menu_shell);
}

void
_gtk_menu_shell_remove_mnemonic (GtkMenuShell *menu_shell,
				 guint      keyval,
				 GtkWidget *target)
{
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (GTK_IS_WIDGET (target));
  
  _gtk_mnemonic_hash_remove (gtk_menu_shell_get_mnemonic_hash (menu_shell, TRUE),
			     keyval, target);
  gtk_menu_shell_reset_key_hash (menu_shell);
}

1468 1469
/**
 * gtk_menu_shell_get_take_focus:
Matthias Clasen's avatar
Matthias Clasen committed
1470
 * @menu_shell: a #GtkMenuShell
1471
 *
1472 1473 1474
 * Returns %TRUE if the menu shell will take the keyboard focus on popup.
 *
 * Returns: %TRUE if the menu shell will take the keyboard focus on popup.
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
 *
 * Since: 2.8
 **/
gboolean
gtk_menu_shell_get_take_focus (GtkMenuShell *menu_shell)
{
  GtkMenuShellPrivate *priv;

  g_return_val_if_fail (GTK_IS_MENU_SHELL (menu_shell), FALSE);

  priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

  return priv->take_focus;
}

/**
 * gtk_menu_shell_set_take_focus:
Matthias Clasen's avatar
Matthias Clasen committed
1492 1493
 * @menu_shell: a #GtkMenuShell
 * @take_focus: %TRUE if the menu shell should take the keyboard focus on popup.
1494
 *
Matthias Clasen's avatar
Matthias Clasen committed
1495 1496
 * If @take_focus is %TRUE (the default) the menu shell will take the keyboard 
 * focus so that it will receive all keyboard events which is needed to enable
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
 * keyboard navigation in menus.
 *
 * Setting @take_focus to %FALSE is useful only for special applications
 * like virtual keyboard implementations which should not take keyboard
 * focus.
 *
 * The @take_focus state of a menu or menu bar is automatically propagated
 * to submenus whenever a submenu is popped up, so you don't have to worry
 * about recursively setting it for your entire menu hierarchy. Only when
 * programmatically picking a submenu and popping it up manually, the
 * @take_focus property of the submenu needs to be set explicitely.
 *
 * Note that setting it to %FALSE has side-effects:
 *
 * If the focus is in some other app, it keeps the focus and keynav in
 * the menu doesn't work. Consequently, keynav on the menu will only
 * work if the focus is on some toplevel owned by the onscreen keyboard.
 *
 * To avoid confusing the user, menus with @take_focus set to %FALSE
 * should not display mnemonics or accelerators, since it cannot be
 * guaranteed that they will work.
 *
 * See also gdk_keyboard_grab()
 *
 * Since: 2.8
 **/
void
gtk_menu_shell_set_take_focus (GtkMenuShell *menu_shell,
                               gboolean      take_focus)
{
  GtkMenuShellPrivate *priv;

  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));

  priv = GTK_MENU_SHELL_GET_PRIVATE (menu_shell);

  if (priv->take_focus != take_focus)
    {
      priv->take_focus = take_focus;
      g_object_notify (G_OBJECT (menu_shell), "take-focus");
    }
}

1540 1541
#define __GTK_MENU_SHELL_C__
#include "gtkaliasdef.c"