vcs.maemo.org Git - hildon/blob - src/hildon-app-menu.c

   1 /*
   2  * This file is a part of hildon
   3  *
   4  * Copyright (C) 2008 Nokia Corporation, all rights reserved.
   5  *
   6  * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU Lesser Public License as published by
  10  * the Free Software Foundation; version 2 of the license.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Lesser Public License for more details.
  16  *
  17  */
  18
  19 /**
  20  * SECTION:hildon-app-menu
  21  * @short_description: Widget representing the application menu in the Hildon framework.
  22  *
  23  * The #HildonAppMenu is a GTK widget which represents an application
  24  * menu in the Hildon framework.
  25  *
  26  * This menu opens from the top of the screen and contains a number of
  27  * entries (#GtkButton) organized in one or two columns, depending on
  28  * the size of the screen (the number of columns changes automatically
  29  * if the screen is resized). Entries are added left to right and top
  30  * to bottom.
  31  *
  32  * Besides that, the #HildonAppMenu can contain a group of filter buttons
  33  * (#GtkToggleButton or #GtkRadioButton).
  34  *
  35  * To use a #HildonAppMenu, add it to a #HildonWindow using
  36  * hildon_window_set_app_menu(). The menu will appear when the user
  37  * presses the window title bar. Alternatively, you can show it by
  38  * hand using hildon_app_menu_popup().
  39  *
  40  * The menu will be automatically hidden when one of its buttons is
  41  * clicked. Use g_signal_connect_after() when connecting callbacks to
  42  * buttons to make sure that they're called after the menu
  43  * disappears. Alternatively, you can add the button to the menu
  44  * before connecting any callback.
  45  *
  46  * Although implemented with a #GtkWindow, #HildonAppMenu behaves like
  47  * a normal ref-counted widget, so g_object_ref(), g_object_unref(),
  48  * g_object_ref_sink() and friends will behave just like with any
  49  * other non-toplevel widget.
  50  *
  51  * <example>
  52  * <title>Creating a HildonAppMenu</title>
  53  * <programlisting>
  54  * GtkWidget *win;
  55  * HildonAppMenu *menu;
  56  * GtkWidget *button;
  57  * GtkWidget *filter;
  58  * <!-- -->
  59  * win = hildon_stackable_window_new ();
  60  * menu = HILDON_APP_MENU (hildon_app_menu_new ());
  61  * <!-- -->
  62  * // Create a button and add it to the menu
  63  * button = gtk_button_new_with_label ("Menu command one");
  64  * g_signal_connect_after (button, "clicked", G_CALLBACK (button_one_clicked), userdata);
  65  * hildon_app_menu_append (menu, GTK_BUTTON (button));
  66  * <!-- -->
  67  * // Another button
  68  * button = gtk_button_new_with_label ("Menu command two");
  69  * g_signal_connect_after (button, "clicked", G_CALLBACK (button_two_clicked), userdata);
  70  * hildon_app_menu_append (menu, GTK_BUTTON (button));
  71  * <!-- -->
  72  * // Create a filter and add it to the menu
  73  * filter = gtk_radio_button_new_with_label (NULL, "Filter one");
  74  * gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (filter), FALSE);
  75  * g_signal_connect_after (filter, "clicked", G_CALLBACK (filter_one_clicked), userdata);
  76  * hildon_app_menu_add_filter (menu, GTK_BUTTON (filter));
  77  * <!-- -->
  78  * // Add a new filter
  79  * filter = gtk_radio_button_new_with_label_from_widget (GTK_RADIO_BUTTON (filter), "Filter two");
  80  * gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (filter), FALSE);
  81  * g_signal_connect_after (filter, "clicked", G_CALLBACK (filter_two_clicked), userdata);
  82  * hildon_app_menu_add_filter (menu, GTK_BUTTON (filter));
  83  * <!-- -->
  84  * // Show all menu items
  85  * gtk_widget_show_all (GTK_WIDGET (menu));
  86  * <!-- -->
  87  * // Add the menu to the window
  88  * hildon_window_set_app_menu (HILDON_WINDOW (win), menu);
  89  * </programlisting>
  90  * </example>
  91  *
  92  */
  93
  94 #include                                        <string.h>
  95 #include                                        <X11/Xatom.h>
  96 #include                                        <gdk/gdkx.h>
  97
  98 #include                                        "hildon-gtk.h"
  99 #include                                        "hildon-app-menu.h"
 100 #include                                        "hildon-app-menu-private.h"
 101 #include                                        "hildon-window.h"
 102
 103 static GdkWindow *
 104 grab_transfer_window_get                        (GtkWidget *widget);
 105
 106 static void
 107 hildon_app_menu_repack_items                    (HildonAppMenu *menu,
 108                                                  gint           start_from);
 109
 110 static void
 111 hildon_app_menu_repack_filters                  (HildonAppMenu *menu);
 112
 113 static gboolean
 114 can_activate_accel                              (GtkWidget *widget,
 115                                                  guint      signal_id,
 116                                                  gpointer   user_data);
 117
 118 static void
 119 item_visibility_changed                         (GtkWidget     *item,
 120                                                  GParamSpec    *arg1,
 121                                                  HildonAppMenu *menu);
 122
 123 static void
 124 filter_visibility_changed                       (GtkWidget     *item,
 125                                                  GParamSpec    *arg1,
 126                                                  HildonAppMenu *menu);
 127
 128 static void
 129 remove_item_from_list                           (GList    **list,
 130                                                  gpointer   item);
 131
 132 static void
 133 hildon_app_menu_apply_style                     (GtkWidget *widget);
 134
 135 G_DEFINE_TYPE (HildonAppMenu, hildon_app_menu, GTK_TYPE_WINDOW);
 136
 137 /**
 138  * hildon_app_menu_new:
 139  *
 140  * Creates a new #HildonAppMenu.
 141  *
 142  * Return value: A #HildonAppMenu.
 143  *
 144  * Since: 2.2
 145  **/
 146 GtkWidget *
 147 hildon_app_menu_new                             (void)
 148 {
 149     GtkWidget *menu = g_object_new (HILDON_TYPE_APP_MENU, NULL);
 150     return menu;
 151 }
 152
 153 /**
 154  * hildon_app_menu_insert:
 155  * @menu : A #HildonAppMenu
 156  * @item : A #GtkButton to add to the #HildonAppMenu
 157  * @position : The position in the item list where @item is added (from 0 to n-1).
 158  *
 159  * Adds @item to @menu at the position indicated by @position.
 160  *
 161  * Since: 2.2
 162  */
 163 void
 164 hildon_app_menu_insert                          (HildonAppMenu *menu,
 165                                                  GtkButton     *item,
 166                                                  gint           position)
 167 {
 168     HildonAppMenuPrivate *priv;
 169
 170     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 171     g_return_if_fail (GTK_IS_BUTTON (item));
 172
 173     priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 174
 175     /* Force widget size */
 176     hildon_gtk_widget_set_theme_size (GTK_WIDGET (item),
 177                                       HILDON_SIZE_FINGER_HEIGHT | HILDON_SIZE_AUTO_WIDTH);
 178
 179     /* Add the item to the menu */
 180     gtk_widget_show (GTK_WIDGET (item));
 181     g_object_ref_sink (item);
 182     priv->buttons = g_list_insert (priv->buttons, item, position);
 183     hildon_app_menu_repack_items (menu, position);
 184
 185     /* Enable accelerators */
 186     g_signal_connect (item, "can-activate-accel", G_CALLBACK (can_activate_accel), NULL);
 187
 188     /* Close the menu when the button is clicked */
 189     g_signal_connect_swapped (item, "clicked", G_CALLBACK (gtk_widget_hide), menu);
 190     g_signal_connect (item, "notify::visible", G_CALLBACK (item_visibility_changed), menu);
 191
 192     /* Remove item from list when it is destroyed */
 193     g_object_weak_ref (G_OBJECT (item), (GWeakNotify) remove_item_from_list, &(priv->buttons));
 194 }
 195
 196 /**
 197  * hildon_app_menu_append:
 198  * @menu : A #HildonAppMenu
 199  * @item : A #GtkButton to add to the #HildonAppMenu
 200  *
 201  * Adds @item to the end of the menu's item list.
 202  *
 203  * Since: 2.2
 204  */
 205 void
 206 hildon_app_menu_append                          (HildonAppMenu *menu,
 207                                                  GtkButton     *item)
 208 {
 209     hildon_app_menu_insert (menu, item, -1);
 210 }
 211
 212 /**
 213  * hildon_app_menu_prepend:
 214  * @menu : A #HildonAppMenu
 215  * @item : A #GtkButton to add to the #HildonAppMenu
 216  *
 217  * Adds @item to the beginning of the menu's item list.
 218  *
 219  * Since: 2.2
 220  */
 221 void
 222 hildon_app_menu_prepend                         (HildonAppMenu *menu,
 223                                                  GtkButton     *item)
 224 {
 225     hildon_app_menu_insert (menu, item, 0);
 226 }
 227
 228 /**
 229  * hildon_app_menu_reorder_child:
 230  * @menu : A #HildonAppMenu
 231  * @item : A #GtkButton to move
 232  * @position : The new position to place @item (from 0 to n-1).
 233  *
 234  * Moves a #GtkButton to a new position within #HildonAppMenu.
 235  *
 236  * Since: 2.2
 237  */
 238 void
 239 hildon_app_menu_reorder_child                   (HildonAppMenu *menu,
 240                                                  GtkButton     *item,
 241                                                  gint           position)
 242 {
 243     HildonAppMenuPrivate *priv;
 244     gint old_position;
 245
 246     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 247     g_return_if_fail (GTK_IS_BUTTON (item));
 248     g_return_if_fail (position >= 0);
 249
 250     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 251     old_position = g_list_index (priv->buttons, item);
 252
 253     g_return_if_fail (old_position >= 0);
 254
 255     /* Move the item */
 256     priv->buttons = g_list_remove (priv->buttons, item);
 257     priv->buttons = g_list_insert (priv->buttons, item, position);
 258
 259     hildon_app_menu_repack_items (menu, MIN (old_position, position));
 260 }
 261
 262 /**
 263  * hildon_app_menu_add_filter:
 264  * @menu : A #HildonAppMenu
 265  * @filter : A #GtkButton to add to the #HildonAppMenu.
 266  *
 267  * Adds the @filter to @menu.
 268  *
 269  * Since: 2.2
 270  */
 271 void
 272 hildon_app_menu_add_filter                      (HildonAppMenu *menu,
 273                                                  GtkButton *filter)
 274 {
 275     HildonAppMenuPrivate *priv;
 276
 277     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 278     g_return_if_fail (GTK_IS_BUTTON (filter));
 279
 280     priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 281
 282     /* Force widget size */
 283     hildon_gtk_widget_set_theme_size (GTK_WIDGET (filter),
 284                                       HILDON_SIZE_FINGER_HEIGHT | HILDON_SIZE_AUTO_WIDTH);
 285
 286     /* Add the filter to the menu */
 287     gtk_widget_show (GTK_WIDGET (filter));
 288     g_object_ref_sink (filter);
 289     priv->filters = g_list_append (priv->filters, filter);
 290     hildon_app_menu_repack_filters (menu);
 291
 292     /* Enable accelerators */
 293     g_signal_connect (filter, "can-activate-accel", G_CALLBACK (can_activate_accel), NULL);
 294
 295     /* Close the menu when the button is clicked */
 296     g_signal_connect_swapped (filter, "clicked", G_CALLBACK (gtk_widget_hide), menu);
 297     g_signal_connect (filter, "notify::visible", G_CALLBACK (filter_visibility_changed), menu);
 298
 299     /* Remove filter from list when it is destroyed */
 300     g_object_weak_ref (G_OBJECT (filter), (GWeakNotify) remove_item_from_list, &(priv->filters));
 301 }
 302
 303 static void
 304 hildon_app_menu_set_columns                     (HildonAppMenu *menu,
 305                                                  guint          columns)
 306 {
 307     HildonAppMenuPrivate *priv;
 308
 309     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 310     g_return_if_fail (columns > 0);
 311
 312     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 313
 314     if (columns != priv->columns) {
 315         priv->columns = columns;
 316         hildon_app_menu_repack_items (menu, 0);
 317     }
 318 }
 319
 320 static void
 321 parent_window_topmost_notify                   (HildonWindow *parent_win,
 322                                                 GParamSpec   *arg1,
 323                                                 GtkWidget    *menu)
 324 {
 325     if (!hildon_window_get_is_topmost (parent_win))
 326         gtk_widget_hide (menu);
 327 }
 328
 329 static void
 330 parent_window_unmapped                         (HildonWindow *parent_win,
 331                                                 GtkWidget    *menu)
 332 {
 333     gtk_widget_hide (menu);
 334 }
 335
 336 void G_GNUC_INTERNAL
 337 hildon_app_menu_set_parent_window              (HildonAppMenu *self,
 338                                                 GtkWindow     *parent_window)
 339 {
 340     HildonAppMenuPrivate *priv;
 341
 342     g_return_if_fail (HILDON_IS_APP_MENU (self));
 343     g_return_if_fail (parent_window == NULL || GTK_IS_WINDOW (parent_window));
 344
 345     priv = HILDON_APP_MENU_GET_PRIVATE(self);
 346
 347     /* Disconnect old handlers, if any */
 348     if (priv->parent_window) {
 349         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_topmost_notify, self);
 350         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_unmapped, self);
 351     }
 352
 353     /* Connect a new handler */
 354     if (parent_window) {
 355         g_signal_connect (parent_window, "notify::is-topmost", G_CALLBACK (parent_window_topmost_notify), self);
 356         g_signal_connect (parent_window, "unmap", G_CALLBACK (parent_window_unmapped), self);
 357     }
 358
 359     priv->parent_window = parent_window;
 360
 361     if (parent_window == NULL && GTK_WIDGET_VISIBLE (self))
 362         gtk_widget_hide (GTK_WIDGET (self));
 363 }
 364
 365 gpointer G_GNUC_INTERNAL
 366 hildon_app_menu_get_parent_window              (HildonAppMenu *self)
 367 {
 368     HildonAppMenuPrivate *priv;
 369
 370     g_return_val_if_fail (HILDON_IS_APP_MENU (self), NULL);
 371
 372     priv = HILDON_APP_MENU_GET_PRIVATE (self);
 373
 374     return priv->parent_window;
 375 }
 376
 377 static void
 378 screen_size_changed                            (GdkScreen     *screen,
 379                                                 HildonAppMenu *menu)
 380 {
 381     hildon_app_menu_apply_style (GTK_WIDGET (menu));
 382
 383     if (gdk_screen_get_width (screen) > gdk_screen_get_height (screen)) {
 384         hildon_app_menu_set_columns (menu, 2);
 385     } else {
 386         hildon_app_menu_set_columns (menu, 1);
 387     }
 388 }
 389
 390 static gboolean
 391 can_activate_accel                              (GtkWidget *widget,
 392                                                  guint      signal_id,
 393                                                  gpointer   user_data)
 394 {
 395     return GTK_WIDGET_VISIBLE (widget);
 396 }
 397
 398 static void
 399 item_visibility_changed                         (GtkWidget     *item,
 400                                                  GParamSpec    *arg1,
 401                                                  HildonAppMenu *menu)
 402 {
 403     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 404
 405     hildon_app_menu_repack_items (menu, g_list_index (priv->buttons, item));
 406 }
 407
 408 static void
 409 filter_visibility_changed                       (GtkWidget     *item,
 410                                                  GParamSpec    *arg1,
 411                                                  HildonAppMenu *menu)
 412 {
 413     hildon_app_menu_repack_filters (menu);
 414 }
 415
 416 static void
 417 remove_item_from_list                           (GList    **list,
 418                                                  gpointer   item)
 419 {
 420     *list = g_list_remove (*list, item);
 421 }
 422
 423 static void
 424 hildon_app_menu_show                            (GtkWidget *widget)
 425 {
 426     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 427     gboolean show_menu = FALSE;
 428     GList *i;
 429
 430     /* Don't show menu if it doesn't contain visible items */
 431     for (i = priv->buttons; i && !show_menu; i = i->next)
 432         show_menu = GTK_WIDGET_VISIBLE (i->data);
 433
 434     for (i = priv->filters; i && !show_menu; i = i->next)
 435         show_menu = GTK_WIDGET_VISIBLE (i->data);
 436
 437     if (show_menu) {
 438         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->show (widget);
 439     }
 440 }
 441
 442 static void
 443 hildon_app_menu_show_all                        (GtkWidget *widget)
 444 {
 445     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 446
 447     /* Show children, but not self. */
 448     g_list_foreach (priv->buttons, (GFunc) gtk_widget_show_all, NULL);
 449     g_list_foreach (priv->filters, (GFunc) gtk_widget_show_all, NULL);
 450 }
 451
 452
 453 static void
 454 hildon_app_menu_hide_all                        (GtkWidget *widget)
 455 {
 456     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 457
 458     /* Hide children, but not self. */
 459     g_list_foreach (priv->buttons, (GFunc) gtk_widget_hide_all, NULL);
 460     g_list_foreach (priv->filters, (GFunc) gtk_widget_hide_all, NULL);
 461 }
 462
 463 /*
 464  * There's a race condition that can freeze the UI if a dialog appears
 465  * between a HildonAppMenu and its parent window, see NB#100468
 466  */
 467 static gboolean
 468 hildon_app_menu_find_intruder                   (gpointer data)
 469 {
 470     GtkWidget *widget = GTK_WIDGET (data);
 471     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 472
 473     /* If there's a window between the menu and its parent window, hide the menu */
 474     if (priv->parent_window) {
 475         gboolean intruder_found = FALSE;
 476         GdkScreen *screen = gtk_widget_get_screen (widget);
 477         GList *stack = gdk_screen_get_window_stack (screen);
 478         GList *parent_pos = g_list_find (stack, GTK_WIDGET (priv->parent_window)->window);
 479         GList *toplevels = gtk_window_list_toplevels ();
 480         GList *i;
 481
 482         for (i = toplevels; i != NULL && !intruder_found; i = i->next) {
 483             if (i->data != widget && i->data != priv->parent_window) {
 484                 if (g_list_find (parent_pos, GTK_WIDGET (i->data)->window)) {
 485                     intruder_found = TRUE;
 486                 }
 487             }
 488         }
 489
 490         g_list_foreach (stack, (GFunc) g_object_unref, NULL);
 491         g_list_free (stack);
 492         g_list_free (toplevels);
 493
 494         if (intruder_found)
 495             gtk_widget_hide (widget);
 496     }
 497
 498     return FALSE;
 499 }
 500
 501 static void
 502 hildon_app_menu_map                             (GtkWidget *widget)
 503 {
 504     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 505
 506     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->map (widget);
 507
 508     /* Grab pointer and keyboard */
 509     if (priv->transfer_window == NULL) {
 510         gboolean has_grab = FALSE;
 511
 512         priv->transfer_window = grab_transfer_window_get (widget);
 513
 514         if (gdk_pointer_grab (priv->transfer_window, TRUE,
 515                               GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
 516                               GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
 517                               GDK_POINTER_MOTION_MASK, NULL, NULL,
 518                               GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
 519             if (gdk_keyboard_grab (priv->transfer_window, TRUE,
 520                                    GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
 521                 has_grab = TRUE;
 522             } else {
 523                 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
 524                                             GDK_CURRENT_TIME);
 525             }
 526         }
 527
 528         if (has_grab) {
 529             gtk_grab_add (widget);
 530         } else {
 531             gdk_window_destroy (priv->transfer_window);
 532             priv->transfer_window = NULL;
 533         }
 534     }
 535
 536     /* Make the menu temporary when it's mapped, so it's closed if a
 537      * new window appears */
 538     gtk_window_set_is_temporary (GTK_WINDOW (widget), TRUE);
 539
 540     gdk_threads_add_idle (hildon_app_menu_find_intruder, widget);
 541 }
 542
 543 static void
 544 hildon_app_menu_unmap                           (GtkWidget *widget)
 545 {
 546     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 547
 548     /* Remove the grab */
 549     if (priv->transfer_window != NULL) {
 550         gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
 551                                     GDK_CURRENT_TIME);
 552         gtk_grab_remove (widget);
 553
 554         gdk_window_destroy (priv->transfer_window);
 555         priv->transfer_window = NULL;
 556     }
 557
 558     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unmap (widget);
 559
 560     gtk_window_set_is_temporary (GTK_WINDOW (widget), FALSE);
 561 }
 562
 563 static void
 564 hildon_app_menu_grab_notify                     (GtkWidget *widget,
 565                                                  gboolean   was_grabbed)
 566 {
 567     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify)
 568         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify (widget, was_grabbed);
 569
 570     if (!was_grabbed && GTK_WIDGET_VISIBLE (widget))
 571         gtk_widget_hide (widget);
 572 }
 573
 574 static gboolean
 575 hildon_app_menu_hide_idle                       (gpointer widget)
 576 {
 577     gtk_widget_hide (GTK_WIDGET (widget));
 578     return FALSE;
 579 }
 580
 581 /* Send keyboard accelerators to the parent window, if necessary.
 582  * This code is heavily based on gtk_menu_key_press ()
 583  */
 584 static gboolean
 585 hildon_app_menu_key_press                       (GtkWidget   *widget,
 586                                                  GdkEventKey *event)
 587 {
 588     GtkWindow *parent_window;
 589     HildonAppMenuPrivate *priv;
 590
 591     g_return_val_if_fail (HILDON_IS_APP_MENU (widget), FALSE);
 592     g_return_val_if_fail (event != NULL, FALSE);
 593
 594     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->key_press_event (widget, event))
 595         return TRUE;
 596
 597     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 598     parent_window = priv->parent_window;
 599
 600     if (parent_window) {
 601         guint accel_key, accel_mods;
 602         GdkModifierType consumed_modifiers;
 603         GdkDisplay *display;
 604         GSList *accel_groups;
 605         GSList *list;
 606
 607         display = gtk_widget_get_display (widget);
 608
 609         /* Figure out what modifiers went into determining the key symbol */
 610         gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
 611                                              event->hardware_keycode, event->state, event->group,
 612                                              NULL, NULL, NULL, &consumed_modifiers);
 613
 614         accel_key = gdk_keyval_to_lower (event->keyval);
 615         accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
 616
 617         /* If lowercasing affects the keysym, then we need to include SHIFT in the modifiers,
 618          * We re-upper case when we match against the keyval, but display and save in caseless form.
 619          */
 620         if (accel_key != event->keyval)
 621             accel_mods |= GDK_SHIFT_MASK;
 622
 623         accel_groups = gtk_accel_groups_from_object (G_OBJECT (parent_window));
 624
 625         for (list = accel_groups; list; list = list->next) {
 626             GtkAccelGroup *accel_group = list->data;
 627
 628             if (gtk_accel_group_query (accel_group, accel_key, accel_mods, NULL)) {
 629                 gtk_window_activate_key (parent_window, event);
 630                 gdk_threads_add_idle (hildon_app_menu_hide_idle, widget);
 631                 break;
 632             }
 633         }
 634     }
 635
 636     return TRUE;
 637 }
 638
 639 static gboolean
 640 hildon_app_menu_button_press                    (GtkWidget *widget,
 641                                                  GdkEventButton *event)
 642 {
 643     int x, y;
 644     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 645
 646     gdk_window_get_position (widget->window, &x, &y);
 647
 648     /* Whether the button has been pressed outside the widget */
 649     priv->pressed_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
 650                              event->y_root < y || event->y_root > y + widget->allocation.height);
 651
 652     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event) {
 653         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event (widget, event);
 654     } else {
 655         return FALSE;
 656     }
 657 }
 658
 659 static gboolean
 660 hildon_app_menu_button_release                  (GtkWidget *widget,
 661                                                  GdkEventButton *event)
 662 {
 663     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 664
 665     if (priv->pressed_outside) {
 666         int x, y;
 667         gboolean released_outside;
 668
 669         gdk_window_get_position (widget->window, &x, &y);
 670
 671         /* Whether the button has been released outside the widget */
 672         released_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
 673                             event->y_root < y || event->y_root > y + widget->allocation.height);
 674
 675         if (released_outside) {
 676             gtk_widget_hide (widget);
 677         }
 678
 679         priv->pressed_outside = FALSE; /* Always reset pressed_outside to FALSE */
 680     }
 681
 682     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event) {
 683         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event (widget, event);
 684     } else {
 685         return FALSE;
 686     }
 687 }
 688
 689 /* Grab transfer window (based on the one from GtkMenu) */
 690 static GdkWindow *
 691 grab_transfer_window_get                        (GtkWidget *widget)
 692 {
 693     GdkWindow *window;
 694     GdkWindowAttr attributes;
 695     gint attributes_mask;
 696
 697     attributes.x = 0;
 698     attributes.y = 0;
 699     attributes.width = 10;
 700     attributes.height = 10;
 701     attributes.window_type = GDK_WINDOW_TEMP;
 702     attributes.wclass = GDK_INPUT_ONLY;
 703     attributes.override_redirect = TRUE;
 704     attributes.event_mask = 0;
 705
 706     attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
 707
 708     window = gdk_window_new (gtk_widget_get_root_window (widget),
 709                                  &attributes, attributes_mask);
 710     gdk_window_set_user_data (window, widget);
 711
 712     gdk_window_show (window);
 713
 714     return window;
 715 }
 716
 717 static void
 718 hildon_app_menu_realize                         (GtkWidget *widget)
 719 {
 720     Atom property, window_type;
 721     Display *xdisplay;
 722     GdkDisplay *gdkdisplay;
 723     GdkScreen *screen;
 724
 725     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->realize (widget);
 726
 727     gdk_window_set_decorations (widget->window, GDK_DECOR_BORDER);
 728
 729     gdkdisplay = gdk_drawable_get_display (widget->window);
 730     xdisplay = GDK_WINDOW_XDISPLAY (widget->window);
 731
 732     property = gdk_x11_get_xatom_by_name_for_display (gdkdisplay, "_NET_WM_WINDOW_TYPE");
 733     window_type = XInternAtom (xdisplay, "_HILDON_WM_WINDOW_TYPE_APP_MENU", False);
 734     XChangeProperty (xdisplay, GDK_WINDOW_XID (widget->window), property,
 735                      XA_ATOM, 32, PropModeReplace, (guchar *) &window_type, 1);
 736
 737     /* Detect any screen changes */
 738     screen = gtk_widget_get_screen (widget);
 739     g_signal_connect (screen, "size-changed", G_CALLBACK (screen_size_changed), widget);
 740
 741     /* Force menu to set the initial layout */
 742     screen_size_changed (screen, HILDON_APP_MENU (widget));
 743 }
 744
 745 static void
 746 hildon_app_menu_unrealize                       (GtkWidget *widget)
 747 {
 748     GdkScreen *screen = gtk_widget_get_screen (widget);
 749     /* Disconnect "size-changed" signal handler */
 750     g_signal_handlers_disconnect_by_func (screen, G_CALLBACK (screen_size_changed), widget);
 751
 752     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unrealize (widget);
 753 }
 754
 755 static void
 756 hildon_app_menu_apply_style                     (GtkWidget *widget)
 757 {
 758     GdkScreen *screen;
 759     gint width;
 760     guint horizontal_spacing, vertical_spacing, filter_vertical_spacing;
 761     guint inner_border, external_border;
 762     HildonAppMenuPrivate *priv;
 763
 764     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 765
 766     gtk_widget_style_get (widget,
 767                           "horizontal-spacing", &horizontal_spacing,
 768                           "vertical-spacing", &vertical_spacing,
 769                           "filter-vertical-spacing", &filter_vertical_spacing,
 770                           "inner-border", &inner_border,
 771                           "external-border", &external_border,
 772                           NULL);
 773
 774     /* Set spacings */
 775     gtk_table_set_row_spacings (priv->table, vertical_spacing);
 776     gtk_table_set_col_spacings (priv->table, horizontal_spacing);
 777     gtk_box_set_spacing (priv->vbox, filter_vertical_spacing);
 778
 779     /* Set inner border */
 780     gtk_container_set_border_width (GTK_CONTAINER (widget), inner_border);
 781
 782     /* Set default size */
 783     screen = gtk_widget_get_screen (widget);
 784     width = gdk_screen_get_width (screen) - external_border * 2;
 785     gtk_window_set_default_size (GTK_WINDOW (widget), width, -1);
 786 }
 787
 788 static void
 789 hildon_app_menu_style_set                       (GtkWidget *widget,
 790                                                  GtkStyle  *previous_style)
 791 {
 792     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set)
 793         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set (widget, previous_style);
 794
 795     hildon_app_menu_apply_style (widget);
 796 }
 797
 798 static void
 799 hildon_app_menu_repack_filters                  (HildonAppMenu *menu)
 800 {
 801     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 802     GList *iter;
 803
 804     for (iter = priv->filters; iter != NULL; iter = iter->next) {
 805         GtkWidget *filter = GTK_WIDGET (iter->data);
 806         GtkWidget *parent = gtk_widget_get_parent (filter);
 807         if (parent) {
 808             g_object_ref (filter);
 809             gtk_container_remove (GTK_CONTAINER (parent), filter);
 810         }
 811     }
 812
 813     for (iter = priv->filters; iter != NULL; iter = iter->next) {
 814         GtkWidget *filter = GTK_WIDGET (iter->data);
 815         if (GTK_WIDGET_VISIBLE (filter)) {
 816             gtk_box_pack_start (GTK_BOX (priv->filters_hbox), filter, TRUE, TRUE, 0);
 817             g_object_unref (filter);
 818             /* GtkButton must be realized for accelerators to work */
 819             gtk_widget_realize (filter);
 820         }
 821     }
 822 }
 823
 824 /*
 825  * When items displayed in the menu change (e.g, a new item is added,
 826  * an item is hidden or the list is reordered), the layout must be
 827  * updated. To do this we repack all items starting from a given one.
 828  */
 829 static void
 830 hildon_app_menu_repack_items                    (HildonAppMenu *menu,
 831                                                  gint           start_from)
 832 {
 833     HildonAppMenuPrivate *priv;
 834     gint row, col;
 835     GList *iter;
 836
 837     priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 838
 839     /* Remove buttons from their parent */
 840     if (start_from != -1) {
 841         for (iter = g_list_nth (priv->buttons, start_from); iter != NULL; iter = iter->next) {
 842             GtkWidget *item = GTK_WIDGET (iter->data);
 843             GtkWidget *parent = gtk_widget_get_parent (item);
 844             if (parent) {
 845                 g_object_ref (item);
 846                 gtk_container_remove (GTK_CONTAINER (parent), item);
 847             }
 848         }
 849
 850         /* If items have been removed, recalculate the size of the menu */
 851         gtk_window_resize (GTK_WINDOW (menu), 1, 1);
 852     }
 853
 854     /* Add buttons */
 855     row = col = 0;
 856     for (iter = priv->buttons; iter != NULL; iter = iter->next) {
 857         GtkWidget *item = GTK_WIDGET (iter->data);
 858         if (GTK_WIDGET_VISIBLE (item)) {
 859             /* Don't add an item to the table if it's already there */
 860             if (gtk_widget_get_parent (item) == NULL) {
 861                 gtk_table_attach_defaults (priv->table, item, col, col + 1, row, row + 1);
 862                 g_object_unref (item);
 863                 /* GtkButton must be realized for accelerators to work */
 864                 gtk_widget_realize (item);
 865             }
 866             if (++col == priv->columns) {
 867                 col = 0;
 868                 row++;
 869             }
 870         }
 871     }
 872
 873     /* The number of rows/columns might have changed, so we have to
 874      * resize the table */
 875     if (col == 0) {
 876         gtk_table_resize (priv->table, MAX (row, 1), priv->columns);
 877     } else {
 878         gtk_table_resize (priv->table, row + 1, priv->columns);
 879     }
 880
 881     if (GTK_WIDGET_VISIBLE (GTK_WIDGET (menu))) {
 882         gtk_window_reshow_with_initial_size (GTK_WINDOW (menu));
 883     }
 884 }
 885
 886 /**
 887  * hildon_app_menu_popup:
 888  * @menu: a #HildonAppMenu
 889  * @parent_window: a #GtkWindow
 890  *
 891  * Displays a menu on top of a window and makes it available for
 892  * selection.
 893  *
 894  * Since: 2.2
 895  **/
 896 void
 897 hildon_app_menu_popup                           (HildonAppMenu *menu,
 898                                                  GtkWindow     *parent_window)
 899 {
 900     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 901     g_return_if_fail (GTK_IS_WINDOW (parent_window));
 902
 903     hildon_app_menu_set_parent_window (menu, parent_window);
 904     gtk_widget_show (GTK_WIDGET (menu));
 905 }
 906
 907 /**
 908  * hildon_app_menu_get_items:
 909  * @menu: a #HildonAppMenu
 910  *
 911  * Returns a list of all items (regular items, not filters) contained
 912  * in @menu.
 913  *
 914  * Returns: a newly-allocated list containing the items in @menu
 915  *
 916  * Since: 2.2
 917  **/
 918 GList *
 919 hildon_app_menu_get_items                       (HildonAppMenu *menu)
 920 {
 921     HildonAppMenuPrivate *priv;
 922
 923     g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
 924
 925     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 926
 927     return g_list_copy (priv->buttons);
 928 }
 929
 930 /**
 931  * hildon_app_menu_get_filters:
 932  * @menu: a #HildonAppMenu
 933  *
 934  * Returns a list of all filters contained in @menu.
 935  *
 936  * Returns: a newly-allocated list containing the filters in @menu
 937  *
 938  * Since: 2.2
 939  **/
 940 GList *
 941 hildon_app_menu_get_filters                     (HildonAppMenu *menu)
 942 {
 943     HildonAppMenuPrivate *priv;
 944
 945     g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
 946
 947     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 948
 949     return g_list_copy (priv->filters);
 950 }
 951
 952 static void
 953 hildon_app_menu_init                            (HildonAppMenu *menu)
 954 {
 955     GtkWidget *alignment;
 956     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 957
 958     /* Initialize private variables */
 959     priv->parent_window = NULL;
 960     priv->transfer_window = NULL;
 961     priv->pressed_outside = FALSE;
 962     priv->buttons = NULL;
 963     priv->filters = NULL;
 964     priv->columns = 2;
 965
 966     /* Create boxes and tables */
 967     priv->filters_hbox = GTK_BOX (gtk_hbox_new (TRUE, 0));
 968     priv->vbox = GTK_BOX (gtk_vbox_new (FALSE, 0));
 969     priv->table = GTK_TABLE (gtk_table_new (1, priv->columns, TRUE));
 970
 971     /* Align the filters to the center */
 972     alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
 973     gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (priv->filters_hbox));
 974
 975     /* Pack everything */
 976     gtk_container_add (GTK_CONTAINER (menu), GTK_WIDGET (priv->vbox));
 977     gtk_box_pack_start (priv->vbox, alignment, TRUE, TRUE, 0);
 978     gtk_box_pack_start (priv->vbox, GTK_WIDGET (priv->table), TRUE, TRUE, 0);
 979
 980     /* Make menu a modal window */
 981     gtk_window_set_modal (GTK_WINDOW (menu), TRUE);
 982
 983     /* This should be treated like a normal, ref-counted widget */
 984     g_object_force_floating (G_OBJECT (menu));
 985     GTK_WINDOW (menu)->has_user_ref_count = FALSE;
 986
 987     gtk_widget_show_all (GTK_WIDGET (priv->vbox));
 988 }
 989
 990 static void
 991 hildon_app_menu_finalize                        (GObject *object)
 992 {
 993     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(object);
 994
 995     if (priv->parent_window) {
 996         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_topmost_notify, object);
 997         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_unmapped, object);
 998     }
 999
