gtkmenushell.c 30.1 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
#include "gdk/gdkkeysyms.h"
#include "gtkbindings.h"
Elliot Lee's avatar
Elliot Lee committed
29 30
#include "gtkmain.h"
#include "gtkmenuitem.h"
31
#include "gtktearoffmenuitem.h" /* FIXME */
Elliot Lee's avatar
Elliot Lee committed
32 33
#include "gtkmenushell.h"
#include "gtksignal.h"
34
#include "gtkwindow.h"
Elliot Lee's avatar
Elliot Lee committed
35 36 37 38 39 40

#define MENU_SHELL_TIMEOUT   500


enum {
  DEACTIVATE,
Tim Janik's avatar
Tim Janik committed
41
  SELECTION_DONE,
42 43 44
  MOVE_CURRENT,
  ACTIVATE_CURRENT,
  CANCEL,
Elliot Lee's avatar
Elliot Lee committed
45 46 47
  LAST_SIGNAL
};

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 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
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.
 *
 * 
 *  ::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
109 110 111 112 113 114 115 116 117

static void gtk_menu_shell_class_init        (GtkMenuShellClass *klass);
static void gtk_menu_shell_init              (GtkMenuShell      *menu_shell);
static void gtk_menu_shell_map               (GtkWidget         *widget);
static void gtk_menu_shell_realize           (GtkWidget         *widget);
static gint gtk_menu_shell_button_press      (GtkWidget         *widget,
					      GdkEventButton    *event);
static gint gtk_menu_shell_button_release    (GtkWidget         *widget,
					      GdkEventButton    *event);
118 119
static gint gtk_menu_shell_key_press         (GtkWidget	        *widget,
					      GdkEventKey       *event);
Elliot Lee's avatar
Elliot Lee committed
120 121 122 123 124 125 126 127
static gint gtk_menu_shell_enter_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
static gint gtk_menu_shell_leave_notify      (GtkWidget         *widget,
					      GdkEventCrossing  *event);
static void gtk_menu_shell_add               (GtkContainer      *container,
					      GtkWidget         *widget);
static void gtk_menu_shell_remove            (GtkContainer      *container,
					      GtkWidget         *widget);
128 129
static void gtk_menu_shell_forall            (GtkContainer      *container,
					      gboolean		 include_internals,
Elliot Lee's avatar
Elliot Lee committed
130 131
					      GtkCallback        callback,
					      gpointer           callback_data);
132 133 134
static void gtk_menu_shell_real_insert       (GtkMenuShell *menu_shell,
					      GtkWidget    *child,
					      gint          position);
Elliot Lee's avatar
Elliot Lee committed
135 136 137
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
138 139
static GtkWidget *gtk_menu_shell_get_item    (GtkMenuShell      *menu_shell,
					      GdkEvent          *event);
140
static GtkType    gtk_menu_shell_child_type  (GtkContainer      *container);
141 142
static void gtk_menu_shell_real_select_item  (GtkMenuShell      *menu_shell,
					      GtkWidget         *menu_item);
143
static void gtk_menu_shell_select_submenu_first (GtkMenuShell   *menu_shell); 
Elliot Lee's avatar
Elliot Lee committed
144

145 146 147 148 149
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);
Elliot Lee's avatar
Elliot Lee committed
150 151

static GtkContainerClass *parent_class = NULL;
152
static guint menu_shell_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
153 154


Tim Janik's avatar
Tim Janik committed
155
GtkType
156
gtk_menu_shell_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
157
{
Tim Janik's avatar
Tim Janik committed
158
  static GtkType menu_shell_type = 0;
Elliot Lee's avatar
Elliot Lee committed
159 160 161

  if (!menu_shell_type)
    {
162
      static const GtkTypeInfo menu_shell_info =
Elliot Lee's avatar
Elliot Lee committed
163 164 165 166 167 168
      {
	"GtkMenuShell",
	sizeof (GtkMenuShell),
	sizeof (GtkMenuShellClass),
	(GtkClassInitFunc) gtk_menu_shell_class_init,
	(GtkObjectInitFunc) gtk_menu_shell_init,
169 170
	/* reserved_1 */ NULL,
        /* reserved_2 */ NULL,
171
        (GtkClassInitFunc) NULL,
Elliot Lee's avatar
Elliot Lee committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
      };

      menu_shell_type = gtk_type_unique (gtk_container_get_type (), &menu_shell_info);
    }

  return menu_shell_type;
}

