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