1000     if (priv->transfer_window)
1001         gdk_window_destroy (priv->transfer_window);
1002
1003     g_list_foreach (priv->buttons, (GFunc) g_object_unref, NULL);
1004     g_list_foreach (priv->filters, (GFunc) g_object_unref, NULL);
1005
1006     g_list_free (priv->buttons);
1007     g_list_free (priv->filters);
1008
1009     g_signal_handlers_destroy (object);
1010     G_OBJECT_CLASS (hildon_app_menu_parent_class)->finalize (object);
1011 }
1012
1013 static void
1014 hildon_app_menu_class_init                      (HildonAppMenuClass *klass)
1015 {
1016     GObjectClass *gobject_class = (GObjectClass *)klass;
1017     GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
1018
1019     gobject_class->finalize = hildon_app_menu_finalize;
1020     widget_class->show = hildon_app_menu_show;
1021     widget_class->show_all = hildon_app_menu_show_all;
1022     widget_class->hide_all = hildon_app_menu_hide_all;
1023     widget_class->map = hildon_app_menu_map;
1024     widget_class->unmap = hildon_app_menu_unmap;
1025     widget_class->realize = hildon_app_menu_realize;
1026     widget_class->unrealize = hildon_app_menu_unrealize;
1027     widget_class->grab_notify = hildon_app_menu_grab_notify;
1028     widget_class->key_press_event = hildon_app_menu_key_press;
1029     widget_class->button_press_event = hildon_app_menu_button_press;
1030     widget_class->button_release_event = hildon_app_menu_button_release;
1031     widget_class->style_set = hildon_app_menu_style_set;
1032
1033     g_type_class_add_private (klass, sizeof (HildonAppMenuPrivate));
1034
1035     gtk_widget_class_install_style_property (
1036         widget_class,
1037         g_param_spec_uint (
1038             "horizontal-spacing",
1039             "Horizontal spacing on menu items",
1040             "Horizontal spacing between each menu item. Does not apply to filter buttons.",
1041             0, G_MAXUINT, 16,
1042             G_PARAM_READABLE));
1043
1044     gtk_widget_class_install_style_property (
1045         widget_class,
1046         g_param_spec_uint (
1047             "vertical-spacing",
1048             "Vertical spacing on menu items",
1049             "Vertical spacing between each menu item. Does not apply to filter buttons.",
1050             0, G_MAXUINT, 16,
1051             G_PARAM_READABLE));
1052
1053     gtk_widget_class_install_style_property (
1054         widget_class,
1055         g_param_spec_uint (
1056             "filter-vertical-spacing",
1057             "Vertical spacing between filters and menu items",
1058             "Vertical spacing between filters and menu items",
1059             0, G_MAXUINT, 8,
1060             G_PARAM_READABLE));
1061
1062     gtk_widget_class_install_style_property (
1063         widget_class,
1064         g_param_spec_uint (
1065             "inner-border",
1066             "Border between menu edges and buttons",
1067             "Border between menu edges and buttons",
1068             0, G_MAXUINT, 16,
1069             G_PARAM_READABLE));
1070
1071     gtk_widget_class_install_style_property (
1072         widget_class,
1073         g_param_spec_uint (
1074             "external-border",
1075             "Border between menu and screen edges",
1076             "Border between the right and left edges of the menu and the screen edges",
1077             0, G_MAXUINT, 40,
1078             G_PARAM_READABLE));
1079 }