static void
gtk_menu_shell_class_init (GtkMenuShellClass *klass)
{
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

187 188
  GtkBindingSet *binding_set;

Elliot Lee's avatar
Elliot Lee committed
189 190 191 192 193 194
  object_class = (GtkObjectClass*) klass;
  widget_class = (GtkWidgetClass*) klass;
  container_class = (GtkContainerClass*) klass;

  parent_class = gtk_type_class (gtk_container_get_type ());

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
  widget_class->map = gtk_menu_shell_map;
  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;

  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
217 218 219
  menu_shell_signals[DEACTIVATE] =
    gtk_signal_new ("deactivate",
                    GTK_RUN_FIRST,
220
                    GTK_CLASS_TYPE (object_class),
Elliot Lee's avatar
Elliot Lee committed
221
                    GTK_SIGNAL_OFFSET (GtkMenuShellClass, deactivate),
222
                    gtk_marshal_VOID__VOID,
Elliot Lee's avatar
Elliot Lee committed
223
		    GTK_TYPE_NONE, 0);
Tim Janik's avatar
Tim Janik committed
224 225 226
  menu_shell_signals[SELECTION_DONE] =
    gtk_signal_new ("selection-done",
                    GTK_RUN_FIRST,
227
                    GTK_CLASS_TYPE (object_class),
Tim Janik's avatar
Tim Janik committed
228
                    GTK_SIGNAL_OFFSET (GtkMenuShellClass, selection_done),
229
                    gtk_marshal_VOID__VOID,
Tim Janik's avatar
Tim Janik committed
230
		    GTK_TYPE_NONE, 0);
231 232 233
  menu_shell_signals[MOVE_CURRENT] =
    gtk_signal_new ("move_current",
		    GTK_RUN_LAST | GTK_RUN_ACTION,
234
		    GTK_CLASS_TYPE (object_class),
235
                    GTK_SIGNAL_OFFSET (GtkMenuShellClass, move_current),
236
		    gtk_marshal_VOID__ENUM,
237 238 239 240 241
		    GTK_TYPE_NONE, 1, 
		    GTK_TYPE_MENU_DIRECTION_TYPE);
  menu_shell_signals[ACTIVATE_CURRENT] =
    gtk_signal_new ("activate_current",
		    GTK_RUN_LAST | GTK_RUN_ACTION,
242
		    GTK_CLASS_TYPE (object_class),
243
                    GTK_SIGNAL_OFFSET (GtkMenuShellClass, activate_current),
244
		    gtk_marshal_VOID__BOOLEAN,
245 246 247 248 249
		    GTK_TYPE_NONE, 1, 
		    GTK_TYPE_BOOL);
  menu_shell_signals[CANCEL] =
    gtk_signal_new ("cancel",
		    GTK_RUN_LAST | GTK_RUN_ACTION,
250
		    GTK_CLASS_TYPE (object_class),
251
                    GTK_SIGNAL_OFFSET (GtkMenuShellClass, cancel),
252
                    gtk_marshal_VOID__VOID,
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
		    GTK_TYPE_NONE, 0);

  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,
				GTK_TYPE_BOOL,
				TRUE);
  gtk_binding_entry_add_signal (binding_set,
				GDK_space, 0,
				"activate_current", 1,
				GTK_TYPE_BOOL,
				FALSE);
Elliot Lee's avatar
Elliot Lee committed
269 270
}

271 272 273 274 275 276
static GtkType
gtk_menu_shell_child_type (GtkContainer     *container)
{
  return GTK_TYPE_MENU_ITEM;
}

