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