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