Elliot Lee's avatar
Elliot Lee committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
static void
gtk_menu_shell_init (GtkMenuShell *menu_shell)
{
  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->ignore_leave = FALSE;
  menu_shell->button = 0;
  menu_shell->menu_flag = 0;
  menu_shell->activate_time = 0;
}

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)
{
311 312
  GtkMenuShellClass *class;

Elliot Lee's avatar
Elliot Lee committed
313 314 315 316 317
  g_return_if_fail (menu_shell != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (child != NULL);
  g_return_if_fail (GTK_IS_MENU_ITEM (child));

318 319 320 321 322 323 324 325 326 327 328
  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)
{
329 330
  menu_shell->children = g_list_insert (menu_shell->children, child, position);

Elliot Lee's avatar
Elliot Lee committed
331 332
  gtk_widget_set_parent (child, GTK_WIDGET (menu_shell));

333 334
  if (GTK_WIDGET_REALIZED (child->parent))
    gtk_widget_realize (child);
Elliot Lee's avatar
Elliot Lee committed
335

336 337 338
  if (GTK_WIDGET_VISIBLE (child->parent) && GTK_WIDGET_VISIBLE (child))
    {
      if (GTK_WIDGET_MAPPED (child->parent))
Elliot Lee's avatar
Elliot Lee committed
339 340
	gtk_widget_map (child);

341 342
      gtk_widget_queue_resize (child);
    }
Elliot Lee's avatar
Elliot Lee committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
}

void
gtk_menu_shell_deactivate (GtkMenuShell *menu_shell)
{
  g_return_if_fail (menu_shell != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));

  gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[DEACTIVATE]);
}

static void
gtk_menu_shell_map (GtkWidget *widget)
{
  GtkMenuShell *menu_shell;
  GtkWidget *child;
  GList *children;

  g_return_if_fail (widget != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (widget));

  menu_shell = GTK_MENU_SHELL (widget);
  GTK_WIDGET_SET_FLAGS (menu_shell, GTK_MAPPED);

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

      if (GTK_WIDGET_VISIBLE (child) && !GTK_WIDGET_MAPPED (child))
	gtk_widget_map (child);
    }
376 377

  gdk_window_show (widget->window);
Elliot Lee's avatar
Elliot Lee committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
}

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

  g_return_if_fail (widget != NULL);
  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 |
403
			    GDK_KEY_PRESS_MASK |
Elliot Lee's avatar
Elliot Lee committed
404 405 406 407
			    GDK_ENTER_NOTIFY_MASK |
			    GDK_LEAVE_NOTIFY_MASK);

  attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
408
  widget->window = gdk_window_new (gtk_widget_get_parent_window (widget), &attributes, attributes_mask);
