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

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