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