Elliot Lee's avatar
Elliot Lee committed
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  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);
}

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

  g_return_val_if_fail (widget != NULL, FALSE);
  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)
    {
433
      return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
Elliot Lee's avatar
Elliot Lee committed
434 435 436 437 438 439 440
    }
  else if (!menu_shell->active || !menu_shell->button)
    {
      if (!menu_shell->active)
	{
	  gtk_grab_add (GTK_WIDGET (widget));
	  menu_shell->have_grab = TRUE;
441
	  menu_shell->active = TRUE;
Elliot Lee's avatar
Elliot Lee committed
442
	}
443 444
      menu_shell->button = event->button;

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

Owen Taylor's avatar
Owen Taylor committed
447 448
      if (menu_item &&
	  GTK_WIDGET_IS_SENSITIVE (menu_item))
Elliot Lee's avatar
Elliot Lee committed
449 450 451
	{
	  if ((menu_item->parent == widget) &&
	      (menu_item != menu_shell->active_menu_item))
452
	    gtk_menu_shell_select_item (menu_shell, menu_item);
Elliot Lee's avatar
Elliot Lee committed
453 454 455 456 457 458
	}
    }
  else
    {
      widget = gtk_get_event_widget ((GdkEvent*) event);
      if (widget == GTK_WIDGET (menu_shell))
Tim Janik's avatar
Tim Janik committed
459 460 461 462
	{
	  gtk_menu_shell_deactivate (menu_shell);
	  gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
	}
Elliot Lee's avatar
Elliot Lee committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
    }

  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 (widget != NULL, FALSE);
  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)
    {
483
      if (menu_shell->button && (event->button != menu_shell->button))
Elliot Lee's avatar
Elliot Lee committed
484
	{
485
	  menu_shell->button = 0;
Elliot Lee's avatar
Elliot Lee committed
486
	  if (menu_shell->parent_menu_shell)
487
	    return gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
Elliot Lee's avatar
Elliot Lee committed
488
	}
489
      
Elliot Lee's avatar
Elliot Lee committed
490
      menu_shell->button = 0;
Owen Taylor's avatar
Owen Taylor committed
491
      menu_item = gtk_menu_shell_get_item (menu_shell, (GdkEvent*) event);
492

Elliot Lee's avatar
Elliot Lee committed
493 494 495 496
      deactivate = TRUE;

      if ((event->time - menu_shell->activate_time) > MENU_SHELL_TIMEOUT)
	{
497 498
	  if (menu_item && (menu_shell->active_menu_item == menu_item) &&
	      GTK_WIDGET_IS_SENSITIVE (menu_item))
Elliot Lee's avatar
Elliot Lee committed
499 500 501
	    {
	      if (GTK_MENU_ITEM (menu_item)->submenu == NULL)
		{
502
		  gtk_menu_shell_activate_item (menu_shell, menu_item, TRUE);
Elliot Lee's avatar
Elliot Lee committed
503 504 505 506 507 508 509 510 511 512 513
		  return TRUE;
		}
	    }
	  else if (menu_shell->parent_menu_shell)
	    {
	      menu_shell->active = TRUE;
	      gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	      return TRUE;
	    }
	}
      else
Owen Taylor's avatar
Owen Taylor committed
514 515 516 517 518 519 520 521 522 523 524
	{
	  /* 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
525 526 527 528 529 530
      
      /* If the button click was very fast, or we ended up on a submenu,
       * leave the menu up
       */
      if (!deactivate || 
	  (menu_item && (menu_shell->active_menu_item == menu_item)))
Elliot Lee's avatar
Elliot Lee committed
531 532 533 534 535 536 537 538
	{
	  deactivate = FALSE;
	  menu_shell->ignore_leave = TRUE;
	}
      else
	deactivate = TRUE;

      if (deactivate)
Tim Janik's avatar
Tim Janik committed
539 540 541 542
	{
	  gtk_menu_shell_deactivate (menu_shell);
	  gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
	}
Elliot Lee's avatar
Elliot Lee committed
543 544 545 546 547
    }

  return TRUE;
}

548 549 550 551 552
static gint
gtk_menu_shell_key_press (GtkWidget	*widget,
			  GdkEventKey *event)
{
  GtkMenuShell *menu_shell;
553
  GtkWidget *toplevel;
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
  
  g_return_val_if_fail (widget != NULL, FALSE);
  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);
  
  if (gtk_bindings_activate (GTK_OBJECT (widget),
			     event->keyval,
			     event->state))
    return TRUE;

569 570
  toplevel = gtk_widget_get_toplevel (widget);
  if (GTK_IS_WINDOW (toplevel) &&
571
      gtk_window_mnemonic_activate (GTK_WINDOW (toplevel),
572 573 574 575
				    event->keyval,
				    event->state))
    return TRUE;
  
576 577 578 579 580 581
  if (gtk_accel_groups_activate (GTK_OBJECT (widget), event->keyval, event->state))
    return TRUE;

  return FALSE;
}

Elliot Lee's avatar
Elliot Lee committed
582 583 584 585 586 587 588 589 590 591 592 593
static gint
gtk_menu_shell_enter_notify (GtkWidget        *widget,
			     GdkEventCrossing *event)
{
  GtkMenuShell *menu_shell;
  GtkWidget *menu_item;

  g_return_val_if_fail (widget != NULL, FALSE);
  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);
594

595
  if (menu_shell->active)
