Pileus Git - ~andy/gtk/blob - gtk/gtkmenu.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 /**
  26  * SECTION:gtkmenu
  27  * @Short_description: A menu widget
  28  * @Title: GtkMenu
  29  *
  30  * A #GtkMenu is a #GtkMenuShell that implements a drop down menu
  31  * consisting of a list of #GtkMenuItem objects which can be navigated
  32  * and activated by the user to perform application functions.
  33  *
  34  * A #GtkMenu is most commonly dropped down by activating a
  35  * #GtkMenuItem in a #GtkMenuBar or popped up by activating a
  36  * #GtkMenuItem in another #GtkMenu.
  37  *
  38  * A #GtkMenu can also be popped up by activating a #GtkOptionMenu.
  39  * Other composite widgets such as the #GtkNotebook can pop up a
  40  * #GtkMenu as well.
  41  *
  42  * Applications can display a #GtkMenu as a popup menu by calling the
  43  * gtk_menu_popup() function.  The example below shows how an application
  44  * can pop up a menu when the 3rd mouse button is pressed.
  45  *
  46  * <example>
  47  * <title>Connecting the popup signal handler.</title>
  48  * <programlisting>
  49  *   /<!---->* connect our handler which will popup the menu *<!---->/
  50  *   g_signal_connect_swapped (window, "button_press_event",
  51  *      G_CALLBACK (my_popup_handler), menu);
  52  * </programlisting>
  53  * </example>
  54  *
  55  * <example>
  56  * <title>Signal handler which displays a popup menu.</title>
  57  * <programlisting>
  58  * static gint
  59  * my_popup_handler (GtkWidget *widget, GdkEvent *event)
  60  * {
  61  *   GtkMenu *menu;
  62  *   GdkEventButton *event_button;
  63  *
  64  *   g_return_val_if_fail (widget != NULL, FALSE);
  65  *   g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
  66  *   g_return_val_if_fail (event != NULL, FALSE);
  67  *
  68  *   /<!---->* The "widget" is the menu that was supplied when
  69  *    * g_signal_connect_swapped() was called.
  70  *    *<!---->/
  71  *   menu = GTK_MENU (widget);
  72  *
  73  *   if (event->type == GDK_BUTTON_PRESS)
  74  *     {
  75  *       event_button = (GdkEventButton *) event;
  76  *       if (event_button->button == GDK_BUTTON_SECONDARY)
  77  *         {
  78  *           gtk_menu_popup (menu, NULL, NULL, NULL, NULL,
  79  *                           event_button->button, event_button->time);
  80  *           return TRUE;
  81  *         }
  82  *     }
  83  *
  84  *   return FALSE;
  85  * }
  86  * </programlisting>
  87  * </example>
  88  */
  89
  90 #include "config.h"
  91
  92 #include <string.h>
  93
  94 #include  <gobject/gvaluecollector.h>
  95
  96 #include "gtkaccellabel.h"
  97 #include "gtkaccelmap.h"
  98 #include "gtkbindings.h"
  99 #include "gtkcheckmenuitem.h"
 100 #include "gtkmain.h"
 101 #include "gtkmarshalers.h"
 102 #include "gtkmenuprivate.h"
 103 #include "gtkmenuitemprivate.h"
 104 #include "gtkmenushellprivate.h"
 105 #include "gtkwindow.h"
 106 #include "gtkbox.h"
 107 #include "gtkscrollbar.h"
 108 #include "gtksettings.h"
 109 #include "gtkprivate.h"
 110 #include "gtkwidgetprivate.h"
 111 #include "gtkdnd.h"
 112 #include "gtkintl.h"
 113 #include "gtktypebuiltins.h"
 114 #include "gtkwidgetprivate.h"
 115
 116 #include "deprecated/gtktearoffmenuitem.h"
 117
 118
 119 #include "a11y/gtkmenuaccessible.h"
 120
 121 #define NAVIGATION_REGION_OVERSHOOT 50  /* How much the navigation region
 122                                          * extends below the submenu
 123                                          */
 124
 125 #define MENU_SCROLL_STEP1      8
 126 #define MENU_SCROLL_STEP2     15
 127 #define MENU_SCROLL_FAST_ZONE  8
 128 #define MENU_SCROLL_TIMEOUT1  50
 129 #define MENU_SCROLL_TIMEOUT2  20
 130
 131 #define ATTACH_INFO_KEY "gtk-menu-child-attach-info-key"
 132 #define ATTACHED_MENUS "gtk-attached-menus"
 133
 134 typedef struct _GtkMenuAttachData  GtkMenuAttachData;
 135 typedef struct _GtkMenuPopdownData GtkMenuPopdownData;
 136
 137 struct _GtkMenuAttachData
 138 {
 139   GtkWidget *attach_widget;
 140   GtkMenuDetachFunc detacher;
 141 };
 142
 143 struct _GtkMenuPopdownData
 144 {
 145   GtkMenu *menu;
 146   GdkDevice *device;
 147 };
 148
 149 typedef struct
 150 {
 151   gint left_attach;
 152   gint right_attach;
 153   gint top_attach;
 154   gint bottom_attach;
 155   gint effective_left_attach;
 156   gint effective_right_attach;
 157   gint effective_top_attach;
 158   gint effective_bottom_attach;
 159 } AttachInfo;
 160
 161 enum {
 162   MOVE_SCROLL,
 163   LAST_SIGNAL
 164 };
 165
 166 enum {
 167   PROP_0,
 168   PROP_ACTIVE,
 169   PROP_ACCEL_GROUP,
 170   PROP_ACCEL_PATH,
 171   PROP_ATTACH_WIDGET,
 172   PROP_TEAROFF_STATE,
 173   PROP_TEAROFF_TITLE,
 174   PROP_MONITOR,
 175   PROP_RESERVE_TOGGLE_SIZE
 176 };
 177
 178 enum {
 179   CHILD_PROP_0,
 180   CHILD_PROP_LEFT_ATTACH,
 181   CHILD_PROP_RIGHT_ATTACH,
 182   CHILD_PROP_TOP_ATTACH,
 183   CHILD_PROP_BOTTOM_ATTACH
 184 };
 185
 186 static void     gtk_menu_set_property      (GObject          *object,
 187                                             guint             prop_id,
 188                                             const GValue     *value,
 189                                             GParamSpec       *pspec);
 190 static void     gtk_menu_get_property      (GObject          *object,
 191                                             guint             prop_id,
 192                                             GValue           *value,
 193                                             GParamSpec       *pspec);
 194 static void     gtk_menu_set_child_property(GtkContainer     *container,
 195                                             GtkWidget        *child,
 196                                             guint             property_id,
 197                                             const GValue     *value,
 198                                             GParamSpec       *pspec);
 199 static void     gtk_menu_get_child_property(GtkContainer     *container,
 200                                             GtkWidget        *child,
 201                                             guint             property_id,
 202                                             GValue           *value,
 203                                             GParamSpec       *pspec);
 204 static void     gtk_menu_destroy           (GtkWidget        *widget);
 205 static void     gtk_menu_realize           (GtkWidget        *widget);
 206 static void     gtk_menu_unrealize         (GtkWidget        *widget);
 207 static void     gtk_menu_size_allocate     (GtkWidget        *widget,
 208                                             GtkAllocation    *allocation);
 209 static void     gtk_menu_show              (GtkWidget        *widget);
 210 static gboolean gtk_menu_draw              (GtkWidget        *widget,
 211                                             cairo_t          *cr);
 212 static gboolean gtk_menu_key_press         (GtkWidget        *widget,
 213                                             GdkEventKey      *event);
 214 static gboolean gtk_menu_scroll            (GtkWidget        *widget,
 215                                             GdkEventScroll   *event);
 216 static gboolean gtk_menu_button_press      (GtkWidget        *widget,
 217                                             GdkEventButton   *event);
 218 static gboolean gtk_menu_button_release    (GtkWidget        *widget,
 219                                             GdkEventButton   *event);
 220 static gboolean gtk_menu_motion_notify     (GtkWidget        *widget,
 221                                             GdkEventMotion   *event);
 222 static gboolean gtk_menu_enter_notify      (GtkWidget        *widget,
 223                                             GdkEventCrossing *event);
 224 static gboolean gtk_menu_leave_notify      (GtkWidget        *widget,
 225                                             GdkEventCrossing *event);
 226 static void     gtk_menu_scroll_to         (GtkMenu          *menu,
 227                                             gint              offset);
 228 static void     gtk_menu_grab_notify       (GtkWidget        *widget,
 229                                             gboolean          was_grabbed);
 230 static gboolean gtk_menu_captured_event    (GtkWidget        *widget,
 231                                             GdkEvent         *event);
 232
 233
 234 static void     gtk_menu_stop_scrolling         (GtkMenu  *menu);
 235 static void     gtk_menu_remove_scroll_timeout  (GtkMenu  *menu);
 236 static gboolean gtk_menu_scroll_timeout         (gpointer  data);
 237 static gboolean gtk_menu_scroll_timeout_initial (gpointer  data);
 238 static void     gtk_menu_start_scrolling        (GtkMenu  *menu);
 239
 240 static void     gtk_menu_scroll_item_visible (GtkMenuShell    *menu_shell,
 241                                               GtkWidget       *menu_item);
 242 static void     gtk_menu_select_item       (GtkMenuShell     *menu_shell,
 243                                             GtkWidget        *menu_item);
 244 static void     gtk_menu_real_insert       (GtkMenuShell     *menu_shell,
 245                                             GtkWidget        *child,
 246                                             gint              position);
 247 static void     gtk_menu_scrollbar_changed (GtkAdjustment    *adjustment,
 248                                             GtkMenu          *menu);
 249 static void     gtk_menu_handle_scrolling  (GtkMenu          *menu,
 250                                             gint              event_x,
 251                                             gint              event_y,
 252                                             gboolean          enter,
 253                                             gboolean          motion);
 254 static void     gtk_menu_set_tearoff_hints (GtkMenu          *menu,
 255                                             gint             width);
 256 static void     gtk_menu_style_updated     (GtkWidget        *widget);
 257 static gboolean gtk_menu_focus             (GtkWidget        *widget,
 258                                             GtkDirectionType direction);
 259 static gint     gtk_menu_get_popup_delay   (GtkMenuShell     *menu_shell);
 260 static void     gtk_menu_move_current      (GtkMenuShell     *menu_shell,
 261                                             GtkMenuDirectionType direction);
 262 static void     gtk_menu_real_move_scroll  (GtkMenu          *menu,
 263                                             GtkScrollType     type);
 264
 265 static void     gtk_menu_stop_navigating_submenu       (GtkMenu          *menu);
 266 static gboolean gtk_menu_stop_navigating_submenu_cb    (gpointer          user_data);
 267 static gboolean gtk_menu_navigating_submenu            (GtkMenu          *menu,
 268                                                         gint              event_x,
 269                                                         gint              event_y);
 270 static void     gtk_menu_set_submenu_navigation_region (GtkMenu          *menu,
 271                                                         GtkMenuItem      *menu_item,
 272                                                         GdkEventCrossing *event);
 273
 274 static void gtk_menu_deactivate     (GtkMenuShell      *menu_shell);
 275 static void gtk_menu_show_all       (GtkWidget         *widget);
 276 static void gtk_menu_position       (GtkMenu           *menu,
 277                                      gboolean           set_scroll_offset);
 278 static void gtk_menu_reparent       (GtkMenu           *menu,
 279                                      GtkWidget         *new_parent,
 280                                      gboolean           unrealize);
 281 static void gtk_menu_remove         (GtkContainer      *menu,
 282                                      GtkWidget         *widget);
 283
 284 static void gtk_menu_update_title   (GtkMenu           *menu);
 285
 286 static void       menu_grab_transfer_window_destroy (GtkMenu *menu);
 287 static GdkWindow *menu_grab_transfer_window_get     (GtkMenu *menu);
 288
 289 static gboolean gtk_menu_real_can_activate_accel (GtkWidget *widget,
 290                                                   guint      signal_id);
 291 static void _gtk_menu_refresh_accel_paths (GtkMenu *menu,
 292                                            gboolean group_changed);
 293
 294 static void gtk_menu_get_preferred_width            (GtkWidget           *widget,
 295                                                      gint                *minimum_size,
 296                                                      gint                *natural_size);
 297 static void gtk_menu_get_preferred_height           (GtkWidget           *widget,
 298                                                      gint                *minimum_size,
 299                                                      gint                *natural_size);
 300 static void gtk_menu_get_preferred_height_for_width (GtkWidget           *widget,
 301                                                      gint                 for_size,
 302                                                      gint                *minimum_size,
 303                                                      gint                *natural_size);
 304
 305
 306 static const gchar attach_data_key[] = "gtk-menu-attach-data";
 307
 308 static guint menu_signals[LAST_SIGNAL] = { 0 };
 309
 310 G_DEFINE_TYPE (GtkMenu, gtk_menu, GTK_TYPE_MENU_SHELL)
 311
 312 static void
 313 menu_queue_resize (GtkMenu *menu)
 314 {
 315   GtkMenuPrivate *priv = menu->priv;
 316
 317   priv->have_layout = FALSE;
 318   gtk_widget_queue_resize (GTK_WIDGET (menu));
 319 }
 320
 321 static void
 322 attach_info_free (AttachInfo *info)
 323 {
 324   g_slice_free (AttachInfo, info);
 325 }
 326
 327 static AttachInfo *
 328 get_attach_info (GtkWidget *child)
 329 {
 330   GObject *object = G_OBJECT (child);
 331   AttachInfo *ai = g_object_get_data (object, ATTACH_INFO_KEY);
 332
 333   if (!ai)
 334     {
 335       ai = g_slice_new0 (AttachInfo);
 336       g_object_set_data_full (object, I_(ATTACH_INFO_KEY), ai,
 337                               (GDestroyNotify) attach_info_free);
 338     }
 339
 340   return ai;
 341 }
 342
 343 static gboolean
 344 is_grid_attached (AttachInfo *ai)
 345 {
 346   return (ai->left_attach >= 0 &&
 347           ai->right_attach >= 0 &&
 348           ai->top_attach >= 0 &&
 349           ai->bottom_attach >= 0);
 350 }
 351
 352 static void
 353 menu_ensure_layout (GtkMenu *menu)
 354 {
 355   GtkMenuPrivate *priv = menu->priv;
 356
 357   if (!priv->have_layout)
 358     {
 359       GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
 360       GList *l;
 361       gchar *row_occupied;
 362       gint current_row;
 363       gint max_right_attach;
 364       gint max_bottom_attach;
 365
 366       /* Find extents of gridded portion
 367        */
 368       max_right_attach = 1;
 369       max_bottom_attach = 0;
 370
 371       for (l = menu_shell->priv->children; l; l = l->next)
 372         {
 373           GtkWidget *child = l->data;
 374           AttachInfo *ai = get_attach_info (child);
 375
 376           if (is_grid_attached (ai))
 377             {
 378               max_bottom_attach = MAX (max_bottom_attach, ai->bottom_attach);
 379               max_right_attach = MAX (max_right_attach, ai->right_attach);
 380             }
 381         }
 382
 383       /* Find empty rows */
 384       row_occupied = g_malloc0 (max_bottom_attach);
 385
 386       for (l = menu_shell->priv->children; l; l = l->next)
 387         {
 388           GtkWidget *child = l->data;
 389           AttachInfo *ai = get_attach_info (child);
 390
 391           if (is_grid_attached (ai))
 392             {
 393               gint i;
 394
 395               for (i = ai->top_attach; i < ai->bottom_attach; i++)
 396                 row_occupied[i] = TRUE;
 397             }
 398         }
 399
 400       /* Lay non-grid-items out in those rows
 401        */
 402       current_row = 0;
 403       for (l = menu_shell->priv->children; l; l = l->next)
 404         {
 405           GtkWidget *child = l->data;
 406           AttachInfo *ai = get_attach_info (child);
 407
 408           if (!is_grid_attached (ai))
 409             {
 410               while (current_row < max_bottom_attach && row_occupied[current_row])
 411                 current_row++;
 412
 413               ai->effective_left_attach = 0;
 414               ai->effective_right_attach = max_right_attach;
 415               ai->effective_top_attach = current_row;
 416               ai->effective_bottom_attach = current_row + 1;
 417
 418               current_row++;
 419             }
 420           else
 421             {
 422               ai->effective_left_attach = ai->left_attach;
 423               ai->effective_right_attach = ai->right_attach;
 424               ai->effective_top_attach = ai->top_attach;
 425               ai->effective_bottom_attach = ai->bottom_attach;
 426             }
 427         }
 428
 429       g_free (row_occupied);
 430
 431       priv->n_rows = MAX (current_row, max_bottom_attach);
 432       priv->n_columns = max_right_attach;
 433       priv->have_layout = TRUE;
 434     }
 435 }
 436
 437
 438 static gint
 439 gtk_menu_get_n_columns (GtkMenu *menu)
 440 {
 441   GtkMenuPrivate *priv = menu->priv;
 442
 443   menu_ensure_layout (menu);
 444
 445   return priv->n_columns;
 446 }
 447
 448 static gint
 449 gtk_menu_get_n_rows (GtkMenu *menu)
 450 {
 451   GtkMenuPrivate *priv = menu->priv;
 452
 453   menu_ensure_layout (menu);
 454
 455   return priv->n_rows;
 456 }
 457
 458 static void
 459 get_effective_child_attach (GtkWidget *child,
 460                             int       *l,
 461                             int       *r,
 462                             int       *t,
 463                             int       *b)
 464 {
 465   GtkMenu *menu = GTK_MENU (gtk_widget_get_parent (child));
 466   AttachInfo *ai;
 467
 468   menu_ensure_layout (menu);
 469
 470   ai = get_attach_info (child);
 471
 472   if (l)
 473     *l = ai->effective_left_attach;
 474   if (r)
 475     *r = ai->effective_right_attach;
 476   if (t)
 477     *t = ai->effective_top_attach;
 478   if (b)
 479     *b = ai->effective_bottom_attach;
 480
 481 }
 482
 483 static void
 484 gtk_menu_class_init (GtkMenuClass *class)
 485 {
 486   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
 487   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
 488   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (class);
 489   GtkMenuShellClass *menu_shell_class = GTK_MENU_SHELL_CLASS (class);
 490   GtkBindingSet *binding_set;
 491
 492   gobject_class->set_property = gtk_menu_set_property;
 493   gobject_class->get_property = gtk_menu_get_property;
 494
 495   widget_class->destroy = gtk_menu_destroy;
 496   widget_class->realize = gtk_menu_realize;
 497   widget_class->unrealize = gtk_menu_unrealize;
 498   widget_class->size_allocate = gtk_menu_size_allocate;
 499   widget_class->show = gtk_menu_show;
 500   widget_class->draw = gtk_menu_draw;
 501   widget_class->scroll_event = gtk_menu_scroll;
 502   widget_class->key_press_event = gtk_menu_key_press;
 503   widget_class->button_press_event = gtk_menu_button_press;
 504   widget_class->button_release_event = gtk_menu_button_release;
 505   widget_class->motion_notify_event = gtk_menu_motion_notify;
 506   widget_class->show_all = gtk_menu_show_all;
 507   widget_class->enter_notify_event = gtk_menu_enter_notify;
 508   widget_class->leave_notify_event = gtk_menu_leave_notify;
 509   widget_class->style_updated = gtk_menu_style_updated;
 510   widget_class->focus = gtk_menu_focus;
 511   widget_class->can_activate_accel = gtk_menu_real_can_activate_accel;
 512   widget_class->grab_notify = gtk_menu_grab_notify;
 513   widget_class->get_preferred_width = gtk_menu_get_preferred_width;
 514   widget_class->get_preferred_height = gtk_menu_get_preferred_height;
 515   widget_class->get_preferred_height_for_width = gtk_menu_get_preferred_height_for_width;
 516
 517   container_class->remove = gtk_menu_remove;
 518   container_class->get_child_property = gtk_menu_get_child_property;
 519   container_class->set_child_property = gtk_menu_set_child_property;
 520
 521   menu_shell_class->submenu_placement = GTK_LEFT_RIGHT;
 522   menu_shell_class->deactivate = gtk_menu_deactivate;
 523   menu_shell_class->select_item = gtk_menu_select_item;
 524   menu_shell_class->insert = gtk_menu_real_insert;
 525   menu_shell_class->get_popup_delay = gtk_menu_get_popup_delay;
 526   menu_shell_class->move_current = gtk_menu_move_current;
 527
 528   /**
 529    * GtkMenu::move-scroll:
 530    * @menu: a #GtkMenu
 531    * @scroll_type: a #GtkScrollType
 532    */
 533   menu_signals[MOVE_SCROLL] =
 534     g_signal_new_class_handler (I_("move-scroll"),
 535                                 G_OBJECT_CLASS_TYPE (gobject_class),
 536                                 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
 537                                 G_CALLBACK (gtk_menu_real_move_scroll),
 538                                 NULL, NULL,
 539                                 _gtk_marshal_VOID__ENUM,
 540                                 G_TYPE_NONE, 1,
 541                                 GTK_TYPE_SCROLL_TYPE);
 542
 543   /**
 544    * GtkMenu:active:
 545    *
 546    * The index of the currently selected menu item, or -1 if no
 547    * menu item is selected.
 548    *
 549    * Since: 2.14
 550    **/
 551   g_object_class_install_property (gobject_class,
 552                                    PROP_ACTIVE,
 553                                    g_param_spec_int ("active",
 554                                                      P_("Active"),
 555                                                      P_("The currently selected menu item"),
 556                                                      -1, G_MAXINT, -1,
 557                                                      GTK_PARAM_READWRITE));
 558
 559   /**
 560    * GtkMenu:accel-group:
 561    *
 562    * The accel group holding accelerators for the menu.
 563    *
 564    * Since: 2.14
 565    **/
 566   g_object_class_install_property (gobject_class,
 567                                    PROP_ACCEL_GROUP,
 568                                    g_param_spec_object ("accel-group",
 569                                                         P_("Accel Group"),
 570                                                         P_("The accel group holding accelerators for the menu"),
 571                                                         GTK_TYPE_ACCEL_GROUP,
 572                                                         GTK_PARAM_READWRITE));
 573
 574   /**
 575    * GtkMenu:accel-path:
 576    *
 577    * An accel path used to conveniently construct accel paths of child items.
 578    *
 579    * Since: 2.14
 580    **/
 581   g_object_class_install_property (gobject_class,
 582                                    PROP_ACCEL_PATH,
 583                                    g_param_spec_string ("accel-path",
 584                                                         P_("Accel Path"),
 585                                                         P_("An accel path used to conveniently construct accel paths of child items"),
 586                                                         NULL,
 587                                                         GTK_PARAM_READWRITE));
 588
 589   /**
 590    * GtkMenu:attach-widget:
 591    *
 592    * The widget the menu is attached to. Setting this property attaches
 593    * the menu without a #GtkMenuDetachFunc. If you need to use a detacher,
 594    * use gtk_menu_attach_to_widget() directly.
 595    *
 596    * Since: 2.14
 597    **/
 598   g_object_class_install_property (gobject_class,
 599                                    PROP_ATTACH_WIDGET,
 600                                    g_param_spec_object ("attach-widget",
 601                                                         P_("Attach Widget"),
 602                                                         P_("The widget the menu is attached to"),
 603                                                         GTK_TYPE_WIDGET,
 604                                                         GTK_PARAM_READWRITE));
 605
 606   g_object_class_install_property (gobject_class,
 607                                    PROP_TEAROFF_TITLE,
 608                                    g_param_spec_string ("tearoff-title",
 609                                                         P_("Tearoff Title"),
 610                                                         P_("A title that may be displayed by the window manager when this menu is torn-off"),
 611                                                         NULL,
 612                                                         GTK_PARAM_READWRITE));
 613
 614   /**
 615    * GtkMenu:tearoff-state:
 616    *
 617    * A boolean that indicates whether the menu is torn-off.
 618    *
 619    * Since: 2.6
 620    **/
 621   g_object_class_install_property (gobject_class,
 622                                    PROP_TEAROFF_STATE,
 623                                    g_param_spec_boolean ("tearoff-state",
 624                                                          P_("Tearoff State"),
 625                                                          P_("A boolean that indicates whether the menu is torn-off"),
 626                                                          FALSE,
 627                                                          GTK_PARAM_READWRITE));
 628
 629   /**
 630    * GtkMenu:monitor:
 631    *
 632    * The monitor the menu will be popped up on.
 633    *
 634    * Since: 2.14
 635    **/
 636   g_object_class_install_property (gobject_class,
 637                                    PROP_MONITOR,
 638                                    g_param_spec_int ("monitor",
 639                                                      P_("Monitor"),
 640                                                      P_("The monitor the menu will be popped up on"),
 641                                                      -1, G_MAXINT, -1,
 642                                                      GTK_PARAM_READWRITE));
 643
 644   gtk_widget_class_install_style_property (widget_class,
 645                                            g_param_spec_int ("vertical-padding",
 646                                                              P_("Vertical Padding"),
 647                                                              P_("Extra space at the top and bottom of the menu"),
 648                                                              0,
 649                                                              G_MAXINT,
 650                                                              1,
 651                                                              GTK_PARAM_READABLE));
 652
 653   /**
 654    * GtkMenu:reserve-toggle-size:
 655    *
 656    * A boolean that indicates whether the menu reserves space for
 657    * toggles and icons, regardless of their actual presence.
 658    *
 659    * This property should only be changed from its default value
 660    * for special-purposes such as tabular menus. Regular menus that
 661    * are connected to a menu bar or context menus should reserve
 662    * toggle space for consistency.
 663    *
 664    * Since: 2.18
 665    */
 666   g_object_class_install_property (gobject_class,
 667                                    PROP_RESERVE_TOGGLE_SIZE,
 668                                    g_param_spec_boolean ("reserve-toggle-size",
 669                                                          P_("Reserve Toggle Size"),
 670                                                          P_("A boolean that indicates whether the menu reserves space for toggles and icons"),
 671                                                          TRUE,
 672                                                          GTK_PARAM_READWRITE));
 673
 674   gtk_widget_class_install_style_property (widget_class,
 675                                            g_param_spec_int ("horizontal-padding",
 676                                                              P_("Horizontal Padding"),
 677                                                              P_("Extra space at the left and right edges of the menu"),
 678                                                              0,
 679                                                              G_MAXINT,
 680                                                              0,
 681                                                              GTK_PARAM_READABLE));
 682
 683   gtk_widget_class_install_style_property (widget_class,
 684                                            g_param_spec_int ("vertical-offset",
 685                                                              P_("Vertical Offset"),
 686                                                              P_("When the menu is a submenu, position it this number of pixels offset vertically"),
 687                                                              G_MININT,
 688                                                              G_MAXINT,
 689                                                              0,
 690                                                              GTK_PARAM_READABLE));
 691
 692   gtk_widget_class_install_style_property (widget_class,
 693                                            g_param_spec_int ("horizontal-offset",
 694                                                              P_("Horizontal Offset"),
 695                                                              P_("When the menu is a submenu, position it this number of pixels offset horizontally"),
 696                                                              G_MININT,
 697                                                              G_MAXINT,
 698                                                              -2,
 699                                                              GTK_PARAM_READABLE));
 700
 701   gtk_widget_class_install_style_property (widget_class,
 702                                            g_param_spec_boolean ("double-arrows",
 703                                                                  P_("Double Arrows"),
 704                                                                  P_("When scrolling, always show both arrows."),
 705                                                                  TRUE,
 706                                                                  GTK_PARAM_READABLE));
 707
 708   /**
 709    * GtkMenu:arrow-placement:
 710    *
 711    * Indicates where scroll arrows should be placed.
 712    *
 713    * Since: 2.16
 714    **/
 715   gtk_widget_class_install_style_property (widget_class,
 716                                            g_param_spec_enum ("arrow-placement",
 717                                                               P_("Arrow Placement"),
 718                                                               P_("Indicates where scroll arrows should be placed"),
 719                                                               GTK_TYPE_ARROW_PLACEMENT,
 720                                                               GTK_ARROWS_BOTH,
 721                                                               GTK_PARAM_READABLE));
 722
 723  gtk_container_class_install_child_property (container_class,
 724                                              CHILD_PROP_LEFT_ATTACH,
 725                                               g_param_spec_int ("left-attach",
 726                                                                P_("Left Attach"),
 727                                                                P_("The column number to attach the left side of the child to"),
 728                                                                 -1, INT_MAX, -1,
 729                                                                GTK_PARAM_READWRITE));
 730
 731  gtk_container_class_install_child_property (container_class,
 732                                              CHILD_PROP_RIGHT_ATTACH,
 733                                               g_param_spec_int ("right-attach",
 734                                                                P_("Right Attach"),
 735                                                                P_("The column number to attach the right side of the child to"),
 736                                                                 -1, INT_MAX, -1,
 737                                                                GTK_PARAM_READWRITE));
 738
 739  gtk_container_class_install_child_property (container_class,
 740                                              CHILD_PROP_TOP_ATTACH,
 741                                               g_param_spec_int ("top-attach",
 742                                                                P_("Top Attach"),
 743                                                                P_("The row number to attach the top of the child to"),
 744                                                                 -1, INT_MAX, -1,
 745                                                                GTK_PARAM_READWRITE));
 746
 747  gtk_container_class_install_child_property (container_class,
 748                                              CHILD_PROP_BOTTOM_ATTACH,
 749                                               g_param_spec_int ("bottom-attach",
 750                                                                P_("Bottom Attach"),
 751                                                                P_("The row number to attach the bottom of the child to"),
 752                                                                 -1, INT_MAX, -1,
 753                                                                GTK_PARAM_READWRITE));
 754
 755  /**
 756   * GtkMenu:arrow-scaling
 757   *
 758   * Arbitrary constant to scale down the size of the scroll arrow.
 759   *
 760   * Since: 2.16
 761   */
 762   gtk_widget_class_install_style_property (widget_class,
 763                                            g_param_spec_float ("arrow-scaling",
 764                                                                P_("Arrow Scaling"),
 765                                                                P_("Arbitrary constant to scale down the size of the scroll arrow"),
 766                                                                0.0, 1.0, 0.7,
 767                                                                GTK_PARAM_READABLE));
 768
 769   binding_set = gtk_binding_set_by_class (class);
 770   gtk_binding_entry_add_signal (binding_set,
 771                                 GDK_KEY_Up, 0,
 772                                 I_("move-current"), 1,
 773                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 774                                 GTK_MENU_DIR_PREV);
 775   gtk_binding_entry_add_signal (binding_set,
 776                                 GDK_KEY_KP_Up, 0,
 777                                 "move-current", 1,
 778                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 779                                 GTK_MENU_DIR_PREV);
 780   gtk_binding_entry_add_signal (binding_set,
 781                                 GDK_KEY_Down, 0,
 782                                 "move-current", 1,
 783                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 784                                 GTK_MENU_DIR_NEXT);
 785   gtk_binding_entry_add_signal (binding_set,
 786                                 GDK_KEY_KP_Down, 0,
 787                                 "move-current", 1,
 788                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 789                                 GTK_MENU_DIR_NEXT);
 790   gtk_binding_entry_add_signal (binding_set,
 791                                 GDK_KEY_Left, 0,
 792                                 "move-current", 1,
 793                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 794                                 GTK_MENU_DIR_PARENT);
 795   gtk_binding_entry_add_signal (binding_set,
 796                                 GDK_KEY_KP_Left, 0,
 797                                 "move-current", 1,
 798                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 799                                 GTK_MENU_DIR_PARENT);
 800   gtk_binding_entry_add_signal (binding_set,
 801                                 GDK_KEY_Right, 0,
 802                                 "move-current", 1,
 803                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 804                                 GTK_MENU_DIR_CHILD);
 805   gtk_binding_entry_add_signal (binding_set,
 806                                 GDK_KEY_KP_Right, 0,
 807                                 "move-current", 1,
 808                                 GTK_TYPE_MENU_DIRECTION_TYPE,
 809                                 GTK_MENU_DIR_CHILD);
 810   gtk_binding_entry_add_signal (binding_set,
 811                                 GDK_KEY_Home, 0,
 812                                 "move-scroll", 1,
 813                                 GTK_TYPE_SCROLL_TYPE,
 814                                 GTK_SCROLL_START);
 815   gtk_binding_entry_add_signal (binding_set,
 816                                 GDK_KEY_KP_Home, 0,
 817                                 "move-scroll", 1,
 818                                 GTK_TYPE_SCROLL_TYPE,
 819                                 GTK_SCROLL_START);
 820   gtk_binding_entry_add_signal (binding_set,
 821                                 GDK_KEY_End, 0,
 822                                 "move-scroll", 1,
 823                                 GTK_TYPE_SCROLL_TYPE,
 824                                 GTK_SCROLL_END);
 825   gtk_binding_entry_add_signal (binding_set,
 826                                 GDK_KEY_KP_End, 0,
 827                                 "move-scroll", 1,
 828                                 GTK_TYPE_SCROLL_TYPE,
 829                                 GTK_SCROLL_END);
 830   gtk_binding_entry_add_signal (binding_set,
 831                                 GDK_KEY_Page_Up, 0,
 832                                 "move-scroll", 1,
 833                                 GTK_TYPE_SCROLL_TYPE,
 834                                 GTK_SCROLL_PAGE_UP);
 835   gtk_binding_entry_add_signal (binding_set,
 836                                 GDK_KEY_KP_Page_Up, 0,
 837                                 "move-scroll", 1,
 838                                 GTK_TYPE_SCROLL_TYPE,
 839                                 GTK_SCROLL_PAGE_UP);
 840   gtk_binding_entry_add_signal (binding_set,
 841                                 GDK_KEY_Page_Down, 0,
 842                                 "move-scroll", 1,
 843                                 GTK_TYPE_SCROLL_TYPE,
 844                                 GTK_SCROLL_PAGE_DOWN);
 845   gtk_binding_entry_add_signal (binding_set,
 846                                 GDK_KEY_KP_Page_Down, 0,
 847                                 "move-scroll", 1,
 848                                 GTK_TYPE_SCROLL_TYPE,
 849                                 GTK_SCROLL_PAGE_DOWN);
 850
 851   g_type_class_add_private (gobject_class, sizeof (GtkMenuPrivate));
 852
 853   gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_MENU_ACCESSIBLE);
 854 }
 855
 856
 857 static void
 858 gtk_menu_set_property (GObject      *object,
 859                        guint         prop_id,
 860                        const GValue *value,
 861                        GParamSpec   *pspec)
 862 {
 863   GtkMenu *menu = GTK_MENU (object);
 864
 865   switch (prop_id)
 866     {
 867     case PROP_ACTIVE:
 868       gtk_menu_set_active (menu, g_value_get_int (value));
 869       break;
 870     case PROP_ACCEL_GROUP:
 871       gtk_menu_set_accel_group (menu, g_value_get_object (value));
 872       break;
 873     case PROP_ACCEL_PATH:
 874       gtk_menu_set_accel_path (menu, g_value_get_string (value));
 875       break;
 876     case PROP_ATTACH_WIDGET:
 877       {
 878         GtkWidget *widget;
 879
 880         widget = gtk_menu_get_attach_widget (menu);
 881         if (widget)
 882           gtk_menu_detach (menu);
 883
 884         widget = (GtkWidget*) g_value_get_object (value);
 885         if (widget)
 886           gtk_menu_attach_to_widget (menu, widget, NULL);
 887       }
 888       break;
 889     case PROP_TEAROFF_STATE:
 890       gtk_menu_set_tearoff_state (menu, g_value_get_boolean (value));
 891       break;
 892     case PROP_TEAROFF_TITLE:
 893       gtk_menu_set_title (menu, g_value_get_string (value));
 894       break;
 895     case PROP_MONITOR:
 896       gtk_menu_set_monitor (menu, g_value_get_int (value));
 897       break;
 898     case PROP_RESERVE_TOGGLE_SIZE:
 899       gtk_menu_set_reserve_toggle_size (menu, g_value_get_boolean (value));
 900       break;
 901     default:
 902       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 903       break;
 904     }
 905 }
 906
 907 static void
 908 gtk_menu_get_property (GObject     *object,
 909                        guint        prop_id,
 910                        GValue      *value,
 911                        GParamSpec  *pspec)
 912 {
 913   GtkMenu *menu = GTK_MENU (object);
 914
 915   switch (prop_id)
 916     {
 917     case PROP_ACTIVE:
 918       g_value_set_int (value, g_list_index (GTK_MENU_SHELL (menu)->priv->children, gtk_menu_get_active (menu)));
 919       break;
 920     case PROP_ACCEL_GROUP:
 921       g_value_set_object (value, gtk_menu_get_accel_group (menu));
 922       break;
 923     case PROP_ACCEL_PATH:
 924       g_value_set_string (value, gtk_menu_get_accel_path (menu));
 925       break;
 926     case PROP_ATTACH_WIDGET:
 927       g_value_set_object (value, gtk_menu_get_attach_widget (menu));
 928       break;
 929     case PROP_TEAROFF_STATE:
 930       g_value_set_boolean (value, gtk_menu_get_tearoff_state (menu));
 931       break;
 932     case PROP_TEAROFF_TITLE:
 933       g_value_set_string (value, gtk_menu_get_title (menu));
 934       break;
 935     case PROP_MONITOR:
 936       g_value_set_int (value, gtk_menu_get_monitor (menu));
 937       break;
 938     case PROP_RESERVE_TOGGLE_SIZE:
 939       g_value_set_boolean (value, gtk_menu_get_reserve_toggle_size (menu));
 940       break;
 941     default:
 942       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 943       break;
 944     }
 945 }
 946
 947 static void
 948 gtk_menu_set_child_property (GtkContainer *container,
 949                              GtkWidget    *child,
 950                              guint         property_id,
 951                              const GValue *value,
 952                              GParamSpec   *pspec)
 953 {
 954   GtkMenu *menu = GTK_MENU (container);
 955   AttachInfo *ai = get_attach_info (child);
 956
 957   switch (property_id)
 958     {
 959     case CHILD_PROP_LEFT_ATTACH:
 960       ai->left_attach = g_value_get_int (value);
 961       break;
 962     case CHILD_PROP_RIGHT_ATTACH:
 963       ai->right_attach = g_value_get_int (value);
 964       break;
 965     case CHILD_PROP_TOP_ATTACH:
 966       ai->top_attach = g_value_get_int (value);
 967       break;
 968     case CHILD_PROP_BOTTOM_ATTACH:
 969       ai->bottom_attach = g_value_get_int (value);
 970       break;
 971
 972     default:
 973       GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
 974       return;
 975     }
 976
 977   menu_queue_resize (menu);
 978 }
 979
 980 static void
 981 gtk_menu_get_child_property (GtkContainer *container,
 982                              GtkWidget    *child,
 983                              guint         property_id,
 984                              GValue       *value,
 985                              GParamSpec   *pspec)
 986 {
 987   AttachInfo *ai = get_attach_info (child);
 988
 989   switch (property_id)
 990     {
 991     case CHILD_PROP_LEFT_ATTACH:
 992       g_value_set_int (value, ai->left_attach);
 993       break;
 994     case CHILD_PROP_RIGHT_ATTACH:
 995       g_value_set_int (value, ai->right_attach);
 996       break;
 997     case CHILD_PROP_TOP_ATTACH:
 998       g_value_set_int (value, ai->top_attach);
 999       break;
1000     case CHILD_PROP_BOTTOM_ATTACH:
1001       g_value_set_int (value, ai->bottom_attach);
1002       break;
1003
1004     default:
1005       GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
1006       return;
1007     }
1008 }
1009
1010 static gboolean
1011 gtk_menu_window_event (GtkWidget *window,
1012                        GdkEvent  *event,
1013                        GtkWidget *menu)
1014 {
1015   gboolean handled = FALSE;
1016
1017   g_object_ref (window);
1018   g_object_ref (menu);
1019
1020   switch (event->type)
1021     {
1022     case GDK_KEY_PRESS:
1023     case GDK_KEY_RELEASE:
1024       handled = gtk_widget_event (menu, event);
1025       break;
1026     case GDK_WINDOW_STATE:
1027       /* Window for the menu has been closed by the display server or by GDK.
1028        * Update the internal state as if the user had clicked outside the
1029        * menu
1030        */
1031       if (event->window_state.new_window_state & GDK_WINDOW_STATE_WITHDRAWN &&
1032           event->window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1033         gtk_menu_shell_deactivate (GTK_MENU_SHELL(menu));
1034       break;
1035     default:
1036       break;
1037     }
1038
1039   g_object_unref (window);
1040   g_object_unref (menu);
1041
1042   return handled;
1043 }
1044
1045 static void
1046 gtk_menu_init (GtkMenu *menu)
1047 {
1048   GtkMenuPrivate *priv;
1049   GtkStyleContext *context;
1050
1051   priv = G_TYPE_INSTANCE_GET_PRIVATE (menu, GTK_TYPE_MENU, GtkMenuPrivate);
1052
1053   menu->priv = priv;
1054
1055   priv->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
1056                                                    "type", GTK_WINDOW_POPUP,
1057                                                    "child", menu,
1058                                                    NULL),
1059                                      "signal::event", gtk_menu_window_event, menu,
1060                                      "signal::destroy", gtk_widget_destroyed, &priv->toplevel,
1061                                      NULL);
1062   gtk_window_set_resizable (GTK_WINDOW (priv->toplevel), FALSE);
1063   gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->toplevel), 0);
1064
1065   /* Refloat the menu, so that reference counting for the menu isn't
1066    * affected by it being a child of the toplevel
1067    */
1068   g_object_force_floating (G_OBJECT (menu));
1069   priv->needs_destruction_ref = TRUE;
1070
1071   priv->monitor_num = -1;
1072   priv->drag_start_y = -1;
1073
1074   context = gtk_widget_get_style_context (GTK_WIDGET (menu));
1075   gtk_style_context_add_class (context, GTK_STYLE_CLASS_MENU);
1076
1077   _gtk_widget_set_captured_event_handler (GTK_WIDGET (menu), gtk_menu_captured_event);
1078 }
1079
1080 static void
1081 gtk_menu_destroy (GtkWidget *widget)
1082 {
1083   GtkMenu *menu = GTK_MENU (widget);
1084   GtkMenuPrivate *priv = menu->priv;
1085   GtkMenuAttachData *data;
1086
1087   gtk_menu_remove_scroll_timeout (menu);
1088
1089   data = g_object_get_data (G_OBJECT (widget), attach_data_key);
1090   if (data)
1091     gtk_menu_detach (menu);
1092
1093   gtk_menu_stop_navigating_submenu (menu);
1094
1095   if (priv->old_active_menu_item)
1096     g_clear_object (&priv->old_active_menu_item);
1097
1098   /* Add back the reference count for being a child */
1099   if (priv->needs_destruction_ref)
1100     {
1101       priv->needs_destruction_ref = FALSE;
1102       g_object_ref (widget);
1103     }
1104
1105   if (priv->accel_group)
1106     g_clear_object (&priv->accel_group);
1107
1108   if (priv->toplevel)
1109     gtk_widget_destroy (priv->toplevel);
1110
1111   if (priv->tearoff_window)
1112     gtk_widget_destroy (priv->tearoff_window);
1113
1114   if (priv->heights)
1115     {
1116       g_free (priv->heights);
1117       priv->heights = NULL;
1118     }
1119
1120   if (priv->title)
1121     {
1122       g_free (priv->title);
1123       priv->title = NULL;
1124     }
1125
1126   if (priv->position_func_data_destroy)
1127     {
1128       priv->position_func_data_destroy (priv->position_func_data);
1129       priv->position_func_data = NULL;
1130       priv->position_func_data_destroy = NULL;
1131     }
1132
1133   GTK_WIDGET_CLASS (gtk_menu_parent_class)->destroy (widget);
1134 }
1135
1136 static void
1137 menu_change_screen (GtkMenu   *menu,
1138                     GdkScreen *new_screen)
1139 {
1140   GtkMenuPrivate *priv = menu->priv;
1141
1142   if (gtk_widget_has_screen (GTK_WIDGET (menu)))
1143     {
1144       if (new_screen == gtk_widget_get_screen (GTK_WIDGET (menu)))
1145         return;
1146     }
1147
1148   if (priv->torn_off)
1149     {
1150       gtk_window_set_screen (GTK_WINDOW (priv->tearoff_window), new_screen);
1151       gtk_menu_position (menu, TRUE);
1152     }
1153
1154   gtk_window_set_screen (GTK_WINDOW (priv->toplevel), new_screen);
1155   priv->monitor_num = -1;
1156 }
1157
1158 static void
1159 attach_widget_screen_changed (GtkWidget *attach_widget,
1160                               GdkScreen *previous_screen,
1161                               GtkMenu   *menu)
1162 {
1163   if (gtk_widget_has_screen (attach_widget) &&
1164       !g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1165     menu_change_screen (menu, gtk_widget_get_screen (attach_widget));
1166 }
1167
1168 /**
1169  * gtk_menu_attach_to_widget:
1170  * @menu: a #GtkMenu
1171  * @attach_widget: the #GtkWidget that the menu will be attached to
1172  * @detacher: (scope async)(allow-none): the user supplied callback function
1173  *             that will be called when the menu calls gtk_menu_detach()
1174  *
1175  * Attaches the menu to the widget and provides a callback function
1176  * that will be invoked when the menu calls gtk_menu_detach() during
1177  * its destruction.
1178  */
1179 void
1180 gtk_menu_attach_to_widget (GtkMenu           *menu,
1181                            GtkWidget         *attach_widget,
1182                            GtkMenuDetachFunc  detacher)
1183 {
1184   GtkMenuAttachData *data;
1185   GList *list;
1186
1187   g_return_if_fail (GTK_IS_MENU (menu));
1188   g_return_if_fail (GTK_IS_WIDGET (attach_widget));
1189
1190   /* keep this function in sync with gtk_widget_set_parent() */
1191   data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1192   if (data)
1193     {
1194       g_warning ("gtk_menu_attach_to_widget(): menu already attached to %s",
1195                  g_type_name (G_TYPE_FROM_INSTANCE (data->attach_widget)));
1196      return;
1197     }
1198
1199   g_object_ref_sink (menu);
1200
1201   data = g_slice_new (GtkMenuAttachData);
1202   data->attach_widget = attach_widget;
1203
1204   g_signal_connect (attach_widget, "screen-changed",
1205                     G_CALLBACK (attach_widget_screen_changed), menu);
1206   attach_widget_screen_changed (attach_widget, NULL, menu);
1207
1208   data->detacher = detacher;
1209   g_object_set_data (G_OBJECT (menu), I_(attach_data_key), data);
1210   list = g_object_steal_data (G_OBJECT (attach_widget), ATTACHED_MENUS);
1211   if (!g_list_find (list, menu))
1212     list = g_list_prepend (list, menu);
1213
1214   g_object_set_data_full (G_OBJECT (attach_widget), I_(ATTACHED_MENUS), list,
1215                           (GDestroyNotify) g_list_free);
1216
1217   if (gtk_widget_get_state_flags (GTK_WIDGET (menu)) != 0)
1218     gtk_widget_set_state_flags (GTK_WIDGET (menu), 0, TRUE);
1219
1220   /* Attach the widget to the toplevel window. */
1221   gtk_window_set_attached_to (GTK_WINDOW (menu->priv->toplevel), attach_widget);
1222
1223   /* Fallback title for menu comes from attach widget */
1224   gtk_menu_update_title (menu);
1225
1226   g_object_notify (G_OBJECT (menu), "attach-widget");
1227 }
1228
1229 /**
1230  * gtk_menu_get_attach_widget:
1231  * @menu: a #GtkMenu
1232  *
1233  * Returns the #GtkWidget that the menu is attached to.
1234  *
1235  * Returns: (transfer none): the #GtkWidget that the menu is attached to
1236  */
1237 GtkWidget*
1238 gtk_menu_get_attach_widget (GtkMenu *menu)
1239 {
1240   GtkMenuAttachData *data;
1241
1242   g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1243
1244   data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1245   if (data)
1246     return data->attach_widget;
1247   return NULL;
1248 }
1249
1250 /**
1251  * gtk_menu_detach:
1252  * @menu: a #GtkMenu
1253  *
1254  * Detaches the menu from the widget to which it had been attached.
1255  * This function will call the callback function, @detacher, provided
1256  * when the gtk_menu_attach_to_widget() function was called.
1257  */
1258 void
1259 gtk_menu_detach (GtkMenu *menu)
1260 {
1261   GtkMenuAttachData *data;
1262   GList *list;
1263
1264   g_return_if_fail (GTK_IS_MENU (menu));
1265
1266   /* keep this function in sync with gtk_widget_unparent() */
1267   data = g_object_get_data (G_OBJECT (menu), attach_data_key);
1268   if (!data)
1269     {
1270       g_warning ("gtk_menu_detach(): menu is not attached");
1271       return;
1272     }
1273   g_object_set_data (G_OBJECT (menu), I_(attach_data_key), NULL);
1274
1275   /* Detach the toplevel window. */
1276   gtk_window_set_attached_to (GTK_WINDOW (menu->priv->toplevel), NULL);
1277
1278   g_signal_handlers_disconnect_by_func (data->attach_widget,
1279                                         (gpointer) attach_widget_screen_changed,
1280                                         menu);
1281
1282   if (data->detacher)
1283     data->detacher (data->attach_widget, menu);
1284   list = g_object_steal_data (G_OBJECT (data->attach_widget), ATTACHED_MENUS);
1285   list = g_list_remove (list, menu);
1286   if (list)
1287     g_object_set_data_full (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), list,
1288                             (GDestroyNotify) g_list_free);
1289   else
1290     g_object_set_data (G_OBJECT (data->attach_widget), I_(ATTACHED_MENUS), NULL);
1291
1292   if (gtk_widget_get_realized (GTK_WIDGET (menu)))
1293     gtk_widget_unrealize (GTK_WIDGET (menu));
1294
1295   g_slice_free (GtkMenuAttachData, data);
1296
1297   /* Fallback title for menu comes from attach widget */
1298   gtk_menu_update_title (menu);
1299
1300   g_object_unref (menu);
1301 }
1302
1303 static void
1304 gtk_menu_remove (GtkContainer *container,
1305                  GtkWidget    *widget)
1306 {
1307   GtkMenu *menu = GTK_MENU (container);
1308   GtkMenuPrivate *priv = menu->priv;
1309
1310   /* Clear out old_active_menu_item if it matches the item we are removing */
1311   if (priv->old_active_menu_item == widget)
1312     g_clear_object (&priv->old_active_menu_item);
1313
1314   GTK_CONTAINER_CLASS (gtk_menu_parent_class)->remove (container, widget);
1315
1316   g_object_set_data (G_OBJECT (widget), I_(ATTACH_INFO_KEY), NULL);
1317
1318   menu_queue_resize (menu);
1319 }
1320
1321 /**
1322  * gtk_menu_new:
1323  *
1324  * Creates a new #GtkMenu
1325  *
1326  * Returns: a new #GtkMenu
1327  */
1328 GtkWidget*
1329 gtk_menu_new (void)
1330 {
1331   return g_object_new (GTK_TYPE_MENU, NULL);
1332 }
1333
1334 static void
1335 gtk_menu_real_insert (GtkMenuShell *menu_shell,
1336                       GtkWidget    *child,
1337                       gint          position)
1338 {
1339   GtkMenu *menu = GTK_MENU (menu_shell);
1340   GtkMenuPrivate *priv = menu->priv;
1341   AttachInfo *ai = get_attach_info (child);
1342
1343   ai->left_attach = -1;
1344   ai->right_attach = -1;
1345   ai->top_attach = -1;
1346   ai->bottom_attach = -1;
1347
1348   if (gtk_widget_get_realized (GTK_WIDGET (menu_shell)))
1349     gtk_widget_set_parent_window (child, priv->bin_window);
1350
1351   GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->insert (menu_shell, child, position);
1352
1353   menu_queue_resize (menu);
1354 }
1355
1356 static void
1357 gtk_menu_tearoff_bg_copy (GtkMenu *menu)
1358 {
1359   GtkMenuPrivate *priv = menu->priv;
1360   gint width, height;
1361
1362   if (priv->torn_off)
1363     {
1364       GdkWindow *window;
1365       cairo_surface_t *surface;
1366       cairo_pattern_t *pattern;
1367       cairo_t *cr;
1368
1369       priv->tearoff_active = FALSE;
1370       priv->saved_scroll_offset = priv->scroll_offset;
1371
1372       window = gtk_widget_get_window (priv->tearoff_window);
1373       width = gdk_window_get_width (window);
1374       height = gdk_window_get_height (window);
1375
1376       surface = gdk_window_create_similar_surface (window,
1377                                                    CAIRO_CONTENT_COLOR,
1378                                                    width,
1379                                                    height);
1380
1381       cr = cairo_create (surface);
1382       gdk_cairo_set_source_window (cr, window, 0, 0);
1383       cairo_paint (cr);
1384       cairo_destroy (cr);
1385
1386       gtk_widget_set_size_request (priv->tearoff_window, width, height);
1387
1388       pattern = cairo_pattern_create_for_surface (surface);
1389       gdk_window_set_background_pattern (window, pattern);
1390
1391       cairo_pattern_destroy (pattern);
1392       cairo_surface_destroy (surface);
1393     }
1394 }
1395
1396 static gboolean
1397 popup_grab_on_window (GdkWindow *window,
1398                       GdkDevice *keyboard,
1399                       GdkDevice *pointer,
1400                       guint32    activate_time)
1401 {
1402   if (keyboard &&
1403       gdk_device_grab (keyboard, window,
1404                        GDK_OWNERSHIP_WINDOW, TRUE,
1405                        GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
1406                        NULL, activate_time) != GDK_GRAB_SUCCESS)
1407     return FALSE;
1408
1409   if (pointer &&
1410       gdk_device_grab (pointer, window,
1411                        GDK_OWNERSHIP_WINDOW, TRUE,
1412                        GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1413                        GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1414                        GDK_POINTER_MOTION_MASK,
1415                        NULL, activate_time) != GDK_GRAB_SUCCESS)
1416     {
1417       if (keyboard)
1418         gdk_device_ungrab (keyboard, activate_time);
1419
1420       return FALSE;
1421     }
1422
1423   return TRUE;
1424 }
1425
1426 /**
1427  * gtk_menu_popup_for_device:
1428  * @menu: a #GtkMenu
1429  * @device: (allow-none): a #GdkDevice
1430  * @parent_menu_shell: (allow-none): the menu shell containing the triggering
1431  *     menu item, or %NULL
1432  * @parent_menu_item: (allow-none): the menu item whose activation triggered
1433  *     the popup, or %NULL
1434  * @func: (allow-none): a user supplied function used to position the menu,
1435  *     or %NULL
1436  * @data: (allow-none): user supplied data to be passed to @func
1437  * @destroy: (allow-none): destroy notify for @data
1438  * @button: the mouse button which was pressed to initiate the event
1439  * @activate_time: the time at which the activation event occurred
1440  *
1441  * Displays a menu and makes it available for selection.
1442  *
1443  * Applications can use this function to display context-sensitive menus,
1444  * and will typically supply %NULL for the @parent_menu_shell,
1445  * @parent_menu_item, @func, @data and @destroy parameters. The default
1446  * menu positioning function will position the menu at the current position
1447  * of @device (or its corresponding pointer).
1448  *
1449  * The @button parameter should be the mouse button pressed to initiate
1450  * the menu popup. If the menu popup was initiated by something other than
1451  * a mouse button press, such as a mouse button release or a keypress,
1452  * @button should be 0.
1453  *
1454  * The @activate_time parameter is used to conflict-resolve initiation of
1455  * concurrent requests for mouse/keyboard grab requests. To function
1456  * properly, this needs to be the time stamp of the user event (such as
1457  * a mouse click or key press) that caused the initiation of the popup.
1458  * Only if no such event is available, gtk_get_current_event_time() can
1459  * be used instead.
1460  *
1461  * Since: 3.0
1462  * Rename to: gtk_menu_popup
1463  */
1464 void
1465 gtk_menu_popup_for_device (GtkMenu             *menu,
1466                            GdkDevice           *device,
1467                            GtkWidget           *parent_menu_shell,
1468                            GtkWidget           *parent_menu_item,
1469                            GtkMenuPositionFunc  func,
1470                            gpointer             data,
1471                            GDestroyNotify       destroy,
1472                            guint                button,
1473                            guint32              activate_time)
1474 {
1475   GtkMenuPrivate *priv = menu->priv;
1476   GtkWidget *widget;
1477   GtkWidget *xgrab_shell;
1478   GtkWidget *parent;
1479   GdkEvent *current_event;
1480   GtkMenuShell *menu_shell;
1481   gboolean grab_keyboard;
1482   GtkWidget *parent_toplevel;
1483   GdkDevice *keyboard, *pointer;
1484
1485   g_return_if_fail (GTK_IS_MENU (menu));
1486   g_return_if_fail (device == NULL || GDK_IS_DEVICE (device));
1487
1488   if (device == NULL)
1489     device = gtk_get_current_event_device ();
1490
1491   if (device == NULL)
1492     {
1493       GdkDisplay *display;
1494       GdkDeviceManager *device_manager;
1495       GList *devices;
1496
1497       display = gtk_widget_get_display (GTK_WIDGET (menu));
1498       device_manager = gdk_display_get_device_manager (display);
1499       devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
1500
1501       device = devices->data;
1502
1503       g_list_free (devices);
1504     }
1505
1506   widget = GTK_WIDGET (menu);
1507   menu_shell = GTK_MENU_SHELL (menu);
1508
1509   if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
1510     {
1511       keyboard = device;
1512       pointer = gdk_device_get_associated_device (device);
1513     }
1514   else
1515     {
1516       pointer = device;
1517       keyboard = gdk_device_get_associated_device (device);
1518     }
1519
1520   menu_shell->priv->parent_menu_shell = parent_menu_shell;
1521
1522   priv->seen_item_enter = FALSE;
1523
1524   /* Find the last viewable ancestor, and make an X grab on it
1525    */
1526   parent = GTK_WIDGET (menu);
1527   xgrab_shell = NULL;
1528   while (parent)
1529     {
1530       gboolean viewable = TRUE;
1531       GtkWidget *tmp = parent;
1532
1533       while (tmp)
1534         {
1535           if (!gtk_widget_get_mapped (tmp))
1536             {
1537               viewable = FALSE;
1538               break;
1539             }
1540           tmp = gtk_widget_get_parent (tmp);
1541         }
1542
1543       if (viewable)
1544         xgrab_shell = parent;
1545
1546       parent = GTK_MENU_SHELL (parent)->priv->parent_menu_shell;
1547     }
1548
1549   /* We want to receive events generated when we map the menu;
1550    * unfortunately, since there is probably already an implicit
1551    * grab in place from the button that the user used to pop up
1552    * the menu, we won't receive then -- in particular, the EnterNotify
1553    * when the menu pops up under the pointer.
1554    *
1555    * If we are grabbing on a parent menu shell, no problem; just grab
1556    * on that menu shell first before popping up the window with
1557    * owner_events = TRUE.
1558    *
1559    * When grabbing on the menu itself, things get more convoluted --
1560    * we do an explicit grab on a specially created window with
1561    * owner_events = TRUE, which we override further down with a
1562    * grab on the menu. (We can't grab on the menu until it is mapped;
1563    * we probably could just leave the grab on the other window,
1564    * with a little reorganization of the code in gtkmenu*).
1565    */
1566   grab_keyboard = gtk_menu_shell_get_take_focus (menu_shell);
1567   gtk_window_set_accept_focus (GTK_WINDOW (priv->toplevel), grab_keyboard);
1568
1569   if (!grab_keyboard)
1570     keyboard = NULL;
1571
1572   if (xgrab_shell && xgrab_shell != widget)
1573     {
1574       if (popup_grab_on_window (gtk_widget_get_window (xgrab_shell), keyboard, pointer, activate_time))
1575         {
1576           _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1577           GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1578         }
1579     }
1580   else
1581     {
1582       GdkWindow *transfer_window;
1583
1584       xgrab_shell = widget;
1585       transfer_window = menu_grab_transfer_window_get (menu);
1586       if (popup_grab_on_window (transfer_window, keyboard, pointer, activate_time))
1587         {
1588           _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (xgrab_shell), pointer);
1589           GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab = TRUE;
1590         }
1591     }
1592
1593   if (!GTK_MENU_SHELL (xgrab_shell)->priv->have_xgrab)
1594     {
1595       /* We failed to make our pointer/keyboard grab.
1596        * Rather than leaving the user with a stuck up window,
1597        * we just abort here. Presumably the user will try again.
1598        */
1599       menu_shell->priv->parent_menu_shell = NULL;
1600       menu_grab_transfer_window_destroy (menu);
1601       return;
1602     }
1603
1604   _gtk_menu_shell_set_grab_device (GTK_MENU_SHELL (menu), pointer);
1605   menu_shell->priv->active = TRUE;
1606   menu_shell->priv->button = button;
1607
1608   /* If we are popping up the menu from something other than, a button
1609    * press then, as a heuristic, we ignore enter events for the menu
1610    * until we get a MOTION_NOTIFY.
1611    */
1612
1613   current_event = gtk_get_current_event ();
1614   if (current_event)
1615     {
1616       if ((current_event->type != GDK_BUTTON_PRESS) &&
1617           (current_event->type != GDK_ENTER_NOTIFY))
1618         menu_shell->priv->ignore_enter = TRUE;
1619
1620       gdk_event_free (current_event);
1621     }
1622   else
1623     menu_shell->priv->ignore_enter = TRUE;
1624
1625   if (priv->torn_off)
1626     {
1627       gtk_menu_tearoff_bg_copy (menu);
1628
1629       gtk_menu_reparent (menu, priv->toplevel, FALSE);
1630     }
1631
1632   parent_toplevel = NULL;
1633   if (parent_menu_shell)
1634     parent_toplevel = gtk_widget_get_toplevel (parent_menu_shell);
1635   else if (!g_object_get_data (G_OBJECT (menu), "gtk-menu-explicit-screen"))
1636     {
1637       GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
1638       if (attach_widget)
1639         parent_toplevel = gtk_widget_get_toplevel (attach_widget);
1640     }
1641
1642   /* Set transient for to get the right window group and parent */
1643   if (GTK_IS_WINDOW (parent_toplevel))
1644     gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel),
1645                                   GTK_WINDOW (parent_toplevel));
1646
1647   priv->parent_menu_item = parent_menu_item;
1648   priv->position_func = func;
1649   priv->position_func_data = data;
1650   priv->position_func_data_destroy = destroy;
1651   menu_shell->priv->activate_time = activate_time;
1652
1653   /* We need to show the menu here rather in the init function
1654    * because code expects to be able to tell if the menu is onscreen
1655    * by looking at gtk_widget_get_visible (menu)
1656    */
1657   gtk_widget_show (GTK_WIDGET (menu));
1658
1659   /* Position the menu, possibly changing the size request
1660    */
1661   gtk_menu_position (menu, TRUE);
1662
1663   /* Compute the size of the toplevel and realize it so we
1664    * can scroll correctly.
1665    */
1666   if (!gtk_widget_get_realized (GTK_WIDGET (menu)))
1667   {
1668     GtkRequisition tmp_request;
1669     GtkAllocation tmp_allocation = { 0, };
1670
1671     /* Instead of trusting the menu position function to queue a
1672      * resize when the menu goes out of bounds, invalidate the cached
1673      * size here.
1674      */
1675     gtk_widget_queue_resize (GTK_WIDGET (menu));
1676     gtk_widget_get_preferred_size (priv->toplevel, &tmp_request, NULL);
1677
1678     tmp_allocation.width = tmp_request.width;
1679     tmp_allocation.height = tmp_request.height;
1680
1681     gtk_widget_size_allocate (priv->toplevel, &tmp_allocation);
1682
1683     gtk_widget_realize (priv->toplevel);
1684   }
1685
1686   gtk_menu_scroll_to (menu, priv->scroll_offset);
1687
1688   /* if no item is selected, select the first one */
1689   if (!menu_shell->priv->active_menu_item)
1690     {
1691       gboolean touchscreen_mode;
1692
1693       g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
1694                     "gtk-touchscreen-mode", &touchscreen_mode,
1695                     NULL);
1696
1697       if (touchscreen_mode)
1698         gtk_menu_shell_select_first (menu_shell, TRUE);
1699     }
1700
1701   /* Once everything is set up correctly, map the toplevel */
1702   gtk_widget_show (priv->toplevel);
1703
1704   if (xgrab_shell == widget)
1705     popup_grab_on_window (gtk_widget_get_window (widget), keyboard, pointer, activate_time); /* Should always succeed */
1706
1707   gtk_device_grab_add (GTK_WIDGET (menu), pointer, TRUE);
1708
1709   if (parent_menu_shell)
1710     {
1711       gboolean keyboard_mode;
1712
1713       keyboard_mode = _gtk_menu_shell_get_keyboard_mode (GTK_MENU_SHELL (parent_menu_shell));
1714       _gtk_menu_shell_set_keyboard_mode (menu_shell, keyboard_mode);
1715     }
1716   else if (menu_shell->priv->button == 0) /* a keynav-activated context menu */
1717     _gtk_menu_shell_set_keyboard_mode (menu_shell, TRUE);
1718
1719   _gtk_menu_shell_update_mnemonics (menu_shell);
1720 }
1721
1722 /**
1723  * gtk_menu_popup: (skip)
1724  * @menu: a #GtkMenu
1725  * @parent_menu_shell: (allow-none): the menu shell containing the
1726  *     triggering menu item, or %NULL
1727  * @parent_menu_item: (allow-none): the menu item whose activation
1728  *     triggered the popup, or %NULL
1729  * @func: (allow-none): a user supplied function used to position
1730  *     the menu, or %NULL
1731  * @data: user supplied data to be passed to @func.
1732  * @button: the mouse button which was pressed to initiate the event.
1733  * @activate_time: the time at which the activation event occurred.
1734  *
1735  * Displays a menu and makes it available for selection.
1736  *
1737  * Applications can use this function to display context-sensitive
1738  * menus, and will typically supply %NULL for the @parent_menu_shell,
1739  * @parent_menu_item, @func and @data parameters. The default menu
1740  * positioning function will position the menu at the current mouse
1741  * cursor position.
1742  *
1743  * The @button parameter should be the mouse button pressed to initiate
1744  * the menu popup. If the menu popup was initiated by something other
1745  * than a mouse button press, such as a mouse button release or a keypress,
1746  * @button should be 0.
1747  *
1748  * The @activate_time parameter is used to conflict-resolve initiation
1749  * of concurrent requests for mouse/keyboard grab requests. To function
1750  * properly, this needs to be the timestamp of the user event (such as
1751  * a mouse click or key press) that caused the initiation of the popup.
1752  * Only if no such event is available, gtk_get_current_event_time() can
1753  * be used instead.
1754  */
1755 void
1756 gtk_menu_popup (GtkMenu             *menu,
1757                 GtkWidget           *parent_menu_shell,
1758                 GtkWidget           *parent_menu_item,
1759                 GtkMenuPositionFunc  func,
1760                 gpointer             data,
1761                 guint                button,
1762                 guint32              activate_time)
1763 {
1764   g_return_if_fail (GTK_IS_MENU (menu));
1765
1766   gtk_menu_popup_for_device (menu,
1767                              NULL,
1768                              parent_menu_shell,
1769                              parent_menu_item,
1770                              func, data, NULL,
1771                              button, activate_time);
1772 }
1773
1774 /**
1775  * gtk_menu_popdown:
1776  * @menu: a #GtkMenu
1777  *
1778  * Removes the menu from the screen.
1779  */
1780 void
1781 gtk_menu_popdown (GtkMenu *menu)
1782 {
1783   GtkMenuPrivate *priv;
1784   GtkMenuShell *menu_shell;
1785   GdkDevice *pointer;
1786
1787   g_return_if_fail (GTK_IS_MENU (menu));
1788
1789   menu_shell = GTK_MENU_SHELL (menu);
1790   priv = menu->priv;
1791
1792   menu_shell->priv->parent_menu_shell = NULL;
1793   menu_shell->priv->active = FALSE;
1794   menu_shell->priv->ignore_enter = FALSE;
1795
1796   priv->have_position = FALSE;
1797
1798   gtk_menu_stop_scrolling (menu);
1799   gtk_menu_stop_navigating_submenu (menu);
1800
1801   if (menu_shell->priv->active_menu_item)
1802     {
1803       if (priv->old_active_menu_item)
1804         g_object_unref (priv->old_active_menu_item);
1805       priv->old_active_menu_item = menu_shell->priv->active_menu_item;
1806       g_object_ref (priv->old_active_menu_item);
1807     }
1808
1809   gtk_menu_shell_deselect (menu_shell);
1810
1811   /* The X Grab, if present, will automatically be removed
1812    * when we hide the window
1813    */
1814   if (priv->toplevel)
1815     {
1816       gtk_widget_hide (priv->toplevel);
1817       gtk_window_set_transient_for (GTK_WINDOW (priv->toplevel), NULL);
1818     }
1819
1820   pointer = _gtk_menu_shell_get_grab_device (menu_shell);
1821
1822   if (priv->torn_off)
1823     {
1824       gtk_widget_set_size_request (priv->tearoff_window, -1, -1);
1825
1826       if (gtk_bin_get_child (GTK_BIN (priv->toplevel)))
1827         {
1828           gtk_menu_reparent (menu, priv->tearoff_hbox, TRUE);
1829         }
1830       else
1831         {
1832           /* We popped up the menu from the tearoff, so we need to
1833            * release the grab - we aren't actually hiding the menu.
1834            */
1835           if (menu_shell->priv->have_xgrab && pointer)
1836             {
1837               GdkDevice *keyboard;
1838
1839               gdk_device_ungrab (pointer, GDK_CURRENT_TIME);
1840               keyboard = gdk_device_get_associated_device (pointer);
1841
1842               if (keyboard)
1843                 gdk_device_ungrab (keyboard, GDK_CURRENT_TIME);
1844             }
1845         }
1846
1847       /* gtk_menu_popdown is called each time a menu item is selected from
1848        * a torn off menu. Only scroll back to the saved position if the
1849        * non-tearoff menu was popped down.
1850        */
1851       if (!priv->tearoff_active)
1852         gtk_menu_scroll_to (menu, priv->saved_scroll_offset);
1853       priv->tearoff_active = TRUE;
1854     }
1855   else
1856     gtk_widget_hide (GTK_WIDGET (menu));
1857
1858   menu_shell->priv->have_xgrab = FALSE;
1859
1860   if (pointer)
1861     gtk_device_grab_remove (GTK_WIDGET (menu), pointer);
1862
1863   _gtk_menu_shell_set_grab_device (menu_shell, NULL);
1864
1865   menu_grab_transfer_window_destroy (menu);
1866 }
1867
1868 /**
1869  * gtk_menu_get_active:
1870  * @menu: a #GtkMenu
1871  *
1872  * Returns the selected menu item from the menu.  This is used by the
1873  * #GtkOptionMenu.
1874  *
1875  * Returns: (transfer none): the #GtkMenuItem that was last selected
1876  *          in the menu.  If a selection has not yet been made, the
1877  *          first menu item is selected.
1878  */
1879 GtkWidget*
1880 gtk_menu_get_active (GtkMenu *menu)
1881 {
1882   GtkMenuPrivate *priv = menu->priv;
1883   GtkWidget *child;
1884   GList *children;
1885
1886   g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1887
1888   if (!priv->old_active_menu_item)
1889     {
1890       child = NULL;
1891       children = GTK_MENU_SHELL (menu)->priv->children;
1892
1893       while (children)
1894         {
1895           child = children->data;
1896           children = children->next;
1897
1898           if (gtk_bin_get_child (GTK_BIN (child)))
1899             break;
1900           child = NULL;
1901         }
1902
1903       priv->old_active_menu_item = child;
1904       if (priv->old_active_menu_item)
1905         g_object_ref (priv->old_active_menu_item);
1906     }
1907
1908   return priv->old_active_menu_item;
1909 }
1910
1911 /**
1912  * gtk_menu_set_active:
1913  * @menu: a #GtkMenu
1914  * @index: the index of the menu item to select.  Iindex values are
1915  *         from 0 to n-1
1916  *
1917  * Selects the specified menu item within the menu.  This is used by
1918  * the #GtkOptionMenu and should not be used by anyone else.
1919  */
1920 void
1921 gtk_menu_set_active (GtkMenu *menu,
1922                      guint    index)
1923 {
1924   GtkMenuPrivate *priv = menu->priv;
1925   GtkWidget *child;
1926   GList *tmp_list;
1927
1928   g_return_if_fail (GTK_IS_MENU (menu));
1929
1930   tmp_list = g_list_nth (GTK_MENU_SHELL (menu)->priv->children, index);
1931   if (tmp_list)
1932     {
1933       child = tmp_list->data;
1934       if (gtk_bin_get_child (GTK_BIN (child)))
1935         {
1936           if (priv->old_active_menu_item)
1937             g_object_unref (priv->old_active_menu_item);
1938           priv->old_active_menu_item = child;
1939           g_object_ref (priv->old_active_menu_item);
1940         }
1941     }
1942 }
1943
1944 /**
1945  * gtk_menu_set_accel_group:
1946  * @menu: a #GtkMenu
1947  * @accel_group: (allow-none): the #GtkAccelGroup to be associated
1948  *               with the menu.
1949  *
1950  * Set the #GtkAccelGroup which holds global accelerators for the
1951  * menu.  This accelerator group needs to also be added to all windows
1952  * that this menu is being used in with gtk_window_add_accel_group(),
1953  * in order for those windows to support all the accelerators
1954  * contained in this group.
1955  */
1956 void
1957 gtk_menu_set_accel_group (GtkMenu       *menu,
1958                           GtkAccelGroup *accel_group)
1959 {
1960   GtkMenuPrivate *priv = menu->priv;
1961   g_return_if_fail (GTK_IS_MENU (menu));
1962
1963   if (priv->accel_group != accel_group)
1964     {
1965       if (priv->accel_group)
1966         g_object_unref (priv->accel_group);
1967       priv->accel_group = accel_group;
1968       if (priv->accel_group)
1969         g_object_ref (priv->accel_group);
1970       _gtk_menu_refresh_accel_paths (menu, TRUE);
1971     }
1972 }
1973
1974 /**
1975  * gtk_menu_get_accel_group:
1976  * @menu: a #GtkMenu
1977  *
1978  * Gets the #GtkAccelGroup which holds global accelerators for the
1979  * menu. See gtk_menu_set_accel_group().
1980  *
1981  * Returns: (transfer none): the #GtkAccelGroup associated with the menu
1982  */
1983 GtkAccelGroup*
1984 gtk_menu_get_accel_group (GtkMenu *menu)
1985 {
1986   g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
1987
1988   return menu->priv->accel_group;
1989 }
1990
1991 static gboolean
1992 gtk_menu_real_can_activate_accel (GtkWidget *widget,
1993                                   guint      signal_id)
1994 {
1995   /* Menu items chain here to figure whether they can activate their
1996    * accelerators.  Unlike ordinary widgets, menus allow accel
1997    * activation even if invisible since that's the usual case for
1998    * submenus/popup-menus. however, the state of the attach widget
1999    * affects the "activeness" of the menu.
2000    */
2001   GtkWidget *awidget = gtk_menu_get_attach_widget (GTK_MENU (widget));
2002
2003   if (awidget)
2004     return gtk_widget_can_activate_accel (awidget, signal_id);
2005   else
2006     return gtk_widget_is_sensitive (widget);
2007 }
2008
2009 /**
2010  * gtk_menu_set_accel_path
2011  * @menu:       a valid #GtkMenu
2012  * @accel_path: (allow-none): a valid accelerator path
2013  *
2014  * Sets an accelerator path for this menu from which accelerator paths
2015  * for its immediate children, its menu items, can be constructed.
2016  * The main purpose of this function is to spare the programmer the
2017  * inconvenience of having to call gtk_menu_item_set_accel_path() on
2018  * each menu item that should support runtime user changable accelerators.
2019  * Instead, by just calling gtk_menu_set_accel_path() on their parent,
2020  * each menu item of this menu, that contains a label describing its
2021  * purpose, automatically gets an accel path assigned.
2022  *
2023  * For example, a menu containing menu items "New" and "Exit", will, after
2024  * <literal>gtk_menu_set_accel_path (menu, "&lt;Gnumeric-Sheet&gt;/File");</literal>
2025  * has been called, assign its items the accel paths:
2026  * <literal>"&lt;Gnumeric-Sheet&gt;/File/New"</literal> and <literal>"&lt;Gnumeric-Sheet&gt;/File/Exit"</literal>.
2027  *
2028  * Assigning accel paths to menu items then enables the user to change
2029  * their accelerators at runtime. More details about accelerator paths
2030  * and their default setups can be found at gtk_accel_map_add_entry().
2031  *
2032  * Note that @accel_path string will be stored in a #GQuark. Therefore,
2033  * if you pass a static string, you can save some memory by interning
2034  * it first with g_intern_static_string().
2035  */
2036 void
2037 gtk_menu_set_accel_path (GtkMenu     *menu,
2038                          const gchar *accel_path)
2039 {
2040   GtkMenuPrivate *priv = menu->priv;
2041   g_return_if_fail (GTK_IS_MENU (menu));
2042
2043   if (accel_path)
2044     g_return_if_fail (accel_path[0] == '<' && strchr (accel_path, '/')); /* simplistic check */
2045
2046   /* FIXME: accel_path should be defined as const gchar* */
2047   priv->accel_path = (gchar*)g_intern_string (accel_path);
2048   if (priv->accel_path)
2049     _gtk_menu_refresh_accel_paths (menu, FALSE);
2050 }
2051
2052 /**
2053  * gtk_menu_get_accel_path
2054  * @menu: a valid #GtkMenu
2055  *
2056  * Retrieves the accelerator path set on the menu.
2057  *
2058  * Returns: the accelerator path set on the menu.
2059  *
2060  * Since: 2.14
2061  */
2062 const gchar*
2063 gtk_menu_get_accel_path (GtkMenu *menu)
2064 {
2065   g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2066
2067   return menu->priv->accel_path;
2068 }
2069
2070 typedef struct {
2071   GtkMenu *menu;
2072   gboolean group_changed;
2073 } AccelPropagation;
2074
2075 static void
2076 refresh_accel_paths_foreach (GtkWidget *widget,
2077                              gpointer   data)
2078 {
2079   GtkMenuPrivate *priv;
2080   AccelPropagation *prop = data;
2081
2082   if (GTK_IS_MENU_ITEM (widget))  /* should always be true */
2083     {
2084       priv = prop->menu->priv;
2085       _gtk_menu_item_refresh_accel_path (GTK_MENU_ITEM (widget),
2086                                          priv->accel_path,
2087                                          priv->accel_group,
2088                                          prop->group_changed);
2089     }
2090 }
2091
2092 static void
2093 _gtk_menu_refresh_accel_paths (GtkMenu  *menu,
2094                                gboolean  group_changed)
2095 {
2096   GtkMenuPrivate *priv = menu->priv;
2097   g_return_if_fail (GTK_IS_MENU (menu));
2098
2099   if (priv->accel_path && priv->accel_group)
2100     {
2101       AccelPropagation prop;
2102
2103       prop.menu = menu;
2104       prop.group_changed = group_changed;
2105       gtk_container_foreach (GTK_CONTAINER (menu),
2106                              refresh_accel_paths_foreach,
2107                              &prop);
2108     }
2109 }
2110
2111 /**
2112  * gtk_menu_reposition:
2113  * @menu: a #GtkMenu
2114  *
2115  * Repositions the menu according to its position function.
2116  */
2117 void
2118 gtk_menu_reposition (GtkMenu *menu)
2119 {
2120   g_return_if_fail (GTK_IS_MENU (menu));
2121
2122   if (!menu->priv->torn_off && gtk_widget_is_drawable (GTK_WIDGET (menu)))
2123     gtk_menu_position (menu, FALSE);
2124 }
2125
2126 static void
2127 gtk_menu_scrollbar_changed (GtkAdjustment *adjustment,
2128                             GtkMenu       *menu)
2129 {
2130   double value;
2131
2132   value = gtk_adjustment_get_value (adjustment);
2133   if (menu->priv->scroll_offset != value)
2134     gtk_menu_scroll_to (menu, value);
2135 }
2136
2137 static void
2138 gtk_menu_set_tearoff_hints (GtkMenu *menu,
2139                             gint     width)
2140 {
2141   GtkMenuPrivate *priv = menu->priv;
2142   GdkGeometry geometry_hints;
2143
2144   if (!priv->tearoff_window)
2145     return;
2146
2147   if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2148     {
2149       GtkRequisition requisition;
2150
2151       gtk_widget_get_preferred_size (priv->tearoff_scrollbar,
2152                                      &requisition, NULL);
2153       width += requisition.width;
2154     }
2155
2156   geometry_hints.min_width = width;
2157   geometry_hints.max_width = width;
2158
2159   geometry_hints.min_height = 0;
2160   geometry_hints.max_height = priv->requested_height;
2161
2162   gtk_window_set_geometry_hints (GTK_WINDOW (priv->tearoff_window),
2163                                  NULL,
2164                                  &geometry_hints,
2165                                  GDK_HINT_MAX_SIZE|GDK_HINT_MIN_SIZE);
2166 }
2167
2168 static void
2169 gtk_menu_update_title (GtkMenu *menu)
2170 {
2171   GtkMenuPrivate *priv = menu->priv;
2172
2173   if (priv->tearoff_window)
2174     {
2175       const gchar *title;
2176       GtkWidget *attach_widget;
2177
2178       title = gtk_menu_get_title (menu);
2179       if (!title)
2180         {
2181           attach_widget = gtk_menu_get_attach_widget (menu);
2182           if (GTK_IS_MENU_ITEM (attach_widget))
2183             {
2184               GtkWidget *child = gtk_bin_get_child (GTK_BIN (attach_widget));
2185               if (GTK_IS_LABEL (child))
2186                 title = gtk_label_get_text (GTK_LABEL (child));
2187             }
2188         }
2189
2190       if (title)
2191         gtk_window_set_title (GTK_WINDOW (priv->tearoff_window), title);
2192     }
2193 }
2194
2195 static GtkWidget*
2196 gtk_menu_get_toplevel (GtkWidget *menu)
2197 {
2198   GtkWidget *attach, *toplevel;
2199
2200   attach = gtk_menu_get_attach_widget (GTK_MENU (menu));
2201
2202   if (GTK_IS_MENU_ITEM (attach))
2203     attach = gtk_widget_get_parent (attach);
2204
2205   if (GTK_IS_MENU (attach))
2206     return gtk_menu_get_toplevel (attach);
2207   else if (GTK_IS_WIDGET (attach))
2208     {
2209       toplevel = gtk_widget_get_toplevel (attach);
2210       if (gtk_widget_is_toplevel (toplevel))
2211         return toplevel;
2212     }
2213
2214   return NULL;
2215 }
2216
2217 static void
2218 tearoff_window_destroyed (GtkWidget *widget,
2219                           GtkMenu   *menu)
2220 {
2221   gtk_menu_set_tearoff_state (menu, FALSE);
2222 }
2223
2224 /**
2225  * gtk_menu_set_tearoff_state:
2226  * @menu: a #GtkMenu
2227  * @torn_off: If %TRUE, menu is displayed as a tearoff menu.
2228  *
2229  * Changes the tearoff state of the menu.  A menu is normally
2230  * displayed as drop down menu which persists as long as the menu is
2231  * active.  It can also be displayed as a tearoff menu which persists
2232  * until it is closed or reattached.
2233  */
2234 void
2235 gtk_menu_set_tearoff_state (GtkMenu  *menu,
2236                             gboolean  torn_off)
2237 {
2238   GtkMenuPrivate *priv = menu->priv;
2239   gint height;
2240
2241   g_return_if_fail (GTK_IS_MENU (menu));
2242
2243   if (priv->torn_off != torn_off)
2244     {
2245       priv->torn_off = torn_off;
2246       priv->tearoff_active = torn_off;
2247
2248       if (priv->torn_off)
2249         {
2250           if (gtk_widget_get_visible (GTK_WIDGET (menu)))
2251             gtk_menu_popdown (menu);
2252
2253           if (!priv->tearoff_window)
2254             {
2255               GtkWidget *toplevel;
2256
2257               priv->tearoff_window = g_object_new (GTK_TYPE_WINDOW,
2258                                                    "type", GTK_WINDOW_TOPLEVEL,
2259                                                    "screen", gtk_widget_get_screen (priv->toplevel),
2260                                                    "app-paintable", TRUE,
2261                                                    NULL);
2262
2263               gtk_window_set_type_hint (GTK_WINDOW (priv->tearoff_window),
2264                                         GDK_WINDOW_TYPE_HINT_MENU);
2265               gtk_window_set_mnemonic_modifier (GTK_WINDOW (priv->tearoff_window), 0);
2266               g_signal_connect (priv->tearoff_window, "destroy",
2267                                 G_CALLBACK (tearoff_window_destroyed), menu);
2268               g_signal_connect (priv->tearoff_window, "event",
2269                                 G_CALLBACK (gtk_menu_window_event), menu);
2270
2271               gtk_menu_update_title (menu);
2272
2273               gtk_widget_realize (priv->tearoff_window);
2274
2275               toplevel = gtk_menu_get_toplevel (GTK_WIDGET (menu));
2276               if (toplevel != NULL)
2277                 gtk_window_set_transient_for (GTK_WINDOW (priv->tearoff_window),
2278                                               GTK_WINDOW (toplevel));
2279
2280               priv->tearoff_hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2281               gtk_container_add (GTK_CONTAINER (priv->tearoff_window),
2282                                  priv->tearoff_hbox);
2283
2284               height = gdk_window_get_height (gtk_widget_get_window (GTK_WIDGET (menu)));
2285               priv->tearoff_adjustment = gtk_adjustment_new (0,
2286                                                              0, priv->requested_height,
2287                                                              MENU_SCROLL_STEP2,
2288                                                              height/2,
2289                                                              height);
2290               g_object_connect (priv->tearoff_adjustment,
2291                                 "signal::value-changed", gtk_menu_scrollbar_changed, menu,
2292                                 NULL);
2293               priv->tearoff_scrollbar = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, priv->tearoff_adjustment);
2294
2295               gtk_box_pack_end (GTK_BOX (priv->tearoff_hbox),
2296                                 priv->tearoff_scrollbar,
2297                                 FALSE, FALSE, 0);
2298
2299               if (gtk_adjustment_get_upper (priv->tearoff_adjustment) > height)
2300                 gtk_widget_show (priv->tearoff_scrollbar);
2301
2302               gtk_widget_show (priv->tearoff_hbox);
2303             }
2304
2305           gtk_menu_reparent (menu, priv->tearoff_hbox, FALSE);
2306
2307           /* Update menu->requisition */
2308           gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, NULL);
2309
2310           gtk_menu_set_tearoff_hints (menu, gdk_window_get_width (gtk_widget_get_window (GTK_WIDGET (menu))));
2311
2312           gtk_widget_realize (priv->tearoff_window);
2313           gtk_menu_position (menu, TRUE);
2314
2315           gtk_widget_show (GTK_WIDGET (menu));
2316           gtk_widget_show (priv->tearoff_window);
2317
2318           gtk_menu_scroll_to (menu, 0);
2319
2320         }
2321       else
2322         {
2323           gtk_widget_hide (GTK_WIDGET (menu));
2324           gtk_widget_hide (priv->tearoff_window);
2325           if (GTK_IS_CONTAINER (priv->toplevel))
2326             gtk_menu_reparent (menu, priv->toplevel, FALSE);
2327           gtk_widget_destroy (priv->tearoff_window);
2328
2329           priv->tearoff_window = NULL;
2330           priv->tearoff_hbox = NULL;
2331           priv->tearoff_scrollbar = NULL;
2332           priv->tearoff_adjustment = NULL;
2333         }
2334
2335       g_object_notify (G_OBJECT (menu), "tearoff-state");
2336     }
2337 }
2338
2339 /**
2340  * gtk_menu_get_tearoff_state:
2341  * @menu: a #GtkMenu
2342  *
2343  * Returns whether the menu is torn off.
2344  * See gtk_menu_set_tearoff_state().
2345  *
2346  * Return value: %TRUE if the menu is currently torn off.
2347  */
2348 gboolean
2349 gtk_menu_get_tearoff_state (GtkMenu *menu)
2350 {
2351   g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
2352
2353   return menu->priv->torn_off;
2354 }
2355
2356 /**
2357  * gtk_menu_set_title:
2358  * @menu: a #GtkMenu
2359  * @title: a string containing the title for the menu
2360  *
2361  * Sets the title string for the menu.
2362  *
2363  * The title is displayed when the menu is shown as a tearoff
2364  * menu. If @title is %NULL, the menu will see if it is attached
2365  * to a parent menu item, and if so it will try to use the same
2366  * text as that menu item's label.
2367  */
2368 void
2369 gtk_menu_set_title (GtkMenu     *menu,
2370                     const gchar *title)
2371 {
2372   GtkMenuPrivate *priv = menu->priv;
2373   char *old_title;
2374
2375   g_return_if_fail (GTK_IS_MENU (menu));
2376
2377   old_title = priv->title;
2378   priv->title = g_strdup (title);
2379   g_free (old_title);
2380
2381   gtk_menu_update_title (menu);
2382   g_object_notify (G_OBJECT (menu), "tearoff-title");
2383 }
2384
2385 /**
2386  * gtk_menu_get_title:
2387  * @menu: a #GtkMenu
2388  *
2389  * Returns the title of the menu. See gtk_menu_set_title().
2390  *
2391  * Return value: the title of the menu, or %NULL if the menu
2392  *     has no title set on it. This string is owned by GTK+
2393  *     and should not be modified or freed.
2394  **/
2395 const gchar *
2396 gtk_menu_get_title (GtkMenu *menu)
2397 {
2398   g_return_val_if_fail (GTK_IS_MENU (menu), NULL);
2399
2400   return menu->priv->title;
2401 }
2402
2403 /**
2404  * gtk_menu_reorder_child:
2405  * @menu: a #GtkMenu
2406  * @child: the #GtkMenuItem to move
2407  * @position: the new position to place @child.
2408  *     Positions are numbered from 0 to n - 1
2409  *
2410  * Moves @child to a new @position in the list of @menu
2411  * children.
2412  */
2413 void
2414 gtk_menu_reorder_child (GtkMenu   *menu,
2415                         GtkWidget *child,
2416                         gint       position)
2417 {
2418   GtkMenuShell *menu_shell;
2419
2420   g_return_if_fail (GTK_IS_MENU (menu));
2421   g_return_if_fail (GTK_IS_MENU_ITEM (child));
2422
2423   menu_shell = GTK_MENU_SHELL (menu);
2424
2425   if (g_list_find (menu_shell->priv->children, child))
2426     {
2427       menu_shell->priv->children = g_list_remove (menu_shell->priv->children, child);
2428       menu_shell->priv->children = g_list_insert (menu_shell->priv->children, child, position);
2429
2430       menu_queue_resize (menu);
2431     }
2432 }
2433
2434 static void
2435 gtk_menu_style_updated (GtkWidget *widget)
2436 {
2437   GTK_WIDGET_CLASS (gtk_menu_parent_class)->style_updated (widget);
2438
2439   if (gtk_widget_get_realized (widget))
2440     {
2441       GtkMenu *menu = GTK_MENU (widget);
2442       GtkMenuPrivate *priv = menu->priv;
2443       GtkStyleContext *context;
2444
2445       context = gtk_widget_get_style_context (widget);
2446
2447       gtk_style_context_set_background (context, priv->bin_window);
2448       gtk_style_context_set_background (context, priv->view_window);
2449       gtk_style_context_set_background (context, gtk_widget_get_window (widget));
2450     }
2451 }
2452
2453 static void
2454 get_arrows_border (GtkMenu   *menu,
2455                    GtkBorder *border)
2456 {
2457   GtkMenuPrivate *priv = menu->priv;
2458   guint scroll_arrow_height;
2459   GtkArrowPlacement arrow_placement;
2460
2461   gtk_widget_style_get (GTK_WIDGET (menu),
2462                         "scroll-arrow-vlength", &scroll_arrow_height,
2463                         "arrow_placement", &arrow_placement,
2464                         NULL);
2465
2466   switch (arrow_placement)
2467     {
2468     case GTK_ARROWS_BOTH:
2469       border->top = priv->upper_arrow_visible ? scroll_arrow_height : 0;
2470       border->bottom = priv->lower_arrow_visible ? scroll_arrow_height : 0;
2471       break;
2472
2473     case GTK_ARROWS_START:
2474       border->top = (priv->upper_arrow_visible ||
2475                      priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2476       border->bottom = 0;
2477       break;
2478
2479     case GTK_ARROWS_END:
2480       border->top = 0;
2481       border->bottom = (priv->upper_arrow_visible ||
2482                         priv->lower_arrow_visible) ? scroll_arrow_height : 0;
2483       break;
2484     }
2485
2486   border->left = border->right = 0;
2487 }
2488
2489 static void
2490 get_menu_padding (GtkWidget *widget,
2491                   GtkBorder *padding)
2492 {
2493   GtkStyleContext *context;
2494   GtkStateFlags state;
2495
2496   context = gtk_widget_get_style_context (widget);
2497   state = gtk_widget_get_state_flags (widget);
2498
2499   gtk_style_context_get_padding (context, state, padding);
2500 }
2501
2502 static void
2503 gtk_menu_realize (GtkWidget *widget)
2504 {
2505   GtkMenu *menu = GTK_MENU (widget);
2506   GtkMenuPrivate *priv = menu->priv;
2507   GtkAllocation allocation;
2508   GtkStyleContext *context;
2509   GdkWindow *window;
2510   GdkWindowAttr attributes;
2511   gint attributes_mask;
2512   gint border_width;
2513   GtkWidget *child;
2514   GList *children;
2515   guint vertical_padding;
2516   guint horizontal_padding;
2517   GtkBorder arrow_border, padding;
2518
2519   g_return_if_fail (GTK_IS_MENU (widget));
2520
2521   gtk_widget_set_realized (widget, TRUE);
2522
2523   gtk_widget_get_allocation (widget, &allocation);
2524
2525   attributes.window_type = GDK_WINDOW_CHILD;
2526   attributes.x = allocation.x;
2527   attributes.y = allocation.y;
2528   attributes.width = allocation.width;
2529   attributes.height = allocation.height;
2530   attributes.wclass = GDK_INPUT_OUTPUT;
2531   attributes.visual = gtk_widget_get_visual (widget);
2532   attributes.event_mask = gtk_widget_get_events (widget);
2533   attributes.event_mask |= (GDK_EXPOSURE_MASK | GDK_KEY_PRESS_MASK |
2534                             GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK );
2535
2536   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
2537
2538   window = gdk_window_new (gtk_widget_get_parent_window (widget),
2539                            &attributes, attributes_mask);
2540   gtk_widget_set_window (widget, window);
2541   gdk_window_set_user_data (window, widget);
2542
2543   get_menu_padding (widget, &padding);
2544   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2545   context = gtk_widget_get_style_context (widget);
2546
2547   gtk_widget_style_get (GTK_WIDGET (menu),
2548                         "vertical-padding", &vertical_padding,
2549                         "horizontal-padding", &horizontal_padding,
2550                         NULL);
2551
2552   gtk_widget_get_allocation (widget, &allocation);
2553
2554   attributes.x = border_width + padding.left + horizontal_padding;
2555   attributes.y = border_width + padding.top + vertical_padding;
2556   attributes.width = allocation.width -
2557     (2 * (border_width + horizontal_padding)) - padding.left - padding.right;
2558   attributes.height = allocation.height -
2559     (2 * (border_width + vertical_padding)) - padding.top - padding.bottom;
2560
2561   get_arrows_border (menu, &arrow_border);
2562   attributes.y += arrow_border.top;
2563   attributes.height -= arrow_border.top;
2564   attributes.height -= arrow_border.bottom;
2565
2566   attributes.width = MAX (1, attributes.width);
2567   attributes.height = MAX (1, attributes.height);
2568
2569   priv->view_window = gdk_window_new (window,
2570                                       &attributes, attributes_mask);
2571   gdk_window_set_user_data (priv->view_window, menu);
2572
2573   gtk_widget_get_allocation (widget, &allocation);
2574
2575   attributes.x = 0;
2576   attributes.y = 0;
2577   attributes.width = allocation.width + (2 * (border_width + horizontal_padding)) +
2578     padding.left + padding.right;
2579   attributes.height = priv->requested_height - (2 * (border_width + vertical_padding)) +
2580     padding.top + padding.bottom;
2581
2582   attributes.width = MAX (1, attributes.width);
2583   attributes.height = MAX (1, attributes.height);
2584
2585   priv->bin_window = gdk_window_new (priv->view_window,
2586                                      &attributes, attributes_mask);
2587   gdk_window_set_user_data (priv->bin_window, menu);
2588
2589   children = GTK_MENU_SHELL (menu)->priv->children;
2590   while (children)
2591     {
2592       child = children->data;
2593       children = children->next;
2594
2595       gtk_widget_set_parent_window (child, priv->bin_window);
2596     }
2597
2598   gtk_style_context_set_background (context, priv->bin_window);
2599   gtk_style_context_set_background (context, priv->view_window);
2600   gtk_style_context_set_background (context, window);
2601
2602   if (GTK_MENU_SHELL (widget)->priv->active_menu_item)
2603     gtk_menu_scroll_item_visible (GTK_MENU_SHELL (widget),
2604                                   GTK_MENU_SHELL (widget)->priv->active_menu_item);
2605
2606   gdk_window_show (priv->bin_window);
2607   gdk_window_show (priv->view_window);
2608 }
2609
2610 static gboolean
2611 gtk_menu_focus (GtkWidget       *widget,
2612                 GtkDirectionType direction)
2613 {
2614   /* A menu or its menu items cannot have focus */
2615   return FALSE;
2616 }
2617
2618 /* See notes in gtk_menu_popup() for information
2619  * about the "grab transfer window"
2620  */
2621 static GdkWindow *
2622 menu_grab_transfer_window_get (GtkMenu *menu)
2623 {
2624   GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2625   if (!window)
2626     {
2627       GdkWindowAttr attributes;
2628       gint attributes_mask;
2629
2630       attributes.x = -100;
2631       attributes.y = -100;
2632       attributes.width = 10;
2633       attributes.height = 10;
2634       attributes.window_type = GDK_WINDOW_TEMP;
2635       attributes.wclass = GDK_INPUT_ONLY;
2636       attributes.override_redirect = TRUE;
2637       attributes.event_mask = 0;
2638
2639       attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
2640
2641       window = gdk_window_new (gtk_widget_get_root_window (GTK_WIDGET (menu)),
2642                                &attributes, attributes_mask);
2643       gdk_window_set_user_data (window, menu);
2644
2645       gdk_window_show (window);
2646
2647       g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), window);
2648     }
2649
2650   return window;
2651 }
2652
2653 static void
2654 menu_grab_transfer_window_destroy (GtkMenu *menu)
2655 {
2656   GdkWindow *window = g_object_get_data (G_OBJECT (menu), "gtk-menu-transfer-window");
2657   if (window)
2658     {
2659       gdk_window_set_user_data (window, NULL);
2660       gdk_window_destroy (window);
2661       g_object_set_data (G_OBJECT (menu), I_("gtk-menu-transfer-window"), NULL);
2662     }
2663 }
2664
2665 static void
2666 gtk_menu_unrealize (GtkWidget *widget)
2667 {
2668   GtkMenu *menu = GTK_MENU (widget);
2669   GtkMenuPrivate *priv = menu->priv;
2670
2671   menu_grab_transfer_window_destroy (menu);
2672
2673   gdk_window_set_user_data (priv->view_window, NULL);
2674   gdk_window_destroy (priv->view_window);
2675   priv->view_window = NULL;
2676
2677   gdk_window_set_user_data (priv->bin_window, NULL);
2678   gdk_window_destroy (priv->bin_window);
2679   priv->bin_window = NULL;
2680
2681   GTK_WIDGET_CLASS (gtk_menu_parent_class)->unrealize (widget);
2682 }
2683
2684 static gint
2685 calculate_line_heights (GtkMenu *menu,
2686                         gint     for_width,
2687                         guint  **ret_min_heights,
2688                         guint  **ret_nat_heights)
2689 {
2690   GtkBorder       padding;
2691   GtkMenuPrivate *priv;
2692   GtkMenuShell   *menu_shell;
2693   GtkWidget      *child, *widget;
2694   GList          *children;
2695   guint           horizontal_padding;
2696   guint           border_width;
2697   guint           n_columns;
2698   gint            n_heights;
2699   guint          *min_heights;
2700   guint          *nat_heights;
2701   gint            avail_width;
2702
2703   priv         = menu->priv;
2704   widget       = GTK_WIDGET (menu);
2705   menu_shell   = GTK_MENU_SHELL (widget);
2706
2707   min_heights  = g_new0 (guint, gtk_menu_get_n_rows (menu));
2708   nat_heights  = g_new0 (guint, gtk_menu_get_n_rows (menu));
2709   n_heights    = gtk_menu_get_n_rows (menu);
2710   n_columns    = gtk_menu_get_n_columns (menu);
2711   avail_width  = for_width - (2 * priv->toggle_size + priv->accel_size) * n_columns;
2712
2713   gtk_widget_style_get (GTK_WIDGET (menu),
2714                         "horizontal-padding", &horizontal_padding,
2715                         NULL);
2716   get_menu_padding (widget, &padding);
2717
2718   border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2719   avail_width -= (border_width + horizontal_padding) * 2 + padding.left + padding.right;
2720
2721   for (children = menu_shell->priv->children; children; children = children->next)
2722     {
2723       gint part;
2724       gint toggle_size;
2725       gint l, r, t, b;
2726       gint child_min, child_nat;
2727
2728       child = children->data;
2729
2730       if (!gtk_widget_get_visible (child))
2731         continue;
2732
2733       get_effective_child_attach (child, &l, &r, &t, &b);
2734
2735       part = avail_width / (r - l);
2736
2737       gtk_widget_get_preferred_height_for_width (child, part,
2738                                                  &child_min, &child_nat);
2739
2740       gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
2741
2742       part = MAX (child_min, toggle_size) / (b - t);
2743       min_heights[t] = MAX (min_heights[t], part);
2744
2745       part = MAX (child_nat, toggle_size) / (b - t);
2746       nat_heights[t] = MAX (nat_heights[t], part);
2747     }
2748
2749   if (ret_min_heights)
2750     *ret_min_heights = min_heights;
2751   else
2752     g_free (min_heights);
2753
2754   if (ret_nat_heights)
2755     *ret_nat_heights = nat_heights;
2756   else
2757     g_free (nat_heights);
2758
2759   return n_heights;
2760 }
2761
2762 static void
2763 gtk_menu_size_allocate (GtkWidget     *widget,
2764                         GtkAllocation *allocation)
2765 {
2766   GtkMenu *menu;
2767   GtkMenuPrivate *priv;
2768   GtkMenuShell *menu_shell;
2769   GtkWidget *child;
2770   GtkAllocation child_allocation;
2771   GList *children;
2772   gint x, y, i;
2773   gint width, height;
2774   guint border_width;
2775   guint vertical_padding;
2776   guint horizontal_padding;
2777   GtkBorder padding;
2778
2779   g_return_if_fail (GTK_IS_MENU (widget));
2780   g_return_if_fail (allocation != NULL);
2781
2782   menu = GTK_MENU (widget);
2783   menu_shell = GTK_MENU_SHELL (widget);
2784   priv = menu->priv;
2785
2786   gtk_widget_set_allocation (widget, allocation);
2787
2788   gtk_widget_style_get (GTK_WIDGET (menu),
2789                         "vertical-padding", &vertical_padding,
2790                         "horizontal-padding", &horizontal_padding,
2791                         NULL);
2792
2793   get_menu_padding (widget, &padding);
2794   border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
2795
2796   g_free (priv->heights);
2797   priv->heights_length = calculate_line_heights (menu,
2798                                                  allocation->width,
2799                                                  &priv->heights,
2800                                                  NULL);
2801
2802   /* refresh our cached height request */
2803   priv->requested_height = (2 * (border_width + vertical_padding)) +
2804     padding.top + padding.bottom;
2805   for (i = 0; i < priv->heights_length; i++)
2806     priv->requested_height += priv->heights[i];
2807
2808   x = border_width + padding.left + horizontal_padding;
2809   y = border_width + padding.top + vertical_padding;
2810   width = allocation->width - (2 * (border_width + horizontal_padding)) -
2811     padding.left - padding.right;
2812   height = allocation->height - (2 * (border_width + vertical_padding)) -
2813     padding.top - padding.bottom;
2814
2815   if (menu_shell->priv->active)
2816     gtk_menu_scroll_to (menu, priv->scroll_offset);
2817
2818   if (!priv->tearoff_active)
2819     {
2820       GtkBorder arrow_border;
2821
2822       get_arrows_border (menu, &arrow_border);
2823       y += arrow_border.top;
2824       height -= arrow_border.top;
2825       height -= arrow_border.bottom;
2826     }
2827
2828   width = MAX (1, width);
2829   height = MAX (1, height);
2830
2831   if (gtk_widget_get_realized (widget))
2832     {
2833       gdk_window_move_resize (gtk_widget_get_window (widget),
2834                               allocation->x, allocation->y,
2835                               allocation->width, allocation->height);
2836
2837       gdk_window_move_resize (priv->view_window, x, y, width, height);
2838     }
2839
2840   if (menu_shell->priv->children)
2841     {
2842       gint base_width = width / gtk_menu_get_n_columns (menu);
2843
2844       children = menu_shell->priv->children;
2845       while (children)
2846         {
2847           child = children->data;
2848           children = children->next;
2849
2850           if (gtk_widget_get_visible (child))
2851             {
2852               gint i;
2853               gint l, r, t, b;
2854
2855               get_effective_child_attach (child, &l, &r, &t, &b);
2856
2857               if (gtk_widget_get_direction (GTK_WIDGET (menu)) == GTK_TEXT_DIR_RTL)
2858                 {
2859                   guint tmp;
2860                   tmp = gtk_menu_get_n_columns (menu) - l;
2861                   l = gtk_menu_get_n_columns (menu) - r;
2862                   r = tmp;
2863                 }
2864
2865               child_allocation.width = (r - l) * base_width;
2866               child_allocation.height = 0;
2867               child_allocation.x = l * base_width;
2868               child_allocation.y = 0;
2869
2870               for (i = 0; i < b; i++)
2871                 {
2872                   if (i < t)
2873                     child_allocation.y += priv->heights[i];
2874                   else
2875                     child_allocation.height += priv->heights[i];
2876                 }
2877
2878               gtk_menu_item_toggle_size_allocate (GTK_MENU_ITEM (child),
2879                                                   priv->toggle_size);
2880
2881               gtk_widget_size_allocate (child, &child_allocation);
2882               gtk_widget_queue_draw (child);
2883             }
2884         }
2885
2886       /* Resize the item window */
2887       if (gtk_widget_get_realized (widget))
2888         {
2889           gint i;
2890           gint width, height;
2891
2892           height = 0;
2893           for (i = 0; i < gtk_menu_get_n_rows (menu); i++)
2894             height += priv->heights[i];
2895
2896           width = gtk_menu_get_n_columns (menu) * base_width;
2897           gdk_window_resize (priv->bin_window, width, height);
2898         }
2899
2900       if (priv->tearoff_active)
2901         {
2902           if (height >= priv->requested_height)
2903             {
2904               if (gtk_widget_get_visible (priv->tearoff_scrollbar))
2905                 {
2906                   gtk_widget_hide (priv->tearoff_scrollbar);
2907                   gtk_menu_set_tearoff_hints (menu, allocation->width);
2908
2909                   gtk_menu_scroll_to (menu, 0);
2910                 }
2911             }
2912           else
2913             {
2914               gtk_adjustment_configure (priv->tearoff_adjustment,
2915                                         gtk_adjustment_get_value (priv->tearoff_adjustment),
2916                                         0,
2917                                         priv->requested_height,
2918                                         gtk_adjustment_get_step_increment (priv->tearoff_adjustment),
2919                                         gtk_adjustment_get_page_increment (priv->tearoff_adjustment),
2920                                         allocation->height);
2921
2922               if (!gtk_widget_get_visible (priv->tearoff_scrollbar))
2923                 {
2924                   gtk_widget_show (priv->tearoff_scrollbar);
2925                   gtk_menu_set_tearoff_hints (menu, allocation->width);
2926                 }
2927             }
2928         }
2929     }
2930 }
2931
2932 static void
2933 get_arrows_visible_area (GtkMenu      *menu,
2934                          GdkRectangle *border,
2935                          GdkRectangle *upper,
2936                          GdkRectangle *lower,
2937                          gint         *arrow_space)
2938 {
2939   GtkArrowPlacement arrow_placement;
2940   GtkWidget *widget = GTK_WIDGET (menu);
2941   guint border_width;
2942   guint vertical_padding;
2943   guint horizontal_padding;
2944   gint scroll_arrow_height;
2945   GtkBorder menu_padding;
2946
2947   gtk_widget_style_get (widget,
2948                         "vertical-padding", &vertical_padding,
2949                         "horizontal-padding", &horizontal_padding,
2950                         "scroll-arrow-vlength", &scroll_arrow_height,
2951                         "arrow-placement", &arrow_placement,
2952                         NULL);
2953
2954   get_menu_padding (widget, &menu_padding);
2955   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2956   border->x = border_width + menu_padding.left + horizontal_padding;
2957   border->y = border_width + menu_padding.top + vertical_padding;
2958   border->width = gdk_window_get_width (gtk_widget_get_window (widget));
2959   border->height = gdk_window_get_height (gtk_widget_get_window (widget));
2960
2961   switch (arrow_placement)
2962     {
2963     case GTK_ARROWS_BOTH:
2964       upper->x = border->x;
2965       upper->y = border->y;
2966       upper->width = border->width - 2 * border->x;
2967       upper->height = scroll_arrow_height;
2968
2969       lower->x = border->x;
2970       lower->y = border->height - border->y - scroll_arrow_height;
2971       lower->width = border->width - 2 * border->x;
2972       lower->height = scroll_arrow_height;
2973       break;
2974
2975     case GTK_ARROWS_START:
2976       upper->x = border->x;
2977       upper->y = border->y;
2978       upper->width = (border->width - 2 * border->x) / 2;
2979       upper->height = scroll_arrow_height;
2980
2981       lower->x = border->x + upper->width;
2982       lower->y = border->y;
2983       lower->width = (border->width - 2 * border->x) / 2;
2984       lower->height = scroll_arrow_height;
2985       break;
2986
2987     case GTK_ARROWS_END:
2988       upper->x = border->x;
2989       upper->y = border->height - border->y - scroll_arrow_height;
2990       upper->width = (border->width - 2 * border->x) / 2;
2991       upper->height = scroll_arrow_height;
2992
2993       lower->x = border->x + upper->width;
2994       lower->y = border->height - border->y - scroll_arrow_height;
2995       lower->width = (border->width - 2 * border->x) / 2;
2996       lower->height = scroll_arrow_height;
2997       break;
2998
2999     default:
3000        g_assert_not_reached();
3001        upper->x = upper->y = upper->width = upper->height = 0;
3002        lower->x = lower->y = lower->width = lower->height = 0;
3003     }
3004
3005   *arrow_space = scroll_arrow_height - menu_padding.top - menu_padding.bottom;
3006 }
3007
3008 static gboolean
3009 gtk_menu_draw (GtkWidget *widget,
3010                cairo_t   *cr)
3011 {
3012   GtkMenu *menu;
3013   GtkMenuPrivate *priv;
3014   GtkStyleContext *context;
3015   GdkRectangle border;
3016   GdkRectangle upper;
3017   GdkRectangle lower;
3018   gint arrow_space;
3019   GtkBorder menu_padding;
3020
3021   menu = GTK_MENU (widget);
3022   priv = menu->priv;
3023   context = gtk_widget_get_style_context (widget);
3024
3025   get_arrows_visible_area (menu, &border, &upper, &lower, &arrow_space);
3026   get_menu_padding (widget, &menu_padding);
3027
3028   if (gtk_cairo_should_draw_window (cr, gtk_widget_get_window (widget)))
3029     {
3030       gfloat arrow_scaling;
3031       gint arrow_size;
3032
3033       gtk_widget_style_get (widget, "arrow-scaling", &arrow_scaling, NULL);
3034       arrow_size = arrow_scaling * arrow_space;
3035
3036       gtk_render_background (context, cr, 0, 0,
3037                              gtk_widget_get_allocated_width (widget),
3038                              gtk_widget_get_allocated_height (widget));
3039       gtk_render_frame (context, cr, 0, 0,
3040                         gtk_widget_get_allocated_width (widget),
3041                         gtk_widget_get_allocated_height (widget));
3042
3043       gtk_style_context_save (context);
3044       gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
3045
3046       if (priv->upper_arrow_visible && !priv->tearoff_active)
3047         {
3048           gtk_style_context_save (context);
3049           gtk_style_context_set_state (context, priv->upper_arrow_state);
3050
3051           gtk_render_background (context, cr,
3052                                  upper.x, upper.y,
3053                                  upper.width, upper.height);
3054           gtk_render_frame (context, cr,
3055                             upper.x, upper.y,
3056                             upper.width, upper.height);
3057
3058           gtk_render_arrow (context, cr, 0,
3059                             upper.x + (upper.width - arrow_size) / 2,
3060                             upper.y + menu_padding.top + (arrow_space - arrow_size) / 2,
3061                             arrow_size);
3062
3063           gtk_style_context_restore (context);
3064         }
3065
3066       if (priv->lower_arrow_visible && !priv->tearoff_active)
3067         {
3068           gtk_style_context_save (context);
3069           gtk_style_context_set_state (context, priv->lower_arrow_state);
3070
3071           gtk_render_background (context, cr,
3072                                  lower.x, lower.y,
3073                                  lower.width, lower.height);
3074           gtk_render_frame (context, cr,
3075                             lower.x, lower.y,
3076                             lower.width, lower.height);
3077
3078           gtk_render_arrow (context, cr, G_PI,
3079                             lower.x + (lower.width - arrow_size) / 2,
3080                             lower.y + menu_padding.bottom + (arrow_space - arrow_size) / 2,
3081                             arrow_size);
3082
3083           gtk_style_context_restore (context);
3084         }
3085
3086       gtk_style_context_restore (context);
3087     }
3088
3089   if (gtk_cairo_should_draw_window (cr, priv->bin_window))
3090     {
3091       gint y = -border.y + priv->scroll_offset;
3092
3093       cairo_save (cr);
3094       gtk_cairo_transform_to_window (cr, widget, priv->bin_window);
3095
3096       if (!priv->tearoff_active)
3097         {
3098           GtkBorder arrow_border;
3099
3100           get_arrows_border (menu, &arrow_border);
3101           y -= arrow_border.top;
3102         }
3103
3104       gtk_render_background (context, cr,
3105                              - border.x, y,
3106                              border.width, border.height);
3107       gtk_render_frame (context, cr,
3108                         - border.x, y,
3109                         border.width, border.height);
3110
3111       cairo_restore (cr);
3112     }
3113
3114   GTK_WIDGET_CLASS (gtk_menu_parent_class)->draw (widget, cr);
3115
3116   return FALSE;
3117 }
3118
3119 static void
3120 gtk_menu_show (GtkWidget *widget)
3121 {
3122   GtkMenu *menu = GTK_MENU (widget);
3123
3124   _gtk_menu_refresh_accel_paths (menu, FALSE);
3125
3126   GTK_WIDGET_CLASS (gtk_menu_parent_class)->show (widget);
3127 }
3128
3129
3130 static void
3131 gtk_menu_get_preferred_width (GtkWidget *widget,
3132                               gint      *minimum_size,
3133                               gint      *natural_size)
3134 {
3135   GtkMenu        *menu;
3136   GtkMenuShell   *menu_shell;
3137   GtkMenuPrivate *priv;
3138   GtkWidget      *child;
3139   GList          *children;
3140   guint           max_toggle_size;
3141   guint           max_accel_width;
3142   guint           horizontal_padding;
3143   guint           border_width;
3144   gint            child_min, child_nat;
3145   gint            min_width, nat_width;
3146   GtkBorder       padding;
3147
3148   menu       = GTK_MENU (widget);
3149   menu_shell = GTK_MENU_SHELL (widget);
3150   priv       = menu->priv;
3151
3152   min_width = nat_width = 0;
3153
3154   max_toggle_size = 0;
3155   max_accel_width = 0;
3156
3157   children = menu_shell->priv->children;
3158   while (children)
3159     {
3160       gint part;
3161       gint toggle_size;
3162       gint l, r, t, b;
3163
3164       child = children->data;
3165       children = children->next;
3166
3167       if (! gtk_widget_get_visible (child))
3168         continue;
3169
3170       get_effective_child_attach (child, &l, &r, &t, &b);
3171
3172       /* It's important to size_request the child
3173        * before doing the toggle size request, in
3174        * case the toggle size request depends on the size
3175        * request of a child of the child (e.g. for ImageMenuItem)
3176        */
3177        gtk_widget_get_preferred_width (child, &child_min, &child_nat);
3178
3179        gtk_menu_item_toggle_size_request (GTK_MENU_ITEM (child), &toggle_size);
3180        max_toggle_size = MAX (max_toggle_size, toggle_size);
3181        max_accel_width = MAX (max_accel_width,
3182                               GTK_MENU_ITEM (child)->priv->accelerator_width);
3183
3184        part = child_min / (r - l);
3185        min_width = MAX (min_width, part);
3186
3187        part = child_nat / (r - l);
3188        nat_width = MAX (nat_width, part);
3189     }
3190
3191   /* If the menu doesn't include any images or check items
3192    * reserve the space so that all menus are consistent.
3193    * We only do this for 'ordinary' menus, not for combobox
3194    * menus or multi-column menus
3195    */
3196   if (max_toggle_size == 0 &&
3197       gtk_menu_get_n_columns (menu) == 1 &&
3198       !priv->no_toggle_size)
3199     {
3200       GtkStyleContext *context;
3201       GtkWidgetPath *menu_path, *check_path;
3202       guint toggle_spacing;
3203       guint indicator_size;
3204
3205       context = gtk_widget_get_style_context (widget);
3206       menu_path = gtk_widget_path_copy (gtk_style_context_get_path (context));
3207
3208       /* Create a GtkCheckMenuItem path, only to query indicator spacing */
3209       check_path = gtk_widget_path_copy (menu_path);
3210       gtk_widget_path_append_type (check_path, GTK_TYPE_CHECK_MENU_ITEM);
3211
3212       gtk_style_context_set_path (context, check_path);
3213       gtk_widget_path_free (check_path);
3214
3215       gtk_style_context_get_style (context,
3216                                    "toggle-spacing", &toggle_spacing,
3217                                    "indicator-size", &indicator_size,
3218                                    NULL);
3219
3220       max_toggle_size = indicator_size + toggle_spacing;
3221
3222       /* Restore real widget path */
3223       gtk_style_context_set_path (context, menu_path);
3224       gtk_widget_path_free (menu_path);
3225     }
3226
3227   min_width += 2 * max_toggle_size + max_accel_width;
3228   min_width *= gtk_menu_get_n_columns (menu);
3229
3230   nat_width += 2 * max_toggle_size + max_accel_width;
3231   nat_width *= gtk_menu_get_n_columns (menu);
3232
3233   gtk_widget_style_get (GTK_WIDGET (menu),
3234                         "horizontal-padding", &horizontal_padding,
3235                         NULL);
3236
3237   get_menu_padding (widget, &padding);
3238   border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3239   min_width   += (2 * (border_width + horizontal_padding)) +
3240     padding.left + padding.right;
3241   nat_width   += (2 * (border_width + horizontal_padding)) +
3242     padding.left + padding.right;
3243
3244   priv->toggle_size = max_toggle_size;
3245   priv->accel_size  = max_accel_width;
3246
3247   if (minimum_size)
3248     *minimum_size = min_width;
3249
3250   if (natural_size)
3251     *natural_size = nat_width;
3252
3253   /* Don't resize the tearoff if it is not active,
3254    * because it won't redraw (it is only a background pixmap).
3255    */
3256   if (priv->tearoff_active)
3257     gtk_menu_set_tearoff_hints (menu, min_width);
3258 }
3259
3260 static void
3261 gtk_menu_get_preferred_height (GtkWidget *widget,
3262                                gint      *minimum_size,
3263                                gint      *natural_size)
3264 {
3265   gint min_width;
3266
3267   /* Menus are height-for-width only, just return the height
3268    * for the minimum width
3269    */
3270   GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
3271   GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
3272 }
3273
3274 static void
3275 gtk_menu_get_preferred_height_for_width (GtkWidget *widget,
3276                                          gint       for_size,
3277                                          gint      *minimum_size,
3278                                          gint      *natural_size)
3279 {
3280   GtkBorder       padding;
3281   GtkMenu        *menu = GTK_MENU (widget);
3282   GtkMenuPrivate *priv = menu->priv;
3283   guint          *min_heights, *nat_heights;
3284   guint           vertical_padding, border_width;
3285   gint            n_heights, i;
3286   gint            min_height, nat_height;
3287
3288   gtk_widget_style_get (widget, "vertical-padding", &vertical_padding, NULL);
3289   border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
3290   get_menu_padding (widget, &padding);
3291
3292   min_height = nat_height = (border_width + vertical_padding) * 2 +
3293           padding.top + padding.bottom;
3294
3295   n_heights =
3296     calculate_line_heights (menu, for_size, &min_heights, &nat_heights);
3297
3298   for (i = 0; i < n_heights; i++)
3299     {
3300       min_height += min_heights[i];
3301       nat_height += nat_heights[i];
3302     }
3303
3304   if (priv->have_position)
3305     {
3306       GdkScreen *screen = gtk_widget_get_screen (priv->toplevel);
3307       GdkRectangle monitor;
3308
3309       gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
3310
3311       if (priv->position_y + min_height > monitor.y + monitor.height)
3312         min_height = monitor.y + monitor.height - priv->position_y;
3313
3314       if (priv->position_y + nat_height > monitor.y + monitor.height)
3315         nat_height = monitor.y + monitor.height - priv->position_y;
3316
3317       if (priv->position_y < monitor.y)
3318         {
3319           min_height -= monitor.y - priv->position_y;
3320           nat_height -= monitor.y - priv->position_y;
3321         }
3322     }
3323
3324   if (minimum_size)
3325     *minimum_size = min_height;
3326
3327   if (natural_size)
3328     *natural_size = nat_height;
3329
3330   g_free (min_heights);
3331   g_free (nat_heights);
3332 }
3333
3334 static gboolean
3335 pointer_in_menu_window (GtkWidget *widget,
3336                         gdouble    x_root,
3337                         gdouble    y_root)
3338 {
3339   GtkMenu *menu = GTK_MENU (widget);
3340   GtkMenuPrivate *priv = menu->priv;
3341   GtkAllocation allocation;
3342
3343   if (gtk_widget_get_mapped (priv->toplevel))
3344     {
3345       GtkMenuShell *menu_shell;
3346       gint          window_x, window_y;
3347
3348       gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
3349                                &window_x, &window_y);
3350
3351       gtk_widget_get_allocation (widget, &allocation);
3352       if (x_root >= window_x && x_root < window_x + allocation.width &&
3353           y_root >= window_y && y_root < window_y + allocation.height)
3354         return TRUE;
3355
3356       menu_shell = GTK_MENU_SHELL (widget);
3357
3358       if (GTK_IS_MENU (menu_shell->priv->parent_menu_shell))
3359         return pointer_in_menu_window (menu_shell->priv->parent_menu_shell,
3360                                        x_root, y_root);
3361     }
3362
3363   return FALSE;
3364 }
3365
3366 static gboolean
3367 gtk_menu_button_press (GtkWidget      *widget,
3368                        GdkEventButton *event)
3369 {
3370   if (event->type != GDK_BUTTON_PRESS)
3371     return FALSE;
3372
3373   /*  Don't pass down to menu shell if a non-menuitem part of the menu
3374    *  was clicked. The check for the event_widget being a GtkMenuShell
3375    *  works because we have the pointer grabbed on menu_shell->window
3376    *  with owner_events=TRUE, so all events that are either outside
3377    *  the menu or on its border are delivered relative to
3378    *  menu_shell->window.
3379    */
3380   if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3381       pointer_in_menu_window (widget, event->x_root, event->y_root))
3382     return TRUE;
3383
3384   return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_press_event (widget, event);
3385 }
3386
3387 static gboolean
3388 gtk_menu_button_release (GtkWidget      *widget,
3389                          GdkEventButton *event)
3390 {
3391   GtkMenuPrivate *priv = GTK_MENU (widget)->priv;
3392
3393   if (priv->ignore_button_release)
3394     {
3395       priv->ignore_button_release = FALSE;
3396       return FALSE;
3397     }
3398
3399   if (event->type != GDK_BUTTON_RELEASE)
3400     return FALSE;
3401
3402   /*  Don't pass down to menu shell if a non-menuitem part of the menu
3403    *  was clicked (see comment in button_press()).
3404    */
3405   if (GTK_IS_MENU_SHELL (gtk_get_event_widget ((GdkEvent *) event)) &&
3406       pointer_in_menu_window (widget, event->x_root, event->y_root))
3407     {
3408       /*  Ugly: make sure menu_shell->button gets reset to 0 when we
3409        *  bail out early here so it is in a consistent state for the
3410        *  next button_press/button_release in GtkMenuShell.
3411        *  See bug #449371.
3412        */
3413       if (GTK_MENU_SHELL (widget)->priv->active)
3414         GTK_MENU_SHELL (widget)->priv->button = 0;
3415
3416       return TRUE;
3417     }
3418
3419   return GTK_WIDGET_CLASS (gtk_menu_parent_class)->button_release_event (widget, event);
3420 }
3421
3422 static const gchar *
3423 get_accel_path (GtkWidget *menu_item,
3424                 gboolean  *locked)
3425 {
3426   const gchar *path;
3427   GtkWidget *label;
3428   GClosure *accel_closure;
3429   GtkAccelGroup *accel_group;
3430
3431   path = _gtk_widget_get_accel_path (menu_item, locked);
3432   if (!path)
3433     {
3434       path = GTK_MENU_ITEM (menu_item)->priv->accel_path;
3435
3436       if (locked)
3437         {
3438           *locked = TRUE;
3439
3440           label = gtk_bin_get_child (GTK_BIN (menu_item));
3441
3442           if (GTK_IS_ACCEL_LABEL (label))
3443             {
3444               g_object_get (label,
3445                             "accel-closure", &accel_closure,
3446                             NULL);
3447               if (accel_closure)
3448                 {
3449                   accel_group = gtk_accel_group_from_accel_closure (accel_closure);
3450
3451                   *locked = gtk_accel_group_get_is_locked (accel_group);
3452                 }
3453             }
3454         }
3455     }
3456
3457   return path;
3458 }
3459
3460 static gboolean
3461 gtk_menu_key_press (GtkWidget   *widget,
3462                     GdkEventKey *event)
3463 {
3464   GtkMenuShell *menu_shell;
3465   GtkMenu *menu;
3466   gboolean delete = FALSE;
3467   gboolean can_change_accels;
3468   gchar *accel = NULL;
3469   guint accel_key, accel_mods;
3470   GdkModifierType consumed_modifiers;
3471   GdkDisplay *display;
3472
3473   g_return_val_if_fail (GTK_IS_MENU (widget), FALSE);
3474   g_return_val_if_fail (event != NULL, FALSE);
3475
3476   menu_shell = GTK_MENU_SHELL (widget);
3477   menu = GTK_MENU (widget);
3478
3479   gtk_menu_stop_navigating_submenu (menu);
3480
3481   if (GTK_WIDGET_CLASS (gtk_menu_parent_class)->key_press_event (widget, event))
3482     return TRUE;
3483
3484   display = gtk_widget_get_display (widget);
3485
3486   g_object_get (gtk_widget_get_settings (widget),
3487                 "gtk-menu-bar-accel", &accel,
3488                 "gtk-can-change-accels", &can_change_accels,
3489                 NULL);
3490
3491   if (accel && *accel)
3492     {
3493       guint keyval = 0;
3494       GdkModifierType mods = 0;
3495
3496       gtk_accelerator_parse (accel, &keyval, &mods);
3497
3498       if (keyval == 0)
3499         g_warning ("Failed to parse menu bar accelerator '%s'\n", accel);
3500
3501       /* FIXME this is wrong, needs to be in the global accel resolution
3502        * thing, to properly consider i18n etc., but that probably requires
3503        * AccelGroup changes etc.
3504        */
3505       if (event->keyval == keyval && (mods & event->state) == mods)
3506         {
3507           gtk_menu_shell_cancel (menu_shell);
3508           g_free (accel);
3509           return TRUE;
3510         }
3511     }
3512
3513   g_free (accel);
3514
3515   switch (event->keyval)
3516     {
3517     case GDK_KEY_Delete:
3518     case GDK_KEY_KP_Delete:
3519     case GDK_KEY_BackSpace:
3520       delete = TRUE;
3521       break;
3522     default:
3523       break;
3524     }
3525
3526   /* Figure out what modifiers went into determining the key symbol */
3527   _gtk_translate_keyboard_accel_state (gdk_keymap_get_for_display (display),
3528                                        event->hardware_keycode,
3529                                        event->state,
3530                                        gtk_accelerator_get_default_mod_mask (),
3531                                        event->group,
3532                                        &accel_key, NULL, NULL, &consumed_modifiers);
3533
3534   accel_key = gdk_keyval_to_lower (accel_key);
3535   accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
3536
3537   /* If lowercasing affects the keysym, then we need to include SHIFT
3538    * in the modifiers, We re-upper case when we match against the
3539    * keyval, but display and save in caseless form.
3540    */
3541   if (accel_key != event->keyval)
3542     accel_mods |= GDK_SHIFT_MASK;
3543
3544   /* Modify the accelerators */
3545   if (can_change_accels &&
3546       menu_shell->priv->active_menu_item &&
3547       gtk_bin_get_child (GTK_BIN (menu_shell->priv->active_menu_item)) && /* no separators */
3548       GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu == NULL &&  /* no submenus */
3549       (delete || gtk_accelerator_valid (accel_key, accel_mods)))
3550     {
3551       GtkWidget *menu_item = menu_shell->priv->active_menu_item;
3552       gboolean locked, replace_accels = TRUE;
3553       const gchar *path;
3554
3555       path = get_accel_path (menu_item, &locked);
3556       if (!path || locked)
3557         {
3558           /* Can't change accelerators on menu_items without paths
3559            * (basically, those items are accelerator-locked).
3560            */
3561           gtk_widget_error_bell (widget);
3562         }
3563       else
3564         {
3565           gboolean changed;
3566
3567           /* For the keys that act to delete the current setting,
3568            * we delete the current setting if there is one, otherwise,
3569            * we set the key as the accelerator.
3570            */
3571           if (delete)
3572             {
3573               GtkAccelKey key;
3574
3575               if (gtk_accel_map_lookup_entry (path, &key) &&
3576                   (key.accel_key || key.accel_mods))
3577                 {
3578                   accel_key = 0;
3579                   accel_mods = 0;
3580                 }
3581             }
3582           changed = gtk_accel_map_change_entry (path, accel_key, accel_mods, replace_accels);
3583
3584           if (!changed)
3585             {
3586               /* We failed, probably because this key is in use
3587                * and locked already.
3588                */
3589               gtk_widget_error_bell (widget);
3590             }
3591         }
3592     }
3593
3594   return TRUE;
3595 }
3596
3597 static gboolean
3598 check_threshold (GtkWidget *widget,
3599                  gint       start_x,
3600                  gint       start_y,
3601                  gint       x,
3602                  gint       y)
3603 {
3604 #define THRESHOLD 8
3605
3606   return
3607     ABS (start_x - x) > THRESHOLD ||
3608     ABS (start_y - y) > THRESHOLD;
3609 }
3610
3611 static gboolean
3612 definitely_within_item (GtkWidget *widget,
3613                         gint       x,
3614                         gint       y)
3615 {
3616   GdkWindow *window = GTK_MENU_ITEM (widget)->priv->event_window;
3617   int w, h;
3618
3619   w = gdk_window_get_width (window);
3620   h = gdk_window_get_height (window);
3621
3622   return
3623     check_threshold (widget, 0, 0, x, y) &&
3624     check_threshold (widget, w - 1, 0, x, y) &&
3625     check_threshold (widget, w - 1, h - 1, x, y) &&
3626     check_threshold (widget, 0, h - 1, x, y);
3627 }
3628
3629 static gboolean
3630 gtk_menu_has_navigation_triangle (GtkMenu *menu)
3631 {
3632   GtkMenuPrivate *priv = menu->priv;
3633
3634   return priv->navigation_height && priv->navigation_width;
3635 }
3636
3637 static gboolean
3638 gtk_menu_motion_notify (GtkWidget      *widget,
3639                         GdkEventMotion *event)
3640 {
3641   GtkWidget *menu_item;
3642   GtkMenu *menu;
3643   GtkMenuShell *menu_shell;
3644   GtkWidget *parent;
3645   GdkDevice *source_device;
3646
3647   gboolean need_enter;
3648
3649   source_device = gdk_event_get_source_device ((GdkEvent *) event);
3650
3651   if (GTK_IS_MENU (widget) &&
3652       gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
3653     {
3654       GtkMenuPrivate *priv = GTK_MENU(widget)->priv;
3655
3656       if (priv->ignore_button_release)
3657         priv->ignore_button_release = FALSE;
3658
3659       gtk_menu_handle_scrolling (GTK_MENU (widget), event->x_root, event->y_root,
3660                                  TRUE, TRUE);
3661     }
3662
3663   /* We received the event for one of two reasons:
3664    *
3665    * a) We are the active menu, and did gtk_grab_add()
3666    * b) The widget is a child of ours, and the event was propagated
3667    *
3668    * Since for computation of navigation regions, we want the menu which
3669    * is the parent of the menu item, for a), we need to find that menu,
3670    * which may be different from 'widget'.
3671    */
3672   menu_item = gtk_get_event_widget ((GdkEvent*) event);
3673   parent = gtk_widget_get_parent (menu_item);
3674   if (!GTK_IS_MENU_ITEM (menu_item) ||
3675       !GTK_IS_MENU (parent))
3676     return FALSE;
3677
3678   menu_shell = GTK_MENU_SHELL (parent);
3679   menu = GTK_MENU (menu_shell);
3680
3681   if (definitely_within_item (menu_item, event->x, event->y))
3682     menu_shell->priv->activate_time = 0;
3683
3684   need_enter = (gtk_menu_has_navigation_triangle (menu) || menu_shell->priv->ignore_enter);
3685
3686   /* Check to see if we are within an active submenu's navigation region
3687    */
3688   if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
3689     return TRUE;
3690
3691   /* Make sure we pop down if we enter a non-selectable menu item, so we
3692    * don't show a submenu when the cursor is outside the stay-up triangle.
3693    */
3694   if (!_gtk_menu_item_is_selectable (menu_item))
3695     {
3696       /* We really want to deselect, but this gives the menushell code
3697        * a chance to do some bookkeeping about the menuitem.
3698        */
3699       gtk_menu_shell_select_item (menu_shell, menu_item);
3700       return FALSE;
3701     }
3702
3703   if (need_enter)
3704     {
3705       /* The menu is now sensitive to enter events on its items, but
3706        * was previously sensitive.  So we fake an enter event.
3707        */
3708       menu_shell->priv->ignore_enter = FALSE;
3709
3710       if (event->x >= 0 && event->x < gdk_window_get_width (event->window) &&
3711           event->y >= 0 && event->y < gdk_window_get_height (event->window))
3712         {
3713           GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
3714           gboolean result;
3715
3716           send_event->crossing.window = g_object_ref (event->window);
3717           send_event->crossing.time = event->time;
3718           send_event->crossing.send_event = TRUE;
3719           send_event->crossing.x_root = event->x_root;
3720           send_event->crossing.y_root = event->y_root;
3721           send_event->crossing.x = event->x;
3722           send_event->crossing.y = event->y;
3723           send_event->crossing.state = event->state;
3724           gdk_event_set_device (send_event, gdk_event_get_device ((GdkEvent *) event));
3725
3726           /* We send the event to 'widget', the currently active menu,
3727            * instead of 'menu', the menu that the pointer is in. This
3728            * will ensure that the event will be ignored unless the
3729            * menuitem is a child of the active menu or some parent
3730            * menu of the active menu.
3731            */
3732           result = gtk_widget_event (widget, send_event);
3733           gdk_event_free (send_event);
3734
3735           return result;
3736         }
3737     }
3738
3739   return FALSE;
3740 }
3741
3742 static gboolean
3743 get_double_arrows (GtkMenu *menu)
3744 {
3745   GtkMenuPrivate   *priv = menu->priv;
3746   gboolean          double_arrows;
3747   GtkArrowPlacement arrow_placement;
3748
3749   gtk_widget_style_get (GTK_WIDGET (menu),
3750                         "double-arrows", &double_arrows,
3751                         "arrow-placement", &arrow_placement,
3752                         NULL);
3753
3754   if (arrow_placement != GTK_ARROWS_BOTH)
3755     return TRUE;
3756
3757   return double_arrows || (priv->initially_pushed_in &&
3758                            priv->scroll_offset != 0);
3759 }
3760
3761 static void
3762 gtk_menu_scroll_by (GtkMenu *menu,
3763                     gint     step)
3764 {
3765   GtkMenuPrivate *priv = menu->priv;
3766   GtkBorder arrow_border;
3767   GtkWidget *widget;
3768   gint offset;
3769   gint view_height;
3770   gboolean double_arrows;
3771
3772   widget = GTK_WIDGET (menu);
3773   offset = priv->scroll_offset + step;
3774
3775   get_arrows_border (menu, &arrow_border);
3776
3777   double_arrows = get_double_arrows (menu);
3778
3779   /* If we scroll upward and the non-visible top part
3780    * is smaller than the scroll arrow it would be
3781    * pretty stupid to show the arrow and taking more
3782    * screen space than just scrolling to the top.
3783    */
3784   if (!double_arrows)
3785     if ((step < 0) && (offset < arrow_border.top))
3786       offset = 0;
3787
3788   /* Don't scroll over the top if we weren't before: */
3789   if ((priv->scroll_offset >= 0) && (offset < 0))
3790     offset = 0;
3791
3792   view_height = gdk_window_get_height (gtk_widget_get_window (widget));
3793
3794   if (priv->scroll_offset == 0 &&
3795       view_height >= priv->requested_height)
3796     return;
3797
3798   /* Don't scroll past the bottom if we weren't before: */
3799   if (priv->scroll_offset > 0)
3800     view_height -= arrow_border.top;
3801
3802   /* When both arrows are always shown,
3803    * reduce view height even more.
3804    */
3805   if (double_arrows)
3806     view_height -= arrow_border.bottom;
3807
3808   if ((priv->scroll_offset + view_height <= priv->requested_height) &&
3809       (offset + view_height > priv->requested_height))
3810     offset = priv->requested_height - view_height;
3811
3812   if (offset != priv->scroll_offset)
3813     gtk_menu_scroll_to (menu, offset);
3814 }
3815
3816 static void
3817 gtk_menu_do_timeout_scroll (GtkMenu  *menu,
3818                             gboolean  touchscreen_mode)
3819 {
3820   GtkMenuPrivate *priv = menu->priv;
3821   gboolean upper_visible;
3822   gboolean lower_visible;
3823
3824   upper_visible = priv->upper_arrow_visible;
3825   lower_visible = priv->lower_arrow_visible;
3826
3827   gtk_menu_scroll_by (menu, priv->scroll_step);
3828
3829   if (touchscreen_mode &&
3830       (upper_visible != priv->upper_arrow_visible ||
3831        lower_visible != priv->lower_arrow_visible))
3832     {
3833       /* We are about to hide a scroll arrow while the mouse is pressed,
3834        * this would cause the uncovered menu item to be activated on button
3835        * release. Therefore we need to ignore button release here
3836        */
3837       GTK_MENU_SHELL (menu)->priv->ignore_enter = TRUE;
3838       priv->ignore_button_release = TRUE;
3839     }
3840 }
3841
3842 static gboolean
3843 gtk_menu_scroll_timeout (gpointer data)
3844 {
3845   GtkMenu  *menu;
3846   gboolean  touchscreen_mode;
3847
3848   menu = GTK_MENU (data);
3849
3850   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3851                 "gtk-touchscreen-mode", &touchscreen_mode,
3852                 NULL);
3853
3854   gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3855
3856   return TRUE;
3857 }
3858
3859 static gboolean
3860 gtk_menu_scroll_timeout_initial (gpointer data)
3861 {
3862   GtkMenu  *menu;
3863   guint     timeout;
3864   gboolean  touchscreen_mode;
3865
3866   menu = GTK_MENU (data);
3867
3868   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3869                 "gtk-timeout-repeat", &timeout,
3870                 "gtk-touchscreen-mode", &touchscreen_mode,
3871                 NULL);
3872
3873   gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3874
3875   gtk_menu_remove_scroll_timeout (menu);
3876
3877   menu->priv->scroll_timeout =
3878     gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout, menu);
3879
3880   return FALSE;
3881 }
3882
3883 static void
3884 gtk_menu_start_scrolling (GtkMenu *menu)
3885 {
3886   guint    timeout;
3887   gboolean touchscreen_mode;
3888
3889   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
3890                 "gtk-timeout-repeat", &timeout,
3891                 "gtk-touchscreen-mode", &touchscreen_mode,
3892                 NULL);
3893
3894   gtk_menu_do_timeout_scroll (menu, touchscreen_mode);
3895
3896   menu->priv->scroll_timeout =
3897     gdk_threads_add_timeout (timeout, gtk_menu_scroll_timeout_initial, menu);
3898 }
3899
3900 static gboolean
3901 gtk_menu_scroll (GtkWidget      *widget,
3902                  GdkEventScroll *event)
3903 {
3904   GtkMenu *menu = GTK_MENU (widget);
3905
3906   switch (event->direction)
3907     {
3908     case GDK_SCROLL_RIGHT:
3909     case GDK_SCROLL_DOWN:
3910       gtk_menu_scroll_by (menu, MENU_SCROLL_STEP2);
3911       break;
3912     case GDK_SCROLL_LEFT:
3913     case GDK_SCROLL_UP:
3914       gtk_menu_scroll_by (menu, - MENU_SCROLL_STEP2);
3915       break;
3916     }
3917
3918   return TRUE;
3919 }
3920
3921 static void
3922 get_arrows_sensitive_area (GtkMenu      *menu,
3923                            GdkRectangle *upper,
3924                            GdkRectangle *lower)
3925 {
3926   GtkArrowPlacement arrow_placement;
3927   GtkWidget *widget = GTK_WIDGET (menu);
3928   GdkWindow *window;
3929   gint width, height;
3930   guint border;
3931   guint vertical_padding;
3932   gint win_x, win_y;
3933   gint scroll_arrow_height;
3934   GtkBorder padding;
3935
3936   window = gtk_widget_get_window (widget);
3937   width = gdk_window_get_width (window);
3938   height = gdk_window_get_height (window);
3939
3940   gtk_widget_style_get (widget,
3941                         "vertical-padding", &vertical_padding,
3942                         "scroll-arrow-vlength", &scroll_arrow_height,
3943                         "arrow-placement", &arrow_placement,
3944                         NULL);
3945
3946   border = gtk_container_get_border_width (GTK_CONTAINER (menu)) + vertical_padding;
3947   get_menu_padding (widget, &padding);
3948
3949   gdk_window_get_position (window, &win_x, &win_y);
3950
3951   switch (arrow_placement)
3952     {
3953     case GTK_ARROWS_BOTH:
3954       if (upper)
3955         {
3956           upper->x = win_x;
3957           upper->y = win_y;
3958           upper->width = width;
3959           upper->height = scroll_arrow_height + border + padding.top;
3960         }
3961
3962       if (lower)
3963         {
3964           lower->x = win_x;
3965           lower->y = win_y + height - border - padding.bottom - scroll_arrow_height;
3966           lower->width = width;
3967           lower->height = scroll_arrow_height + border + padding.bottom;
3968         }
3969       break;
3970
3971     case GTK_ARROWS_START:
3972       if (upper)
3973         {
3974           upper->x = win_x;
3975           upper->y = win_y;
3976           upper->width = width / 2;
3977           upper->height = scroll_arrow_height + border + padding.top;
3978         }
3979
3980       if (lower)
3981         {
3982           lower->x = win_x + width / 2;
3983           lower->y = win_y;
3984           lower->width = width / 2;
3985           lower->height = scroll_arrow_height + border + padding.bottom;
3986         }
3987       break;
3988
3989     case GTK_ARROWS_END:
3990       if (upper)
3991         {
3992           upper->x = win_x;
3993           upper->y = win_y + height - border - scroll_arrow_height;
3994           upper->width = width / 2;
3995           upper->height = scroll_arrow_height + border + padding.top;
3996         }
3997
3998       if (lower)
3999         {
4000           lower->x = win_x + width / 2;
4001           lower->y = win_y + height - border - scroll_arrow_height;
4002           lower->width = width / 2;
4003           lower->height = scroll_arrow_height + border + padding.bottom;
4004         }
4005       break;
4006     }
4007 }
4008
4009
4010 static void
4011 gtk_menu_handle_scrolling (GtkMenu *menu,
4012                            gint     x,
4013                            gint     y,
4014                            gboolean enter,
4015                            gboolean motion)
4016 {
4017   GtkMenuPrivate *priv = menu->priv;
4018   GtkMenuShell *menu_shell;
4019   GdkRectangle rect;
4020   gboolean in_arrow;
4021   gboolean scroll_fast = FALSE;
4022   gint top_x, top_y;
4023   gboolean touchscreen_mode;
4024
4025   menu_shell = GTK_MENU_SHELL (menu);
4026
4027   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4028                 "gtk-touchscreen-mode", &touchscreen_mode,
4029                 NULL);
4030
4031   gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
4032                            &top_x, &top_y);
4033   x -= top_x;
4034   y -= top_y;
4035
4036   /*  upper arrow handling  */
4037
4038   get_arrows_sensitive_area (menu, &rect, NULL);
4039
4040   in_arrow = FALSE;
4041   if (priv->upper_arrow_visible && !priv->tearoff_active &&
4042       (x >= rect.x) && (x < rect.x + rect.width) &&
4043       (y >= rect.y) && (y < rect.y + rect.height))
4044     {
4045       in_arrow = TRUE;
4046     }
4047
4048   if (touchscreen_mode)
4049     priv->upper_arrow_prelight = in_arrow;
4050
4051   if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4052     {
4053       gboolean arrow_pressed = FALSE;
4054
4055       if (priv->upper_arrow_visible && !priv->tearoff_active)
4056         {
4057           if (touchscreen_mode)
4058             {
4059               if (enter && priv->upper_arrow_prelight)
4060                 {
4061                   if (priv->scroll_timeout == 0)
4062                     {
4063                       /* Deselect the active item so that
4064                        * any submenus are popped down
4065                        */
4066                       gtk_menu_shell_deselect (menu_shell);
4067
4068                       gtk_menu_remove_scroll_timeout (menu);
4069                       priv->scroll_step = -MENU_SCROLL_STEP2; /* always fast */
4070
4071                       if (!motion)
4072                         {
4073                           /* Only do stuff on click. */
4074                           gtk_menu_start_scrolling (menu);
4075                           arrow_pressed = TRUE;
4076                         }
4077                     }
4078                   else
4079                     {
4080                       arrow_pressed = TRUE;
4081                     }
4082                 }
4083               else if (!enter)
4084                 {
4085                   gtk_menu_stop_scrolling (menu);
4086                 }
4087             }
4088           else /* !touchscreen_mode */
4089             {
4090               scroll_fast = (y < rect.y + MENU_SCROLL_FAST_ZONE);
4091
4092               if (enter && in_arrow &&
4093                   (!priv->upper_arrow_prelight ||
4094                    priv->scroll_fast != scroll_fast))
4095                 {
4096                   priv->upper_arrow_prelight = TRUE;
4097                   priv->scroll_fast = scroll_fast;
4098
4099                   /* Deselect the active item so that
4100                    * any submenus are popped down
4101                    */
4102                   gtk_menu_shell_deselect (menu_shell);
4103
4104                   gtk_menu_remove_scroll_timeout (menu);
4105                   priv->scroll_step = scroll_fast
4106                                         ? -MENU_SCROLL_STEP2
4107                                         : -MENU_SCROLL_STEP1;
4108
4109                   priv->scroll_timeout =
4110                     gdk_threads_add_timeout (scroll_fast
4111                                                ? MENU_SCROLL_TIMEOUT2
4112                                                : MENU_SCROLL_TIMEOUT1,
4113                                              gtk_menu_scroll_timeout, menu);
4114                 }
4115               else if (!enter && !in_arrow && priv->upper_arrow_prelight)
4116                 {
4117                   gtk_menu_stop_scrolling (menu);
4118                 }
4119             }
4120         }
4121
4122       /*  gtk_menu_start_scrolling() might have hit the top of the
4123        *  menu, so check if the button isn't insensitive before
4124        *  changing it to something else.
4125        */
4126       if ((priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4127         {
4128           GtkStateFlags arrow_state = 0;
4129
4130           if (arrow_pressed)
4131             arrow_state |= GTK_STATE_FLAG_ACTIVE;
4132
4133           if (priv->upper_arrow_prelight)
4134             arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4135
4136           if (arrow_state != priv->upper_arrow_state)
4137             {
4138               priv->upper_arrow_state = arrow_state;
4139
4140               gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4141                                           &rect, FALSE);
4142             }
4143         }
4144     }
4145
4146   /*  lower arrow handling  */
4147
4148   get_arrows_sensitive_area (menu, NULL, &rect);
4149
4150   in_arrow = FALSE;
4151   if (priv->lower_arrow_visible && !priv->tearoff_active &&
4152       (x >= rect.x) && (x < rect.x + rect.width) &&
4153       (y >= rect.y) && (y < rect.y + rect.height))
4154     {
4155       in_arrow = TRUE;
4156     }
4157
4158   if (touchscreen_mode)
4159     priv->lower_arrow_prelight = in_arrow;
4160
4161   if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4162     {
4163       gboolean arrow_pressed = FALSE;
4164
4165       if (priv->lower_arrow_visible && !priv->tearoff_active)
4166         {
4167           if (touchscreen_mode)
4168             {
4169               if (enter && priv->lower_arrow_prelight)
4170                 {
4171                   if (priv->scroll_timeout == 0)
4172                     {
4173                       /* Deselect the active item so that
4174                        * any submenus are popped down
4175                        */
4176                       gtk_menu_shell_deselect (menu_shell);
4177
4178                       gtk_menu_remove_scroll_timeout (menu);
4179                       priv->scroll_step = MENU_SCROLL_STEP2; /* always fast */
4180
4181                       if (!motion)
4182                         {
4183                           /* Only do stuff on click. */
4184                           gtk_menu_start_scrolling (menu);
4185                           arrow_pressed = TRUE;
4186                         }
4187                     }
4188                   else
4189                     {
4190                       arrow_pressed = TRUE;
4191                     }
4192                 }
4193               else if (!enter)
4194                 {
4195                   gtk_menu_stop_scrolling (menu);
4196                 }
4197             }
4198           else /* !touchscreen_mode */
4199             {
4200               scroll_fast = (y > rect.y + rect.height - MENU_SCROLL_FAST_ZONE);
4201
4202               if (enter && in_arrow &&
4203                   (!priv->lower_arrow_prelight ||
4204                    priv->scroll_fast != scroll_fast))
4205                 {
4206                   priv->lower_arrow_prelight = TRUE;
4207                   priv->scroll_fast = scroll_fast;
4208
4209                   /* Deselect the active item so that
4210                    * any submenus are popped down
4211                    */
4212                   gtk_menu_shell_deselect (menu_shell);
4213
4214                   gtk_menu_remove_scroll_timeout (menu);
4215                   priv->scroll_step = scroll_fast
4216                                         ? MENU_SCROLL_STEP2
4217                                         : MENU_SCROLL_STEP1;
4218
4219                   priv->scroll_timeout =
4220                     gdk_threads_add_timeout (scroll_fast
4221                                                ? MENU_SCROLL_TIMEOUT2
4222                                                : MENU_SCROLL_TIMEOUT1,
4223                                              gtk_menu_scroll_timeout, menu);
4224                 }
4225               else if (!enter && !in_arrow && priv->lower_arrow_prelight)
4226                 {
4227                   gtk_menu_stop_scrolling (menu);
4228                 }
4229             }
4230         }
4231
4232       /*  gtk_menu_start_scrolling() might have hit the bottom of the
4233        *  menu, so check if the button isn't insensitive before
4234        *  changing it to something else.
4235        */
4236       if ((priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) == 0)
4237         {
4238           GtkStateFlags arrow_state = 0;
4239
4240           if (arrow_pressed)
4241             arrow_state |= GTK_STATE_FLAG_ACTIVE;
4242
4243           if (priv->lower_arrow_prelight)
4244             arrow_state |= GTK_STATE_FLAG_PRELIGHT;
4245
4246           if (arrow_state != priv->lower_arrow_state)
4247             {
4248               priv->lower_arrow_state = arrow_state;
4249
4250               gdk_window_invalidate_rect (gtk_widget_get_window (GTK_WIDGET (menu)),
4251                                           &rect, FALSE);
4252             }
4253         }
4254     }
4255 }
4256
4257 static gboolean
4258 gtk_menu_enter_notify (GtkWidget        *widget,
4259                        GdkEventCrossing *event)
4260 {
4261   GtkWidget *menu_item;
4262   GtkWidget *parent;
4263   GdkDevice *source_device;
4264
4265   if (event->mode == GDK_CROSSING_GTK_GRAB ||
4266       event->mode == GDK_CROSSING_GTK_UNGRAB ||
4267       event->mode == GDK_CROSSING_STATE_CHANGED)
4268     return TRUE;
4269
4270   source_device = gdk_event_get_source_device ((GdkEvent *) event);
4271   menu_item = gtk_get_event_widget ((GdkEvent*) event);
4272
4273   if (GTK_IS_MENU (widget) &&
4274       gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
4275     {
4276       GtkMenuShell *menu_shell = GTK_MENU_SHELL (widget);
4277
4278       if (!menu_shell->priv->ignore_enter)
4279         gtk_menu_handle_scrolling (GTK_MENU (widget),
4280                                    event->x_root, event->y_root, TRUE, TRUE);
4281     }
4282
4283   if (gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN &&
4284       GTK_IS_MENU_ITEM (menu_item))
4285     {
4286       GtkWidget *menu = gtk_widget_get_parent (menu_item);
4287
4288       if (GTK_IS_MENU (menu))
4289         {
4290           GtkMenuPrivate *priv = (GTK_MENU (menu))->priv;
4291           GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
4292
4293           if (priv->seen_item_enter)
4294             {
4295               /* This is the second enter we see for an item
4296                * on this menu. This means a release should always
4297                * mean activate.
4298                */
4299               menu_shell->priv->activate_time = 0;
4300             }
4301           else if ((event->detail != GDK_NOTIFY_NONLINEAR &&
4302                     event->detail != GDK_NOTIFY_NONLINEAR_VIRTUAL))
4303             {
4304               if (definitely_within_item (menu_item, event->x, event->y))
4305                 {
4306                   /* This is an actual user-enter (ie. not a pop-under)
4307                    * In this case, the user must either have entered
4308                    * sufficiently far enough into the item, or he must move
4309                    * far enough away from the enter point. (see
4310                    * gtk_menu_motion_notify())
4311                    */
4312                   menu_shell->priv->activate_time = 0;
4313                 }
4314             }
4315
4316           priv->seen_item_enter = TRUE;
4317         }
4318     }
4319
4320   /* If this is a faked enter (see gtk_menu_motion_notify), 'widget'
4321    * will not correspond to the event widget's parent.  Check to see
4322    * if we are in the parent's navigation region.
4323    */
4324   parent = gtk_widget_get_parent (menu_item);
4325   if (GTK_IS_MENU_ITEM (menu_item) && GTK_IS_MENU (parent) &&
4326       gtk_menu_navigating_submenu (GTK_MENU (parent),
4327                                    event->x_root, event->y_root))
4328     return TRUE;
4329
4330   return GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (widget, event);
4331 }
4332
4333 static gboolean
4334 gtk_menu_leave_notify (GtkWidget        *widget,
4335                        GdkEventCrossing *event)
4336 {
4337   GtkMenuShell *menu_shell;
4338   GtkMenu *menu;
4339   GtkMenuItem *menu_item;
4340   GtkWidget *event_widget;
4341   GdkDevice *source_device;
4342
4343   if (event->mode == GDK_CROSSING_GTK_GRAB ||
4344       event->mode == GDK_CROSSING_GTK_UNGRAB ||
4345       event->mode == GDK_CROSSING_STATE_CHANGED)
4346     return TRUE;
4347
4348   menu = GTK_MENU (widget);
4349   menu_shell = GTK_MENU_SHELL (widget);
4350
4351   if (gtk_menu_navigating_submenu (menu, event->x_root, event->y_root))
4352     return TRUE;
4353
4354   source_device = gdk_event_get_source_device ((GdkEvent *) event);
4355
4356   if (gdk_device_get_source (source_device) != GDK_SOURCE_TOUCHSCREEN)
4357     gtk_menu_handle_scrolling (menu, event->x_root, event->y_root, FALSE, TRUE);
4358
4359   event_widget = gtk_get_event_widget ((GdkEvent*) event);
4360
4361   if (!GTK_IS_MENU_ITEM (event_widget))
4362     return TRUE;
4363
4364   menu_item = GTK_MENU_ITEM (event_widget);
4365
4366   /* Here we check to see if we're leaving an active menu item
4367    * with a submenu, in which case we enter submenu navigation mode.
4368    */
4369   if (menu_shell->priv->active_menu_item != NULL
4370       && menu_item->priv->submenu != NULL
4371       && menu_item->priv->submenu_placement == GTK_LEFT_RIGHT)
4372     {
4373       if (GTK_MENU_SHELL (menu_item->priv->submenu)->priv->active)
4374         {
4375           gtk_menu_set_submenu_navigation_region (menu, menu_item, event);
4376           return TRUE;
4377         }
4378       else if (menu_item == GTK_MENU_ITEM (menu_shell->priv->active_menu_item))
4379         {
4380           /* We are leaving an active menu item with nonactive submenu.
4381            * Deselect it so we don't surprise the user with by popping
4382            * up a submenu _after_ he left the item.
4383            */
4384           gtk_menu_shell_deselect (menu_shell);
4385           return TRUE;
4386         }
4387     }
4388
4389   return GTK_WIDGET_CLASS (gtk_menu_parent_class)->leave_notify_event (widget, event);
4390 }
4391
4392 static gboolean
4393 pointer_on_menu_widget (GtkMenu *menu,
4394                         gdouble  x_root,
4395                         gdouble  y_root)
4396 {
4397   GtkMenuPrivate *priv = menu->priv;
4398   GtkAllocation allocation;
4399   gint window_x, window_y;
4400
4401   gtk_widget_get_allocation (GTK_WIDGET (menu), &allocation);
4402   gdk_window_get_position (gtk_widget_get_window (priv->toplevel),
4403                            &window_x, &window_y);
4404
4405   if (x_root >= window_x && x_root < window_x + allocation.width &&
4406       y_root >= window_y && y_root < window_y + allocation.height)
4407     return TRUE;
4408
4409   return FALSE;
4410 }
4411
4412 static gboolean
4413 gtk_menu_captured_event (GtkWidget *widget,
4414                          GdkEvent  *event)
4415 {
4416   GdkDevice *source_device;
4417   gboolean retval = FALSE;
4418   GtkMenuPrivate *priv;
4419   GtkMenu *menu;
4420   gdouble x_root, y_root;
4421   guint button;
4422   GdkModifierType state;
4423
4424   menu = GTK_MENU (widget);
4425   priv = menu->priv;
4426
4427   if (!priv->upper_arrow_visible && !priv->lower_arrow_visible)
4428     return retval;
4429
4430   source_device = gdk_event_get_source_device (event);
4431   gdk_event_get_root_coords (event, &x_root, &y_root);
4432
4433   switch (event->type)
4434     {
4435     case GDK_TOUCH_BEGIN:
4436     case GDK_BUTTON_PRESS:
4437       if ((!gdk_event_get_button (event, &button) || button == 1) &&
4438           gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN &&
4439           pointer_on_menu_widget (menu, x_root, y_root))
4440         {
4441           priv->drag_start_y = event->button.y_root;
4442           priv->initial_drag_offset = priv->scroll_offset;
4443           priv->drag_scroll_started = FALSE;
4444         }
4445       else
4446         priv->drag_start_y = -1;
4447
4448       priv->drag_already_pressed = TRUE;
4449       break;
4450     case GDK_TOUCH_END:
4451     case GDK_BUTTON_RELEASE:
4452       if (priv->drag_scroll_started)
4453         {
4454           priv->drag_scroll_started = FALSE;
4455           priv->drag_start_y = -1;
4456           priv->drag_already_pressed = FALSE;
4457           retval = TRUE;
4458         }
4459       break;
4460     case GDK_TOUCH_UPDATE:
4461     case GDK_MOTION_NOTIFY:
4462       if ((!gdk_event_get_state (event, &state) || (state & GDK_BUTTON1_MASK)
4463 != 0) &&
4464           gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
4465         {
4466           if (!priv->drag_already_pressed)
4467             {
4468               if (pointer_on_menu_widget (menu, x_root, y_root))
4469                 {
4470                   priv->drag_start_y = y_root;
4471                   priv->initial_drag_offset = priv->scroll_offset;
4472                   priv->drag_scroll_started = FALSE;
4473                 }
4474               else
4475                 priv->drag_start_y = -1;
4476
4477               priv->drag_already_pressed = TRUE;
4478             }
4479
4480           if (priv->drag_start_y < 0 && !priv->drag_scroll_started)
4481             break;
4482
4483           if (priv->drag_scroll_started)
4484             {
4485               gint offset, view_height;
4486               GtkBorder arrow_border;
4487               gdouble y_diff;
4488
4489               y_diff = y_root - priv->drag_start_y;
4490               offset = priv->initial_drag_offset - y_diff;
4491
4492               view_height = gdk_window_get_height (gtk_widget_get_window (widget));
4493               get_arrows_border (menu, &arrow_border);
4494
4495               if (priv->upper_arrow_visible)
4496                 view_height -= arrow_border.top;
4497
4498               if (priv->lower_arrow_visible)
4499                 view_height -= arrow_border.bottom;
4500
4501               offset = CLAMP (offset, 0, priv->requested_height - view_height);
4502               gtk_menu_scroll_to (menu, offset);
4503
4504               retval = TRUE;
4505             }
4506           else if (gtk_drag_check_threshold (widget,
4507                                              0, priv->drag_start_y,
4508                                              0, y_root))
4509             {
4510               priv->drag_scroll_started = TRUE;
4511               gtk_menu_shell_deselect (GTK_MENU_SHELL (menu));
4512               retval = TRUE;
4513             }
4514         }
4515       break;
4516     case GDK_ENTER_NOTIFY:
4517     case GDK_LEAVE_NOTIFY:
4518       if (priv->drag_scroll_started)
4519         retval = TRUE;
4520       break;
4521     default:
4522       break;
4523     }
4524
4525   return retval;
4526 }
4527
4528 static void
4529 gtk_menu_stop_navigating_submenu (GtkMenu *menu)
4530 {
4531   GtkMenuPrivate *priv = menu->priv;
4532
4533   priv->navigation_x = 0;
4534   priv->navigation_y = 0;
4535   priv->navigation_width = 0;
4536   priv->navigation_height = 0;
4537
4538   if (priv->navigation_timeout)
4539     {
4540       g_source_remove (priv->navigation_timeout);
4541       priv->navigation_timeout = 0;
4542     }
4543 }
4544
4545 /* When the timeout is elapsed, the navigation region is destroyed
4546  * and the menuitem under the pointer (if any) is selected.
4547  */
4548 static gboolean
4549 gtk_menu_stop_navigating_submenu_cb (gpointer user_data)
4550 {
4551   GtkMenuPopdownData *popdown_data = user_data;
4552   GtkMenu *menu = popdown_data->menu;
4553   GtkMenuPrivate *priv = menu->priv;
4554   GdkWindow *child_window;
4555
4556   gtk_menu_stop_navigating_submenu (menu);
4557
4558   if (gtk_widget_get_realized (GTK_WIDGET (menu)))
4559     {
4560       child_window = gdk_window_get_device_position (priv->bin_window,
4561                                                      popdown_data->device,
4562                                                      NULL, NULL, NULL);
4563
4564       if (child_window)
4565         {
4566           GdkEvent *send_event = gdk_event_new (GDK_ENTER_NOTIFY);
4567
4568           send_event->crossing.window = g_object_ref (child_window);
4569           send_event->crossing.time = GDK_CURRENT_TIME; /* Bogus */
4570           send_event->crossing.send_event = TRUE;
4571           gdk_event_set_device (send_event, popdown_data->device);
4572
4573           GTK_WIDGET_CLASS (gtk_menu_parent_class)->enter_notify_event (GTK_WIDGET (menu), (GdkEventCrossing *)send_event);
4574
4575           gdk_event_free (send_event);
4576         }
4577     }
4578
4579   return FALSE;
4580 }
4581
4582 static gboolean
4583 gtk_menu_navigating_submenu (GtkMenu *menu,
4584                              gint     event_x,
4585                              gint     event_y)
4586 {
4587   GtkMenuPrivate *priv = menu->priv;
4588   gint width, height;
4589
4590   if (!gtk_menu_has_navigation_triangle (menu))
4591     return FALSE;
4592
4593   width = priv->navigation_width;
4594   height = priv->navigation_height;
4595
4596   /* Check if x/y are in the triangle spanned by the navigation parameters */
4597
4598   /* 1) Move the coordinates so the triangle starts at 0,0 */
4599   event_x -= priv->navigation_x;
4600   event_y -= priv->navigation_y;
4601
4602   /* 2) Ensure both legs move along the positive axis */
4603   if (width < 0)
4604     {
4605       event_x = -event_x;
4606       width = -width;
4607     }
4608   if (height < 0)
4609     {
4610       event_y = -event_y;
4611       height = -height;
4612     }
4613
4614   /* 3) Check that the given coordinate is inside the triangle. The formula
4615    * is a transformed form of this formula: x/w + y/h <= 1
4616    */
4617   if (event_x >= 0 && event_y >= 0 &&
4618       event_x * height + event_y * width <= width * height)
4619     {
4620       return TRUE;
4621     }
4622   else
4623     {
4624       gtk_menu_stop_navigating_submenu (menu);
4625       return FALSE;
4626     }
4627 }
4628
4629 static void
4630 gtk_menu_set_submenu_navigation_region (GtkMenu          *menu,
4631                                         GtkMenuItem      *menu_item,
4632                                         GdkEventCrossing *event)
4633 {
4634   GtkMenuPrivate *priv = menu->priv;
4635   gint submenu_left = 0;
4636   gint submenu_right = 0;
4637   gint submenu_top = 0;
4638   gint submenu_bottom = 0;
4639   gint width = 0;
4640   GtkWidget *event_widget;
4641   GtkMenuPopdownData *popdown_data;
4642   GdkWindow *window;
4643
4644   g_return_if_fail (menu_item->priv->submenu != NULL);
4645   g_return_if_fail (event != NULL);
4646
4647   event_widget = gtk_get_event_widget ((GdkEvent*) event);
4648
4649   window = gtk_widget_get_window (menu_item->priv->submenu);
4650   gdk_window_get_origin (window, &submenu_left, &submenu_top);
4651
4652   submenu_right = submenu_left + gdk_window_get_width (window);
4653   submenu_bottom = submenu_top + gdk_window_get_height (window);
4654
4655   width = gdk_window_get_width (gtk_widget_get_window (event_widget));
4656
4657   if (event->x >= 0 && event->x < width)
4658     {
4659       gint popdown_delay;
4660
4661       gtk_menu_stop_navigating_submenu (menu);
4662
4663       /* The navigation region is the triangle closest to the x/y
4664        * location of the rectangle. This is why the width or height
4665        * can be negative.
4666        */
4667       if (menu_item->priv->submenu_direction == GTK_DIRECTION_RIGHT)
4668         {
4669           /* right */
4670           priv->navigation_x = submenu_left;
4671           priv->navigation_width = event->x_root - submenu_left;
4672         }
4673       else
4674         {
4675           /* left */
4676           priv->navigation_x = submenu_right;
4677           priv->navigation_width = event->x_root - submenu_right;
4678         }
4679
4680       if (event->y < 0)
4681         {
4682           /* top */
4683           priv->navigation_y = event->y_root;
4684           priv->navigation_height = submenu_top - event->y_root - NAVIGATION_REGION_OVERSHOOT;
4685
4686           if (priv->navigation_height >= 0)
4687             return;
4688         }
4689       else
4690         {
4691           /* bottom */
4692           priv->navigation_y = event->y_root;
4693           priv->navigation_height = submenu_bottom - event->y_root + NAVIGATION_REGION_OVERSHOOT;
4694
4695           if (priv->navigation_height <= 0)
4696             return;
4697         }
4698
4699       g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4700                     "gtk-menu-popdown-delay", &popdown_delay,
4701                     NULL);
4702
4703       popdown_data = g_new (GtkMenuPopdownData, 1);
4704       popdown_data->menu = menu;
4705       popdown_data->device = gdk_event_get_device ((GdkEvent *) event);
4706
4707       priv->navigation_timeout = gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
4708                                                                popdown_delay,
4709                                                                gtk_menu_stop_navigating_submenu_cb,
4710                                                                popdown_data,
4711                                                                (GDestroyNotify) g_free);
4712     }
4713 }
4714
4715 static void
4716 gtk_menu_deactivate (GtkMenuShell *menu_shell)
4717 {
4718   GtkWidget *parent;
4719
4720   g_return_if_fail (GTK_IS_MENU (menu_shell));
4721
4722   parent = menu_shell->priv->parent_menu_shell;
4723
4724   menu_shell->priv->activate_time = 0;
4725   gtk_menu_popdown (GTK_MENU (menu_shell));
4726
4727   if (parent)
4728     gtk_menu_shell_deactivate (GTK_MENU_SHELL (parent));
4729 }
4730
4731 static void
4732 gtk_menu_position (GtkMenu  *menu,
4733                    gboolean  set_scroll_offset)
4734 {
4735   GtkMenuPrivate *priv = menu->priv;
4736   GtkWidget *widget;
4737   GtkRequisition requisition;
4738   gint x, y;
4739   gint scroll_offset;
4740   GdkScreen *screen;
4741   GdkScreen *pointer_screen;
4742   GdkRectangle monitor;
4743   GdkDevice *pointer;
4744
4745   widget = GTK_WIDGET (menu);
4746
4747   screen = gtk_widget_get_screen (widget);
4748   pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (menu));
4749   gdk_device_get_position (pointer, &pointer_screen, &x, &y);
4750
4751   /* Realize so we have the proper width and heigh to figure out
4752    * the right place to popup the menu.
4753    */
4754   gtk_widget_realize (priv->toplevel);
4755   requisition.width = gtk_widget_get_allocated_width (widget);
4756   requisition.height = gtk_widget_get_allocated_height (widget);
4757
4758   if (pointer_screen != screen)
4759     {
4760       /* Pointer is on a different screen; roughly center the
4761        * menu on the screen. If someone was using multiscreen
4762        * + Xinerama together they'd probably want something
4763        * fancier; but that is likely to be vanishingly rare.
4764        */
4765       x = MAX (0, (gdk_screen_get_width (screen) - requisition.width) / 2);
4766       y = MAX (0, (gdk_screen_get_height (screen) - requisition.height) / 2);
4767     }
4768
4769   priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4770   priv->initially_pushed_in = FALSE;
4771
4772   /* Set the type hint here to allow custom position functions
4773    * to set a different hint
4774    */
4775   if (!gtk_widget_get_visible (priv->toplevel))
4776     gtk_window_set_type_hint (GTK_WINDOW (priv->toplevel), GDK_WINDOW_TYPE_HINT_POPUP_MENU);
4777
4778   if (priv->position_func)
4779     {
4780       (* priv->position_func) (menu, &x, &y, &priv->initially_pushed_in,
4781                                priv->position_func_data);
4782
4783       if (priv->monitor_num < 0)
4784         priv->monitor_num = gdk_screen_get_monitor_at_point (screen, x, y);
4785
4786       gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
4787     }
4788   else
4789     {
4790       gint space_left, space_right, space_above, space_below;
4791       gint needed_width;
4792       gint needed_height;
4793       GtkBorder padding;
4794       gboolean rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
4795
4796       get_menu_padding (widget, &padding);
4797
4798       /* The placement of popup menus horizontally works like this (with
4799        * RTL in parentheses)
4800        *
4801        * - If there is enough room to the right (left) of the mouse cursor,
4802        *   position the menu there.
4803        *
4804        * - Otherwise, if if there is enough room to the left (right) of the
4805        *   mouse cursor, position the menu there.
4806        *
4807        * - Otherwise if the menu is smaller than the monitor, position it
4808        *   on the side of the mouse cursor that has the most space available
4809        *
4810        * - Otherwise (if there is simply not enough room for the menu on the
4811        *   monitor), position it as far left (right) as possible.
4812        *
4813        * Positioning in the vertical direction is similar: first try below
4814        * mouse cursor, then above.
4815        */
4816       gdk_screen_get_monitor_workarea (screen, priv->monitor_num, &monitor);
4817
4818       space_left = x - monitor.x;
4819       space_right = monitor.x + monitor.width - x - 1;
4820       space_above = y - monitor.y;
4821       space_below = monitor.y + monitor.height - y - 1;
4822
4823       /* Position horizontally. */
4824
4825       /* the amount of space we need to position the menu.
4826        * Note the menu is offset "thickness" pixels
4827        */
4828       needed_width = requisition.width - padding.left;
4829
4830       if (needed_width <= space_left ||
4831           needed_width <= space_right)
4832         {
4833           if ((rtl  && needed_width <= space_left) ||
4834               (!rtl && needed_width >  space_right))
4835             {
4836               /* position left */
4837               x = x + padding.left - requisition.width + 1;
4838             }
4839           else
4840             {
4841               /* position right */
4842               x = x - padding.right;
4843             }
4844
4845           /* x is clamped on-screen further down */
4846         }
4847       else if (requisition.width <= monitor.width)
4848         {
4849           /* the menu is too big to fit on either side of the mouse
4850            * cursor, but smaller than the monitor. Position it on
4851            * the side that has the most space
4852            */
4853           if (space_left > space_right)
4854             {
4855               /* left justify */
4856               x = monitor.x;
4857             }
4858           else
4859             {
4860               /* right justify */
4861               x = monitor.x + monitor.width - requisition.width;
4862             }
4863         }
4864       else /* menu is simply too big for the monitor */
4865         {
4866           if (rtl)
4867             {
4868               /* right justify */
4869               x = monitor.x + monitor.width - requisition.width;
4870             }
4871           else
4872             {
4873               /* left justify */
4874               x = monitor.x;
4875             }
4876         }
4877
4878       /* Position vertically.
4879        * The algorithm is the same as above, but simpler
4880        * because we don't have to take RTL into account.
4881        */
4882       needed_height = requisition.height - padding.top;
4883
4884       if (needed_height <= space_above ||
4885           needed_height <= space_below)
4886         {
4887           if (needed_height <= space_below)
4888             y = y - padding.top;
4889           else
4890             y = y + padding.bottom - requisition.height + 1;
4891
4892           y = CLAMP (y, monitor.y,
4893                      monitor.y + monitor.height - requisition.height);
4894         }
4895       else if (needed_height > space_below && needed_height > space_above)
4896         {
4897           if (space_below >= space_above)
4898             y = monitor.y + monitor.height - requisition.height;
4899           else
4900             y = monitor.y;
4901         }
4902       else
4903         {
4904           y = monitor.y;
4905         }
4906     }
4907
4908   scroll_offset = 0;
4909
4910   if (y + requisition.height > monitor.y + monitor.height)
4911     {
4912       if (priv->initially_pushed_in)
4913         scroll_offset += (monitor.y + monitor.height) - requisition.height - y;
4914       y = (monitor.y + monitor.height) - requisition.height;
4915     }
4916
4917   if (y < monitor.y)
4918     {
4919       if (priv->initially_pushed_in)
4920         scroll_offset += monitor.y - y;
4921       y = monitor.y;
4922     }
4923
4924   x = CLAMP (x, monitor.x, MAX (monitor.x, monitor.x + monitor.width - requisition.width));
4925
4926   if (GTK_MENU_SHELL (menu)->priv->active)
4927     {
4928       priv->have_position = TRUE;
4929       priv->position_x = x;
4930       priv->position_y = y;
4931     }
4932
4933   if (scroll_offset != 0)
4934     {
4935       GtkBorder arrow_border;
4936
4937       get_arrows_border (menu, &arrow_border);
4938       scroll_offset += arrow_border.top;
4939     }
4940
4941   gtk_window_move (GTK_WINDOW (GTK_MENU_SHELL (menu)->priv->active ? priv->toplevel : priv->tearoff_window),
4942                    x, y);
4943
4944   if (!GTK_MENU_SHELL (menu)->priv->active)
4945     {
4946       gtk_window_resize (GTK_WINDOW (priv->tearoff_window),
4947                          requisition.width, requisition.height);
4948     }
4949
4950   if (set_scroll_offset)
4951     priv->scroll_offset = scroll_offset;
4952 }
4953
4954 static void
4955 gtk_menu_remove_scroll_timeout (GtkMenu *menu)
4956 {
4957   GtkMenuPrivate *priv = menu->priv;
4958
4959   if (priv->scroll_timeout)
4960     {
4961       g_source_remove (priv->scroll_timeout);
4962       priv->scroll_timeout = 0;
4963     }
4964 }
4965
4966 static void
4967 gtk_menu_stop_scrolling (GtkMenu *menu)
4968 {
4969   GtkMenuPrivate *priv = menu->priv;
4970   gboolean touchscreen_mode;
4971
4972   gtk_menu_remove_scroll_timeout (menu);
4973
4974   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu)),
4975                 "gtk-touchscreen-mode", &touchscreen_mode,
4976                 NULL);
4977
4978   if (!touchscreen_mode)
4979     {
4980       priv->upper_arrow_prelight = FALSE;
4981       priv->lower_arrow_prelight = FALSE;
4982     }
4983 }
4984
4985 static void
4986 gtk_menu_scroll_to (GtkMenu *menu,
4987                     gint    offset)
4988 {
4989   GtkMenuPrivate *priv = menu->priv;
4990   GtkBorder arrow_border, padding;
4991   GtkWidget *widget;
4992   gint x, y;
4993   gint view_width, view_height;
4994   gint border_width;
4995   gint menu_height;
4996   guint vertical_padding;
4997   guint horizontal_padding;
4998   gboolean double_arrows;
4999
5000   widget = GTK_WIDGET (menu);
5001
5002   if (priv->tearoff_active && priv->tearoff_adjustment)
5003     gtk_adjustment_set_value (priv->tearoff_adjustment, offset);
5004
5005   /* Move/resize the viewport according to arrows: */
5006   view_width = gtk_widget_get_allocated_width (widget);
5007   view_height = gtk_widget_get_allocated_height (widget);
5008
5009   gtk_widget_style_get (GTK_WIDGET (menu),
5010                         "vertical-padding", &vertical_padding,
5011                         "horizontal-padding", &horizontal_padding,
5012                         NULL);
5013
5014   get_menu_padding (widget, &padding);
5015   double_arrows = get_double_arrows (menu);
5016
5017   border_width = gtk_container_get_border_width (GTK_CONTAINER (menu));
5018
5019   view_width -= (2 * (border_width + horizontal_padding)) + padding.left + padding.right;
5020   view_height -= (2 * (border_width + vertical_padding)) + padding.top + padding.bottom;
5021   menu_height = priv->requested_height - (2 * (border_width + vertical_padding)) -
5022     padding.top - padding.bottom;
5023
5024   x = border_width + padding.left + horizontal_padding;
5025   y = border_width + padding.top + vertical_padding;
5026
5027   if (double_arrows && !priv->tearoff_active)
5028     {
5029       if (view_height < menu_height               ||
5030           (offset > 0 && priv->scroll_offset > 0) ||
5031           (offset < 0 && priv->scroll_offset < 0))
5032         {
5033           GtkStateFlags upper_arrow_previous_state = priv->upper_arrow_state;
5034           GtkStateFlags lower_arrow_previous_state = priv->lower_arrow_state;
5035
5036           if (!priv->upper_arrow_visible || !priv->lower_arrow_visible)
5037             gtk_widget_queue_draw (GTK_WIDGET (menu));
5038
5039           priv->upper_arrow_visible = priv->lower_arrow_visible = TRUE;
5040
5041           get_arrows_border (menu, &arrow_border);
5042           y += arrow_border.top;
5043           view_height -= arrow_border.top;
5044           view_height -= arrow_border.bottom;
5045
5046           if (offset <= 0)
5047             priv->upper_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
5048           else
5049             {
5050               priv->upper_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
5051
5052               if (priv->upper_arrow_prelight)
5053                 priv->upper_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
5054               else
5055                 priv->upper_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
5056             }
5057
5058           if (offset >= menu_height - view_height)
5059             priv->lower_arrow_state |= GTK_STATE_FLAG_INSENSITIVE;
5060           else
5061             {
5062               priv->lower_arrow_state &= ~(GTK_STATE_FLAG_INSENSITIVE);
5063
5064               if (priv->lower_arrow_prelight)
5065                 priv->lower_arrow_state |= GTK_STATE_FLAG_PRELIGHT;
5066               else
5067                 priv->lower_arrow_state &= ~(GTK_STATE_FLAG_PRELIGHT);
5068             }
5069
5070           if ((priv->upper_arrow_state != upper_arrow_previous_state) ||
5071               (priv->lower_arrow_state != lower_arrow_previous_state))
5072             gtk_widget_queue_draw (GTK_WIDGET (menu));
5073
5074           if ((upper_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
5075               (priv->upper_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
5076             {
5077               /* At the upper border, possibly remove timeout */
5078               if (priv->scroll_step < 0)
5079                 {
5080                   gtk_menu_stop_scrolling (menu);
5081                   gtk_widget_queue_draw (GTK_WIDGET (menu));
5082                 }
5083             }
5084
5085           if ((lower_arrow_previous_state & GTK_STATE_FLAG_INSENSITIVE) == 0 &&
5086               (priv->lower_arrow_state & GTK_STATE_FLAG_INSENSITIVE) != 0)
5087             {
5088               /* At the lower border, possibly remove timeout */
5089               if (priv->scroll_step > 0)
5090                 {
5091                   gtk_menu_stop_scrolling (menu);
5092                   gtk_widget_queue_draw (GTK_WIDGET (menu));
5093                 }
5094             }
5095         }
5096       else if (priv->upper_arrow_visible || priv->lower_arrow_visible)
5097         {
5098           offset = 0;
5099
5100           priv->upper_arrow_visible = priv->lower_arrow_visible = FALSE;
5101           priv->upper_arrow_prelight = priv->lower_arrow_prelight = FALSE;
5102
5103           gtk_menu_stop_scrolling (menu);
5104           gtk_widget_queue_draw (GTK_WIDGET (menu));
5105         }
5106     }
5107   else if (!priv->tearoff_active)
5108     {
5109       gboolean last_visible;
5110
5111       last_visible = priv->upper_arrow_visible;
5112       priv->upper_arrow_visible = offset > 0;
5113
5114       /* upper_arrow_visible may have changed, so requery the border */
5115       get_arrows_border (menu, &arrow_border);
5116       view_height -= arrow_border.top;
5117
5118       if ((last_visible != priv->upper_arrow_visible) &&
5119           !priv->upper_arrow_visible)
5120         {
5121           priv->upper_arrow_prelight = FALSE;
5122
5123           /* If we hide the upper arrow, possibly remove timeout */
5124           if (priv->scroll_step < 0)
5125             {
5126               gtk_menu_stop_scrolling (menu);
5127               gtk_widget_queue_draw (GTK_WIDGET (menu));
5128             }
5129         }
5130
5131       last_visible = priv->lower_arrow_visible;
5132       priv->lower_arrow_visible = offset < menu_height - view_height;
5133
5134       /* lower_arrow_visible may have changed, so requery the border */
5135       get_arrows_border (menu, &arrow_border);
5136       view_height -= arrow_border.bottom;
5137
5138       if ((last_visible != priv->lower_arrow_visible) &&
5139            !priv->lower_arrow_visible)
5140         {
5141           priv->lower_arrow_prelight = FALSE;
5142
5143           /* If we hide the lower arrow, possibly remove timeout */
5144           if (priv->scroll_step > 0)
5145             {
5146               gtk_menu_stop_scrolling (menu);
5147               gtk_widget_queue_draw (GTK_WIDGET (menu));
5148             }
5149         }
5150
5151       y += arrow_border.top;
5152     }
5153
5154   /* Scroll the menu: */
5155   if (gtk_widget_get_realized (widget))
5156     gdk_window_move (priv->bin_window, 0, -offset);
5157
5158   if (gtk_widget_get_realized (widget))
5159     gdk_window_move_resize (priv->view_window, x, y, view_width, view_height);
5160
5161   priv->scroll_offset = offset;
5162 }
5163
5164 static gboolean
5165 compute_child_offset (GtkMenu   *menu,
5166                       GtkWidget *menu_item,
5167                       gint      *offset,
5168                       gint      *height,
5169                       gboolean  *is_last_child)
5170 {
5171   GtkMenuPrivate *priv = menu->priv;
5172   gint item_top_attach;
5173   gint item_bottom_attach;
5174   gint child_offset = 0;
5175   gint i;
5176
5177   get_effective_child_attach (menu_item, NULL, NULL,
5178                               &item_top_attach, &item_bottom_attach);
5179
5180   /* there is a possibility that we get called before _size_request,
5181    * so check the height table for safety.
5182    */
5183   if (!priv->heights || priv->heights_length < gtk_menu_get_n_rows (menu))
5184     return FALSE;
5185
5186   /* when we have a row with only invisible children, its height will
5187    * be zero, so there's no need to check WIDGET_VISIBLE here
5188    */
5189   for (i = 0; i < item_top_attach; i++)
5190     child_offset += priv->heights[i];
5191
5192   if (is_last_child)
5193     *is_last_child = (item_bottom_attach == gtk_menu_get_n_rows (menu));
5194   if (offset)
5195     *offset = child_offset;
5196   if (height)
5197     *height = priv->heights[item_top_attach];
5198
5199   return TRUE;
5200 }
5201
5202 static void
5203 gtk_menu_scroll_item_visible (GtkMenuShell *menu_shell,
5204                               GtkWidget    *menu_item)
5205 {
5206   GtkMenu *menu = GTK_MENU (menu_shell);
5207   GtkMenuPrivate *priv = menu->priv;
5208   GtkWidget *widget = GTK_WIDGET (menu_shell);
5209   gint child_offset, child_height;
5210   gint height;
5211   gint y;
5212   gint arrow_height;
5213   gboolean last_child = 0;
5214
5215   /* We need to check if the selected item fully visible.
5216    * If not we need to scroll the menu so that it becomes fully
5217    * visible.
5218    */
5219   if (compute_child_offset (menu, menu_item,
5220                             &child_offset, &child_height, &last_child))
5221     {
5222       guint vertical_padding;
5223       gboolean double_arrows;
5224       GtkBorder padding;
5225
5226       y = priv->scroll_offset;
5227       height = gdk_window_get_height (gtk_widget_get_window (widget));
5228
5229       gtk_widget_style_get (widget,
5230                             "vertical-padding", &vertical_padding,
5231                             NULL);
5232
5233       double_arrows = get_double_arrows (menu);
5234       get_menu_padding (widget, &padding);
5235
5236       height -= 2 * gtk_container_get_border_width (GTK_CONTAINER (menu)) +
5237                 padding.top + padding.bottom +
5238                 2 * vertical_padding;
5239       if (child_offset < y)
5240         {
5241           /* Ignore the enter event we might get if the pointer
5242            * is on the menu
5243            */
5244           menu_shell->priv->ignore_enter = TRUE;
5245           gtk_menu_scroll_to (menu, child_offset);
5246         }
5247       else
5248         {
5249           GtkBorder arrow_border;
5250
5251           arrow_height = 0;
5252
5253           get_arrows_border (menu, &arrow_border);
5254           if (!priv->tearoff_active)
5255             arrow_height = arrow_border.top + arrow_border.bottom;
5256
5257           if (child_offset + child_height > y + height - arrow_height)
5258             {
5259               arrow_height = 0;
5260               if ((!last_child && !priv->tearoff_active) || double_arrows)
5261                 arrow_height += arrow_border.bottom;
5262
5263               y = child_offset + child_height - height + arrow_height;
5264               if (((y > 0) && !priv->tearoff_active) || double_arrows)
5265                 {
5266                   /* Need upper arrow */
5267                   arrow_height += arrow_border.top;
5268                   y = child_offset + child_height - height + arrow_height;
5269                 }
5270               /* Ignore the enter event we might get if the pointer
5271                * is on the menu
5272                */
5273               menu_shell->priv->ignore_enter = TRUE;
5274               gtk_menu_scroll_to (menu, y);
5275             }
5276         }
5277     }
5278 }
5279
5280 static void
5281 gtk_menu_select_item (GtkMenuShell *menu_shell,
5282                       GtkWidget    *menu_item)
5283 {
5284   GtkMenu *menu = GTK_MENU (menu_shell);
5285
5286   if (gtk_widget_get_realized (GTK_WIDGET (menu)))
5287     gtk_menu_scroll_item_visible (menu_shell, menu_item);
5288
5289   GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->select_item (menu_shell, menu_item);
5290 }
5291
5292
5293 /* Reparent the menu, taking care of the refcounting
5294  *
5295  * If unrealize is true we force a unrealize while reparenting the parent.
5296  * This can help eliminate flicker in some cases.
5297  *
5298  * What happens is that when the menu is unrealized and then re-realized,
5299  * the allocations are as follows:
5300  *
5301  *  parent - 1x1 at (0,0)
5302  *  child1 - 100x20 at (0,0)
5303  *  child2 - 100x20 at (0,20)
5304  *  child3 - 100x20 at (0,40)
5305  *
5306  * That is, the parent is small but the children are full sized. Then,
5307  * when the queued_resize gets processed, the parent gets resized to
5308  * full size.
5309  *
5310  * But in order to eliminate flicker when scrolling, gdkgeometry-x11.c
5311  * contains the following logic:
5312  *
5313  * - if a move or resize operation on a window would change the clip
5314  *   region on the children, then before the window is resized
5315  *   the background for children is temporarily set to None, the
5316  *   move/resize done, and the background for the children restored.
5317  *
5318  * So, at the point where the parent is resized to final size, the
5319  * background for the children is temporarily None, and thus they
5320  * are not cleared to the background color and the previous background
5321  * (the image of the menu) is left in place.
5322  */
5323 static void
5324 gtk_menu_reparent (GtkMenu   *menu,
5325                    GtkWidget *new_parent,
5326                    gboolean   unrealize)
5327 {
5328   GObject *object = G_OBJECT (menu);
5329   GtkWidget *widget = GTK_WIDGET (menu);
5330   gboolean was_floating = g_object_is_floating (object);
5331
5332   g_object_ref_sink (object);
5333
5334   if (unrealize)
5335     {
5336       g_object_ref (object);
5337       gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (widget)), widget);
5338       gtk_container_add (GTK_CONTAINER (new_parent), widget);
5339       g_object_unref (object);
5340     }
5341   else
5342     gtk_widget_reparent (widget, new_parent);
5343
5344   if (was_floating)
5345     g_object_force_floating (object);
5346   else
5347     g_object_unref (object);
5348 }
5349
5350 static void
5351 gtk_menu_show_all (GtkWidget *widget)
5352 {
5353   /* Show children, but not self. */
5354   gtk_container_foreach (GTK_CONTAINER (widget), (GtkCallback) gtk_widget_show_all, NULL);
5355 }
5356
5357 /**
5358  * gtk_menu_set_screen:
5359  * @menu: a #GtkMenu
5360  * @screen: (allow-none): a #GdkScreen, or %NULL if the screen should be
5361  *          determined by the widget the menu is attached to
5362  *
5363  * Sets the #GdkScreen on which the menu will be displayed.
5364  *
5365  * Since: 2.2
5366  */
5367 void
5368 gtk_menu_set_screen (GtkMenu   *menu,
5369                      GdkScreen *screen)
5370 {
5371   g_return_if_fail (GTK_IS_MENU (menu));
5372   g_return_if_fail (screen == NULL || GDK_IS_SCREEN (screen));
5373
5374   g_object_set_data (G_OBJECT (menu), I_("gtk-menu-explicit-screen"), screen);
5375
5376   if (screen)
5377     {
5378       menu_change_screen (menu, screen);
5379     }
5380   else
5381     {
5382       GtkWidget *attach_widget = gtk_menu_get_attach_widget (menu);
5383       if (attach_widget)
5384         attach_widget_screen_changed (attach_widget, NULL, menu);
5385     }
5386 }
5387
5388 /**
5389  * gtk_menu_attach:
5390  * @menu: a #GtkMenu
5391  * @child: a #GtkMenuItem
5392  * @left_attach: The column number to attach the left side of the item to
5393  * @right_attach: The column number to attach the right side of the item to
5394  * @top_attach: The row number to attach the top of the item to
5395  * @bottom_attach: The row number to attach the bottom of the item to
5396  *
5397  * Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
5398  * an item will occupy is specified by @left_attach, @right_attach,
5399  * @top_attach and @bottom_attach. These each represent the leftmost,
5400  * rightmost, uppermost and lower column and row numbers of the table.
5401  * (Columns and rows are indexed from zero).
5402  *
5403  * Note that this function is not related to gtk_menu_detach().
5404  *
5405  * Since: 2.4
5406  */
5407 void
5408 gtk_menu_attach (GtkMenu   *menu,
5409                  GtkWidget *child,
5410                  guint      left_attach,
5411                  guint      right_attach,
5412                  guint      top_attach,
5413                  guint      bottom_attach)
5414 {
5415   GtkMenuShell *menu_shell;
5416   GtkWidget *parent;
5417
5418   g_return_if_fail (GTK_IS_MENU (menu));
5419   g_return_if_fail (GTK_IS_MENU_ITEM (child));
5420   parent = gtk_widget_get_parent (child);
5421   g_return_if_fail (parent == NULL || parent == GTK_WIDGET (menu));
5422   g_return_if_fail (left_attach < right_attach);
5423   g_return_if_fail (top_attach < bottom_attach);
5424
5425   menu_shell = GTK_MENU_SHELL (menu);
5426
5427   if (!parent)
5428     {
5429       AttachInfo *ai = get_attach_info (child);
5430
5431       ai->left_attach = left_attach;
5432       ai->right_attach = right_attach;
5433       ai->top_attach = top_attach;
5434       ai->bottom_attach = bottom_attach;
5435
5436       menu_shell->priv->children = g_list_append (menu_shell->priv->children, child);
5437
5438       gtk_widget_set_parent (child, GTK_WIDGET (menu));
5439
5440       menu_queue_resize (menu);
5441     }
5442   else
5443     {
5444       gtk_container_child_set (GTK_CONTAINER (parent), child,
5445                                "left-attach",   left_attach,
5446                                "right-attach",  right_attach,
5447                                "top-attach",    top_attach,
5448                                "bottom-attach", bottom_attach,
5449                                NULL);
5450     }
5451 }
5452
5453 static gint
5454 gtk_menu_get_popup_delay (GtkMenuShell *menu_shell)
5455 {
5456   gint popup_delay;
5457
5458   g_object_get (gtk_widget_get_settings (GTK_WIDGET (menu_shell)),
5459                 "gtk-menu-popup-delay", &popup_delay,
5460                 NULL);
5461
5462   return popup_delay;
5463 }
5464
5465 static GtkWidget *
5466 find_child_containing (GtkMenuShell *menu_shell,
5467                        int           left,
5468                        int           right,
5469                        int           top,
5470                        int           bottom)
5471 {
5472   GList *list;
5473
5474   /* find a child which includes the area given by
5475    * left, right, top, bottom.
5476    */
5477   for (list = menu_shell->priv->children; list; list = list->next)
5478     {
5479       gint l, r, t, b;
5480
5481       if (!_gtk_menu_item_is_selectable (list->data))
5482         continue;
5483
5484       get_effective_child_attach (list->data, &l, &r, &t, &b);
5485
5486       if (l <= left && right <= r && t <= top && bottom <= b)
5487         return GTK_WIDGET (list->data);
5488     }
5489
5490   return NULL;
5491 }
5492
5493 static void
5494 gtk_menu_move_current (GtkMenuShell         *menu_shell,
5495                        GtkMenuDirectionType  direction)
5496 {
5497   GtkMenu *menu = GTK_MENU (menu_shell);
5498   gint i;
5499   gint l, r, t, b;
5500   GtkWidget *match = NULL;
5501
5502   if (gtk_widget_get_direction (GTK_WIDGET (menu_shell)) == GTK_TEXT_DIR_RTL)
5503     {
5504       switch (direction)
5505         {
5506         case GTK_MENU_DIR_CHILD:
5507           direction = GTK_MENU_DIR_PARENT;
5508           break;
5509         case GTK_MENU_DIR_PARENT:
5510           direction = GTK_MENU_DIR_CHILD;
5511           break;
5512         default: ;
5513         }
5514     }
5515
5516   /* use special table menu key bindings */
5517   if (menu_shell->priv->active_menu_item && gtk_menu_get_n_columns (menu) > 1)
5518     {
5519       get_effective_child_attach (menu_shell->priv->active_menu_item, &l, &r, &t, &b);
5520
5521       if (direction == GTK_MENU_DIR_NEXT)
5522         {
5523           for (i = b; i < gtk_menu_get_n_rows (menu); i++)
5524             {
5525               match = find_child_containing (menu_shell, l, l + 1, i, i + 1);
5526               if (match)
5527                 break;
5528             }
5529
5530           if (!match)
5531             {
5532               /* wrap around */
5533               for (i = 0; i < t; i++)
5534                 {
5535                   match = find_child_containing (menu_shell,
5536                                                  l, l + 1, i, i + 1);
5537                   if (match)
5538                     break;
5539                 }
5540             }
5541         }
5542       else if (direction == GTK_MENU_DIR_PREV)
5543         {
5544           for (i = t; i > 0; i--)
5545             {
5546               match = find_child_containing (menu_shell,
5547                                              l, l + 1, i - 1, i);
5548               if (match)
5549                 break;
5550             }
5551
5552           if (!match)
5553             {
5554               /* wrap around */
5555               for (i = gtk_menu_get_n_rows (menu); i > b; i--)
5556                 {
5557                   match = find_child_containing (menu_shell,
5558                                                  l, l + 1, i - 1, i);
5559                   if (match)
5560                     break;
5561                 }
5562             }
5563         }
5564       else if (direction == GTK_MENU_DIR_PARENT)
5565         {
5566           /* we go one left if possible */
5567           if (l > 0)
5568             match = find_child_containing (menu_shell,
5569                                            l - 1, l, t, t + 1);
5570
5571           if (!match)
5572             {
5573               GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5574
5575               if (!parent
5576                   || g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1)
5577                 match = menu_shell->priv->active_menu_item;
5578             }
5579         }
5580       else if (direction == GTK_MENU_DIR_CHILD)
5581         {
5582           /* we go one right if possible */
5583           if (r < gtk_menu_get_n_columns (menu))
5584             match = find_child_containing (menu_shell, r, r + 1, t, t + 1);
5585
5586           if (!match)
5587             {
5588               GtkWidget *parent = menu_shell->priv->parent_menu_shell;
5589
5590               if (! GTK_MENU_ITEM (menu_shell->priv->active_menu_item)->priv->submenu &&
5591                   (!parent ||
5592                    g_list_length (GTK_MENU_SHELL (parent)->priv->children) <= 1))
5593                 match = menu_shell->priv->active_menu_item;
5594             }
5595         }
5596
5597       if (match)
5598         {
5599           gtk_menu_shell_select_item (menu_shell, match);
5600           return;
5601         }
5602     }
5603
5604   GTK_MENU_SHELL_CLASS (gtk_menu_parent_class)->move_current (menu_shell, direction);
5605 }
5606
5607 static gint
5608 get_visible_size (GtkMenu *menu)
5609 {
5610   GtkMenuPrivate *priv = menu->priv;
5611   GtkAllocation allocation;
5612   GtkWidget *widget = GTK_WIDGET (menu);
5613   GtkContainer *container = GTK_CONTAINER (menu);
5614   GtkBorder padding;
5615   gint menu_height;
5616
5617   gtk_widget_get_allocation (widget, &allocation);
5618   get_menu_padding (widget, &padding);
5619
5620   menu_height = (allocation.height -
5621                  (2 * gtk_container_get_border_width (container)) -
5622                  padding.top - padding.bottom);
5623
5624   if (!priv->tearoff_active)
5625     {
5626       GtkBorder arrow_border;
5627
5628       get_arrows_border (menu, &arrow_border);
5629       menu_height -= arrow_border.top;
5630       menu_height -= arrow_border.bottom;
5631     }
5632
5633   return menu_height;
5634 }
5635
5636 /* Find the sensitive on-screen child containing @y, or if none,
5637  * the nearest selectable onscreen child. (%NULL if none)
5638  */
5639 static GtkWidget *
5640 child_at (GtkMenu *menu,
5641           gint     y)
5642 {
5643   GtkMenuPrivate *priv = menu->priv;
5644   GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5645   GtkWidget *child = NULL;
5646   gint child_offset = 0;
5647   GList *children;
5648   gint menu_height;
5649   gint lower, upper; /* Onscreen bounds */
5650
5651   menu_height = get_visible_size (menu);
5652   lower = priv->scroll_offset;
5653   upper = priv->scroll_offset + menu_height;
5654
5655   for (children = menu_shell->priv->children; children; children = children->next)
5656     {
5657       if (gtk_widget_get_visible (children->data))
5658         {
5659           GtkRequisition child_requisition;
5660
5661           gtk_widget_get_preferred_size (children->data,
5662                                          &child_requisition, NULL);
5663
5664           if (_gtk_menu_item_is_selectable (children->data) &&
5665               child_offset >= lower &&
5666               child_offset + child_requisition.height <= upper)
5667             {
5668               child = children->data;
5669
5670               if (child_offset + child_requisition.height > y &&
5671                   !GTK_IS_TEAROFF_MENU_ITEM (child))
5672                 return child;
5673             }
5674
5675           child_offset += child_requisition.height;
5676         }
5677     }
5678
5679   return child;
5680 }
5681
5682 static gint
5683 get_menu_height (GtkMenu *menu)
5684 {
5685   GtkMenuPrivate *priv = menu->priv;
5686   GtkAllocation allocation;
5687   GtkWidget *widget = GTK_WIDGET (menu);
5688   GtkBorder padding;
5689   gint height;
5690
5691   gtk_widget_get_allocation (widget, &allocation);
5692   get_menu_padding (widget, &padding);
5693
5694   height = allocation.height;
5695   height -= (gtk_container_get_border_width (GTK_CONTAINER (widget)) * 2) +
5696     padding.top + padding.bottom;
5697
5698   if (!priv->tearoff_active)
5699     {
5700       GtkBorder arrow_border;
5701
5702       get_arrows_border (menu, &arrow_border);
5703       height -= arrow_border.top;
5704       height -= arrow_border.bottom;
5705     }
5706
5707   return height;
5708 }
5709
5710 static void
5711 gtk_menu_real_move_scroll (GtkMenu       *menu,
5712                            GtkScrollType  type)
5713 {
5714   GtkMenuPrivate *priv = menu->priv;
5715   gint page_size = get_visible_size (menu);
5716   gint end_position = get_menu_height (menu);
5717   GtkMenuShell *menu_shell = GTK_MENU_SHELL (menu);
5718
5719   switch (type)
5720     {
5721     case GTK_SCROLL_PAGE_UP:
5722     case GTK_SCROLL_PAGE_DOWN:
5723       {
5724         gint old_offset;
5725         gint new_offset;
5726         gint child_offset = 0;
5727         gboolean old_upper_arrow_visible;
5728         gint step;
5729
5730         if (type == GTK_SCROLL_PAGE_UP)
5731           step = - page_size;
5732         else
5733           step = page_size;
5734
5735         if (menu_shell->priv->active_menu_item)
5736           {
5737             gint child_height;
5738
5739             compute_child_offset (menu, menu_shell->priv->active_menu_item,
5740                                   &child_offset, &child_height, NULL);
5741             child_offset += child_height / 2;
5742           }
5743
5744         menu_shell->priv->ignore_enter = TRUE;
5745         old_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5746         old_offset = priv->scroll_offset;
5747
5748         new_offset = priv->scroll_offset + step;
5749         new_offset = CLAMP (new_offset, 0, end_position - page_size);
5750
5751         gtk_menu_scroll_to (menu, new_offset);
5752
5753         if (menu_shell->priv->active_menu_item)
5754           {
5755             GtkWidget *new_child;
5756             gboolean new_upper_arrow_visible = priv->upper_arrow_visible && !priv->tearoff_active;
5757             GtkBorder arrow_border;
5758             get_arrows_border (menu, &arrow_border);
5759
5760             if (priv->scroll_offset != old_offset)
5761               step = priv->scroll_offset - old_offset;
5762
5763             step -= (new_upper_arrow_visible - old_upper_arrow_visible) * arrow_border.top;
5764
5765             new_child = child_at (menu, child_offset + step);
5766             if (new_child)
5767               gtk_menu_shell_select_item (menu_shell, new_child);
5768           }
5769       }
5770       break;
5771     case GTK_SCROLL_START:
5772       /* Ignore the enter event we might get if the pointer is on the menu */
5773       menu_shell->priv->ignore_enter = TRUE;
5774       gtk_menu_scroll_to (menu, 0);
5775       gtk_menu_shell_select_first (menu_shell, TRUE);
5776       break;
5777     case GTK_SCROLL_END:
5778       /* Ignore the enter event we might get if the pointer is on the menu */
5779       menu_shell->priv->ignore_enter = TRUE;
5780       gtk_menu_scroll_to (menu, end_position - page_size);
5781       _gtk_menu_shell_select_last (menu_shell, TRUE);
5782       break;
5783     default:
5784       break;
5785     }
5786 }
5787
5788 /**
5789  * gtk_menu_set_monitor:
5790  * @menu: a #GtkMenu
5791  * @monitor_num: the number of the monitor on which the menu should
5792  *    be popped up
5793  *
5794  * Informs GTK+ on which monitor a menu should be popped up.
5795  * See gdk_screen_get_monitor_geometry().
5796  *
5797  * This function should be called from a #GtkMenuPositionFunc
5798  * if the menu should not appear on the same monitor as the pointer.
5799  * This information can't be reliably inferred from the coordinates
5800  * returned by a #GtkMenuPositionFunc, since, for very long menus,
5801  * these coordinates may extend beyond the monitor boundaries or even
5802  * the screen boundaries.
5803  *
5804  * Since: 2.4
5805  */
5806 void
5807 gtk_menu_set_monitor (GtkMenu *menu,
5808                       gint     monitor_num)
5809 {
5810   GtkMenuPrivate *priv = menu->priv;
5811
5812   g_return_if_fail (GTK_IS_MENU (menu));
5813
5814   priv->monitor_num = monitor_num;
5815 }
5816
5817 /**
5818  * gtk_menu_get_monitor:
5819  * @menu: a #GtkMenu
5820  *
5821  * Retrieves the number of the monitor on which to show the menu.
5822  *
5823  * Returns: the number of the monitor on which the menu should
5824  *    be popped up or -1, if no monitor has been set
5825  *
5826  * Since: 2.14
5827  */
5828 gint
5829 gtk_menu_get_monitor (GtkMenu *menu)
5830 {
5831   g_return_val_if_fail (GTK_IS_MENU (menu), -1);
5832
5833   return menu->priv->monitor_num;
5834 }
5835
5836 /**
5837  * gtk_menu_get_for_attach_widget:
5838  * @widget: a #GtkWidget
5839  *
5840  * Returns a list of the menus which are attached to this widget.
5841  * This list is owned by GTK+ and must not be modified.
5842  *
5843  * Return value: (element-type GtkWidget) (transfer none): the list
5844  *     of menus attached to his widget.
5845  *
5846  * Since: 2.6
5847  */
5848 GList*
5849 gtk_menu_get_for_attach_widget (GtkWidget *widget)
5850 {
5851   GList *list;
5852
5853   g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
5854
5855   list = g_object_get_data (G_OBJECT (widget), ATTACHED_MENUS);
5856
5857   return list;
5858 }
5859
5860 static void
5861 gtk_menu_grab_notify (GtkWidget *widget,
5862                       gboolean   was_grabbed)
5863 {
5864   GtkMenu *menu;
5865   GtkWidget *toplevel;
5866   GtkWindowGroup *group;
5867   GtkWidget *grab;
5868   GdkDevice *pointer;
5869
5870   menu = GTK_MENU (widget);
5871   pointer = _gtk_menu_shell_get_grab_device (GTK_MENU_SHELL (widget));
5872
5873   if (!pointer ||
5874       !gtk_widget_device_is_shadowed (widget, pointer))
5875     return;
5876
5877   toplevel = gtk_widget_get_toplevel (widget);
5878
5879   if (!GTK_IS_WINDOW (toplevel))
5880     return;
5881
5882   group = gtk_window_get_group (GTK_WINDOW (toplevel));
5883   grab = gtk_window_group_get_current_device_grab (group, pointer);
5884
5885   if (GTK_MENU_SHELL (widget)->priv->active && !GTK_IS_MENU_SHELL (grab))
5886     gtk_menu_shell_cancel (GTK_MENU_SHELL (widget));
5887
5888   menu->priv->drag_scroll_started = FALSE;
5889 }
5890
5891 /**
5892  * gtk_menu_set_reserve_toggle_size:
5893  * @menu: a #GtkMenu
5894  * @reserve_toggle_size: whether to reserve size for toggles
5895  *
5896  * Sets whether the menu should reserve space for drawing toggles
5897  * or icons, regardless of their actual presence.
5898  *
5899  * Since: 2.18
5900  */
5901 void
5902 gtk_menu_set_reserve_toggle_size (GtkMenu  *menu,
5903                                   gboolean  reserve_toggle_size)
5904 {
5905   GtkMenuPrivate *priv = menu->priv;
5906   gboolean no_toggle_size;
5907
5908   g_return_if_fail (GTK_IS_MENU (menu));
5909
5910   no_toggle_size = !reserve_toggle_size;
5911
5912   if (priv->no_toggle_size != no_toggle_size)
5913     {
5914       priv->no_toggle_size = no_toggle_size;
5915
5916       g_object_notify (G_OBJECT (menu), "reserve-toggle-size");
5917     }
5918 }
5919
5920 /**
5921  * gtk_menu_get_reserve_toggle_size:
5922  * @menu: a #GtkMenu
5923  *
5924  * Returns whether the menu reserves space for toggles and
5925  * icons, regardless of their actual presence.
5926  *
5927  * Returns: Whether the menu reserves toggle space
5928  *
5929  * Since: 2.18
5930  */
5931 gboolean
5932 gtk_menu_get_reserve_toggle_size (GtkMenu *menu)
5933 {
5934   g_return_val_if_fail (GTK_IS_MENU (menu), FALSE);
5935
5936   return !menu->priv->no_toggle_size;
5937 }