Elliot Lee's avatar
Elliot Lee committed
596 597 598
    {
      menu_item = gtk_get_event_widget ((GdkEvent*) event);

599
      if (!menu_item || !GTK_WIDGET_IS_SENSITIVE (menu_item))
Elliot Lee's avatar
Elliot Lee committed
600
	return TRUE;
601
      
Elliot Lee's avatar
Elliot Lee committed
602 603 604 605
      if ((menu_item->parent == widget) &&
	  (menu_shell->active_menu_item != menu_item) &&
	  GTK_IS_MENU_ITEM (menu_item))
	{
606 607 608
	  if (menu_shell->ignore_enter)
	    return TRUE;
	  
Elliot Lee's avatar
Elliot Lee committed
609 610 611
	  if ((event->detail != GDK_NOTIFY_INFERIOR) &&
	      (GTK_WIDGET_STATE (menu_item) != GTK_STATE_PRELIGHT))
	    {
612
	      gtk_menu_shell_select_item (menu_shell, menu_item);
Elliot Lee's avatar
Elliot Lee committed
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
	    }
	}
      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 (widget != NULL, FALSE);
  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);

641
      if (!event_widget || !GTK_IS_MENU_ITEM (event_widget))
Elliot Lee's avatar
Elliot Lee committed
642 643 644 645 646 647 648 649 650 651
	return TRUE;

      menu_item = GTK_MENU_ITEM (event_widget);

      if (menu_shell->ignore_leave)
	{
	  menu_shell->ignore_leave = FALSE;
	  return TRUE;
	}

Tim Janik's avatar
Tim Janik committed
652 653 654
      if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
	return TRUE;

Elliot Lee's avatar
Elliot Lee committed
655 656 657 658 659 660
      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))
	    {
661
	      gtk_menu_shell_deselect (menu_shell);
Elliot Lee's avatar
Elliot Lee committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
	    }
	}
      else if (menu_shell->parent_menu_shell)
	{
	  gtk_widget_event (menu_shell->parent_menu_shell, (GdkEvent*) event);
	}
    }

  return TRUE;
}

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;
685 686
  gint was_visible;
  
Elliot Lee's avatar
Elliot Lee committed
687 688 689 690
  g_return_if_fail (container != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (container));
  g_return_if_fail (widget != NULL);
  g_return_if_fail (GTK_IS_MENU_ITEM (widget));
691 692
  
  was_visible = GTK_WIDGET_VISIBLE (widget);
Elliot Lee's avatar
Elliot Lee committed
693 694
  menu_shell = GTK_MENU_SHELL (container);
  menu_shell->children = g_list_remove (menu_shell->children, widget);
695
  
696 697 698 699 700 701
  if (widget == menu_shell->active_menu_item)
    {
      gtk_item_deselect (GTK_ITEM (menu_shell->active_menu_item));
      menu_shell->active_menu_item = NULL;
    }

702 703
  gtk_widget_unparent (widget);
  
704 705 706 707
  /* 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
708 709 710 711
    gtk_widget_queue_resize (GTK_WIDGET (container));
}

static void
712 713 714 715
gtk_menu_shell_forall (GtkContainer *container,
		       gboolean      include_internals,
		       GtkCallback   callback,
		       gpointer      callback_data)
Elliot Lee's avatar
Elliot Lee committed
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 751 752 753 754 755 756 757 758 759 760
{
  GtkMenuShell *menu_shell;
  GtkWidget *child;
  GList *children;

  g_return_if_fail (container != NULL);
  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;

      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)
	{
	  menu_shell->have_xgrab = FALSE;
	  gdk_pointer_ungrab (GDK_CURRENT_TIME);
761
	  gdk_keyboard_ungrab (GDK_CURRENT_TIME);
Elliot Lee's avatar
Elliot Lee committed
762 763 764 765 766 767 768 769
	}
    }
}

static gint
gtk_menu_shell_is_item (GtkMenuShell *menu_shell,
			GtkWidget    *child)
{
770
  GtkWidget *parent;
Elliot Lee's avatar
Elliot Lee committed
771 772 773 774 775

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

776
  parent = child->parent;
Elliot Lee's avatar
Elliot Lee committed
777 778
  while (parent && GTK_IS_MENU_SHELL (parent))
    {
779
      if (parent == (GtkWidget*) menu_shell)
Elliot Lee's avatar
Elliot Lee committed
780
	return TRUE;
781
      parent = GTK_MENU_SHELL (parent)->parent_menu_shell;
Elliot Lee's avatar
Elliot Lee committed
782 783 784 785
    }

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

787
static GtkWidget*
Owen Taylor's avatar
Owen Taylor committed
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
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;
}

804 805 806
/* Handlers for action signals */

void
807 808
gtk_menu_shell_select_item (GtkMenuShell *menu_shell,
			    GtkWidget    *menu_item)
809
{
810 811
  GtkMenuShellClass *class;

812 813 814 815 816
  g_return_if_fail (menu_shell != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (menu_item != NULL);
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

817 818 819 820 821 822 823 824 825 826 827
  class = GTK_MENU_SHELL_GET_CLASS (menu_shell);

  if (class->select_item)
    class->select_item (menu_shell, menu_item);
}


static void
gtk_menu_shell_real_select_item (GtkMenuShell *menu_shell,
				 GtkWidget    *menu_item)
{
828
  gtk_menu_shell_deselect (menu_shell);
829 830 831
  
  menu_shell->active_menu_item = menu_item;
  gtk_menu_item_set_placement (GTK_MENU_ITEM (menu_shell->active_menu_item),
832
			       GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement);
833 834 835 836 837 838 839 840 841
  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);
}

842 843
void
gtk_menu_shell_deselect (GtkMenuShell *menu_shell)
844
{
845 846 847 848 849 850 851
  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;
    }
852 853 854 855 856 857 858
}

void
gtk_menu_shell_activate_item (GtkMenuShell      *menu_shell,
			      GtkWidget         *menu_item,
			      gboolean           force_deactivate)
{
859
  GSList *slist, *shells = NULL;
860 861 862 863 864 865 866 867
  gboolean deactivate = force_deactivate;

  g_return_if_fail (menu_shell != NULL);
  g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
  g_return_if_fail (menu_item != NULL);
  g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));

  if (!deactivate)
868
    deactivate = GTK_MENU_ITEM_GET_CLASS (menu_item)->hide_on_activate;
869 870

  gtk_widget_ref (GTK_WIDGET (menu_shell));
871 872 873

  if (deactivate)
    {
874 875 876 877 878 879 880 881 882 883 884
      GtkMenuShell *parent_menu_shell = menu_shell;

      do
	{
	  gtk_widget_ref (GTK_WIDGET (parent_menu_shell));
	  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);

885 886 887 888 889 890 891
      gtk_menu_shell_deactivate (menu_shell);
  
      /* flush the x-queue, so any grabs are removed and
       * the menu is actually taken down
       */
      gdk_flush ();
    }
892

893 894
  gtk_widget_activate (menu_item);

895 896 897 898 899 900 901
  for (slist = shells; slist; slist = slist->next)
    {
      gtk_signal_emit (slist->data, menu_shell_signals[SELECTION_DONE]);
      gtk_widget_unref (slist->data);
    }
  g_slist_free (shells);

902
  gtk_widget_unref (GTK_WIDGET (menu_shell));
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
}

/* 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 && 
920
		 (!node ||
921
		  !GTK_WIDGET_IS_SENSITIVE (node->data) ||
922
		  !GTK_WIDGET_VISIBLE (node->data) ))
923 924 925 926 927 928 929 930 931 932 933
	    {
	      if (!node)
		node = menu_shell->children;
	      else
		node = node->next;
	    }
	}
      else
	{
	  node = node->prev;
	  while (node != start_node &&
934
		 (!node ||
935
		  !GTK_WIDGET_IS_SENSITIVE (node->data) ||
936
		  !GTK_WIDGET_VISIBLE (node->data) ))
937 938 939 940 941 942 943 944 945 946 947 948 949
	    {
	      if (!node)
		node = g_list_last (menu_shell->children);
	      else
		node = node->prev;
	    }
	}
      
      if (node)
	gtk_menu_shell_select_item (menu_shell, node->data);
    }
}

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
static void
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)
    {
      GtkMenuShell *submenu = GTK_MENU_SHELL (menu_item->submenu); 
      if (submenu->children)
	gtk_menu_shell_select_item (submenu, submenu->children->data); 
    }
}

965 966 967 968 969
static void
gtk_real_menu_shell_move_current (GtkMenuShell      *menu_shell,
				  GtkMenuDirectionType direction)
{
  GtkMenuShell *parent_menu_shell = NULL;
970 971 972
  gboolean had_selection;

  had_selection = menu_shell->active_menu_item != NULL;
973 974 975 976 977 978 979 980 981

  if (menu_shell->parent_menu_shell)
    parent_menu_shell = GTK_MENU_SHELL (menu_shell->parent_menu_shell);
  
  switch (direction)
    {
    case GTK_MENU_DIR_PARENT:
      if (parent_menu_shell)
	{
982 983
	  if (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement == 
		       GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement)
984
	    gtk_menu_shell_deselect (menu_shell);
985 986 987 988 989
	  else 
	    {
	      gtk_menu_shell_move_selected (parent_menu_shell, -1);
	      gtk_menu_shell_select_submenu_first (parent_menu_shell); 
	    }
990 991 992 993
	}
      break;
      
    case GTK_MENU_DIR_CHILD:
994 995
      if (menu_shell->active_menu_item &&
	  GTK_BIN (menu_shell->active_menu_item)->child &&
996 997 998 999 1000 1001 1002 1003 1004 1005
	  GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu)
	{
	  menu_shell = GTK_MENU_SHELL (GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu);
	  if (menu_shell->children)
	    gtk_menu_shell_select_item (menu_shell, menu_shell->children->data);
	}
      else
	{
	  /* Try to find a menu running the opposite direction */
	  while (parent_menu_shell && 
1006 1007
		 (GTK_MENU_SHELL_GET_CLASS (parent_menu_shell)->submenu_placement ==
		  GTK_MENU_SHELL_GET_CLASS (menu_shell)->submenu_placement))
1008 1009 1010
	    parent_menu_shell = GTK_MENU_SHELL (parent_menu_shell->parent_menu_shell);
	  
	  if (parent_menu_shell)
1011 1012 1013 1014
	    {
	      gtk_menu_shell_move_selected (parent_menu_shell, 1);
	      gtk_menu_shell_select_submenu_first (parent_menu_shell);
	    }
1015 1016
	}
      break;
1017
      
1018 1019
    case GTK_MENU_DIR_PREV:
      gtk_menu_shell_move_selected (menu_shell, -1);
1020 1021 1022 1023
      if (!had_selection &&
	  !menu_shell->active_menu_item &&
	  menu_shell->children)
	gtk_menu_shell_select_item (menu_shell, g_list_last (menu_shell->children)->data);
1024 1025 1026
      break;
    case GTK_MENU_DIR_NEXT:
      gtk_menu_shell_move_selected (menu_shell, 1);
1027 1028 1029 1030
      if (!had_selection &&
	  !menu_shell->active_menu_item &&
	  menu_shell->children)
	gtk_menu_shell_select_item (menu_shell, menu_shell->children->data);
1031 1032
      break;
    }
1033
  
1034 1035 1036 1037 1038 1039 1040
}

static void
gtk_real_menu_shell_activate_current (GtkMenuShell      *menu_shell,
				      gboolean           force_hide)
{
  if (menu_shell->active_menu_item &&
1041
      GTK_WIDGET_IS_SENSITIVE (menu_shell->active_menu_item) &&
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
      GTK_MENU_ITEM (menu_shell->active_menu_item)->submenu == NULL)
    {
      gtk_menu_shell_activate_item (menu_shell,
				    menu_shell->active_menu_item,
				    force_hide);
    }
}

static void
gtk_real_menu_shell_cancel (GtkMenuShell      *menu_shell)
{
1053 1054 1055 1056
  /* Unset the active menu item so gtk_menu_popdown() doesn't see it.
   */
  gtk_menu_shell_deselect (menu_shell);
  
1057 1058 1059 1060
  gtk_menu_shell_deactivate (menu_shell);
  gtk_signal_emit (GTK_OBJECT (menu_shell), menu_shell_signals[SELECTION_DONE]);
}