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     priv->find_intruder_idle_id = 0;
 474
 475     /* If there's a window between the menu and its parent window, hide the menu */
 476     if (priv->parent_window) {
 477         gboolean intruder_found = FALSE;
 478         GdkScreen *screen = gtk_widget_get_screen (widget);
 479         GList *stack = gdk_screen_get_window_stack (screen);
 480         GList *parent_pos = g_list_find (stack, GTK_WIDGET (priv->parent_window)->window);
 481         GList *toplevels = gtk_window_list_toplevels ();
 482         GList *i;
 483
 484         for (i = toplevels; i != NULL && !intruder_found; i = i->next) {
 485             if (i->data != widget && i->data != priv->parent_window) {
 486                 if (g_list_find (parent_pos, GTK_WIDGET (i->data)->window)) {
 487                     intruder_found = TRUE;
 488                 }
 489             }
 490         }
 491
 492         g_list_foreach (stack, (GFunc) g_object_unref, NULL);
 493         g_list_free (stack);
 494         g_list_free (toplevels);
 495
 496         if (intruder_found)
 497             gtk_widget_hide (widget);
 498     }
 499
 500     return FALSE;
 501 }
 502
 503 static void
 504 hildon_app_menu_map                             (GtkWidget *widget)
 505 {
 506     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 507
 508     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->map (widget);
 509
 510     /* Grab pointer and keyboard */
 511     if (priv->transfer_window == NULL) {
 512         gboolean has_grab = FALSE;
 513
 514         priv->transfer_window = grab_transfer_window_get (widget);
 515
 516         if (gdk_pointer_grab (priv->transfer_window, TRUE,
 517                               GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
 518                               GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
 519                               GDK_POINTER_MOTION_MASK, NULL, NULL,
 520                               GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
 521             if (gdk_keyboard_grab (priv->transfer_window, TRUE,
 522                                    GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
 523                 has_grab = TRUE;
 524             } else {
 525                 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
 526                                             GDK_CURRENT_TIME);
 527             }
 528         }
 529
 530         if (has_grab) {
 531             gtk_grab_add (widget);
 532         } else {
 533             gdk_window_destroy (priv->transfer_window);
 534             priv->transfer_window = NULL;
 535         }
 536     }
 537
 538     /* Make the menu temporary when it's mapped, so it's closed if a
 539      * new window appears */
 540     gtk_window_set_is_temporary (GTK_WINDOW (widget), TRUE);
 541
 542     priv->find_intruder_idle_id = gdk_threads_add_idle (hildon_app_menu_find_intruder, widget);
 543 }
 544
 545 static void
 546 hildon_app_menu_unmap                           (GtkWidget *widget)
 547 {
 548     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 549
 550     /* Remove the grab */
 551     if (priv->transfer_window != NULL) {
 552         gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
 553                                     GDK_CURRENT_TIME);
 554         gtk_grab_remove (widget);
 555
 556         gdk_window_destroy (priv->transfer_window);
 557         priv->transfer_window = NULL;
 558     }
 559
 560     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unmap (widget);
 561
 562     gtk_window_set_is_temporary (GTK_WINDOW (widget), FALSE);
 563 }
 564
 565 static void
 566 hildon_app_menu_grab_notify                     (GtkWidget *widget,
 567                                                  gboolean   was_grabbed)
 568 {
 569     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify)
 570         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify (widget, was_grabbed);
 571
 572     if (!was_grabbed && GTK_WIDGET_VISIBLE (widget))
 573         gtk_widget_hide (widget);
 574 }
 575
 576 static gboolean
 577 hildon_app_menu_hide_idle                       (gpointer widget)
 578 {
 579     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 580     gtk_widget_hide (GTK_WIDGET (widget));
 581     priv->hide_idle_id = 0;
 582     return FALSE;
 583 }
 584
 585 /* Send keyboard accelerators to the parent window, if necessary.
 586  * This code is heavily based on gtk_menu_key_press ()
 587  */
 588 static gboolean
 589 hildon_app_menu_key_press                       (GtkWidget   *widget,
 590                                                  GdkEventKey *event)
 591 {
 592     GtkWindow *parent_window;
 593     HildonAppMenuPrivate *priv;
 594
 595     g_return_val_if_fail (HILDON_IS_APP_MENU (widget), FALSE);
 596     g_return_val_if_fail (event != NULL, FALSE);
 597
 598     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->key_press_event (widget, event))
 599         return TRUE;
 600
 601     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 602     parent_window = priv->parent_window;
 603
 604     if (parent_window) {
 605         guint accel_key, accel_mods;
 606         GdkModifierType consumed_modifiers;
 607         GdkDisplay *display;
 608         GSList *accel_groups;
 609         GSList *list;
 610
 611         display = gtk_widget_get_display (widget);
 612
 613         /* Figure out what modifiers went into determining the key symbol */
 614         gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
 615                                              event->hardware_keycode, event->state, event->group,
 616                                              NULL, NULL, NULL, &consumed_modifiers);
 617
 618         accel_key = gdk_keyval_to_lower (event->keyval);
 619         accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
 620
 621         /* If lowercasing affects the keysym, then we need to include SHIFT in the modifiers,
 622          * We re-upper case when we match against the keyval, but display and save in caseless form.
 623          */
 624         if (accel_key != event->keyval)
 625             accel_mods |= GDK_SHIFT_MASK;
 626
 627         accel_groups = gtk_accel_groups_from_object (G_OBJECT (parent_window));
 628
 629         for (list = accel_groups; list; list = list->next) {
 630             GtkAccelGroup *accel_group = list->data;
 631
 632             if (gtk_accel_group_query (accel_group, accel_key, accel_mods, NULL)) {
 633                 gtk_window_activate_key (parent_window, event);
 634                 priv->hide_idle_id = gdk_threads_add_idle (hildon_app_menu_hide_idle, widget);
 635                 break;
 636             }
 637         }
 638     }
 639
 640     return TRUE;
 641 }
 642
 643 static gboolean
 644 hildon_app_menu_button_press                    (GtkWidget *widget,
 645                                                  GdkEventButton *event)
 646 {
 647     int x, y;
 648     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 649
 650     gdk_window_get_position (widget->window, &x, &y);
 651
 652     /* Whether the button has been pressed outside the widget */
 653     priv->pressed_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
 654                              event->y_root < y || event->y_root > y + widget->allocation.height);
 655
 656     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event) {
 657         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event (widget, event);
 658     } else {
 659         return FALSE;
 660     }
 661 }
 662
 663 static gboolean
 664 hildon_app_menu_button_release                  (GtkWidget *widget,
 665                                                  GdkEventButton *event)
 666 {
 667     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
 668
 669     if (priv->pressed_outside) {
 670         int x, y;
 671         gboolean released_outside;
 672
 673         gdk_window_get_position (widget->window, &x, &y);
 674
 675         /* Whether the button has been released outside the widget */
 676         released_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
 677                             event->y_root < y || event->y_root > y + widget->allocation.height);
 678
 679         if (released_outside) {
 680             gtk_widget_hide (widget);
 681         }
 682
 683         priv->pressed_outside = FALSE; /* Always reset pressed_outside to FALSE */
 684     }
 685
 686     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event) {
 687         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event (widget, event);
 688     } else {
 689         return FALSE;
 690     }
 691 }
 692
 693 static gboolean
 694 hildon_app_menu_delete_event_handler            (GtkWidget   *widget,
 695                                                  GdkEventAny *event)
 696 {
 697     /* Hide the menu if it receives a delete-event, but don't destroy it */
 698     gtk_widget_hide (widget);
 699     return TRUE;
 700 }
 701
 702 /* Grab transfer window (based on the one from GtkMenu) */
 703 static GdkWindow *
 704 grab_transfer_window_get                        (GtkWidget *widget)
 705 {
 706     GdkWindow *window;
 707     GdkWindowAttr attributes;
 708     gint attributes_mask;
 709
 710     attributes.x = 0;
 711     attributes.y = 0;
 712     attributes.width = 10;
 713     attributes.height = 10;
 714     attributes.window_type = GDK_WINDOW_TEMP;
 715     attributes.wclass = GDK_INPUT_ONLY;
 716     attributes.override_redirect = TRUE;
 717     attributes.event_mask = 0;
 718
 719     attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
 720
 721     window = gdk_window_new (gtk_widget_get_root_window (widget),
 722                                  &attributes, attributes_mask);
 723     gdk_window_set_user_data (window, widget);
 724
 725     gdk_window_show (window);
 726
 727     return window;
 728 }
 729
 730 static void
 731 hildon_app_menu_size_request                    (GtkWidget      *widget,
 732                                                  GtkRequisition *requisition)
 733 {
 734     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 735
 736     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->size_request (widget, requisition);
 737
 738     requisition->width = priv->width_request;
 739 }
 740
 741 static void
 742 hildon_app_menu_realize                         (GtkWidget *widget)
 743 {
 744     Atom property, window_type;
 745     Display *xdisplay;
 746     GdkDisplay *gdkdisplay;
 747     GdkScreen *screen;
 748
 749     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->realize (widget);
 750
 751     gdk_window_set_decorations (widget->window, GDK_DECOR_BORDER);
 752
 753     gdkdisplay = gdk_drawable_get_display (widget->window);
 754     xdisplay = GDK_WINDOW_XDISPLAY (widget->window);
 755
 756     property = gdk_x11_get_xatom_by_name_for_display (gdkdisplay, "_NET_WM_WINDOW_TYPE");
 757     window_type = XInternAtom (xdisplay, "_HILDON_WM_WINDOW_TYPE_APP_MENU", False);
 758     XChangeProperty (xdisplay, GDK_WINDOW_XID (widget->window), property,
 759                      XA_ATOM, 32, PropModeReplace, (guchar *) &window_type, 1);
 760
 761     /* Detect any screen changes */
 762     screen = gtk_widget_get_screen (widget);
 763     g_signal_connect (screen, "size-changed", G_CALLBACK (screen_size_changed), widget);
 764
 765     /* Force menu to set the initial layout */
 766     screen_size_changed (screen, HILDON_APP_MENU (widget));
 767 }
 768
 769 static void
 770 hildon_app_menu_unrealize                       (GtkWidget *widget)
 771 {
 772     GdkScreen *screen = gtk_widget_get_screen (widget);
 773     /* Disconnect "size-changed" signal handler */
 774     g_signal_handlers_disconnect_by_func (screen, G_CALLBACK (screen_size_changed), widget);
 775
 776     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unrealize (widget);
 777 }
 778
 779 static void
 780 hildon_app_menu_apply_style                     (GtkWidget *widget)
 781 {
 782     GdkScreen *screen;
 783     guint horizontal_spacing, vertical_spacing, filter_vertical_spacing;
 784     guint inner_border, external_border;
 785     HildonAppMenuPrivate *priv;
 786
 787     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
 788
 789     gtk_widget_style_get (widget,
 790                           "horizontal-spacing", &horizontal_spacing,
 791                           "vertical-spacing", &vertical_spacing,
 792                           "filter-vertical-spacing", &filter_vertical_spacing,
 793                           "inner-border", &inner_border,
 794                           "external-border", &external_border,
 795                           NULL);
 796
 797     /* Set spacings */
 798     gtk_table_set_row_spacings (priv->table, vertical_spacing);
 799     gtk_table_set_col_spacings (priv->table, horizontal_spacing);
 800     gtk_box_set_spacing (priv->vbox, filter_vertical_spacing);
 801
 802     /* Set inner border */
 803     gtk_container_set_border_width (GTK_CONTAINER (widget), inner_border);
 804
 805     /* Compute width request */
 806     screen = gtk_widget_get_screen (widget);
 807     if (gdk_screen_get_width (screen) < gdk_screen_get_height (screen)) {
 808         external_border = 0;
 809     }
 810     priv->width_request = gdk_screen_get_width (screen) - external_border * 2;
 811     gtk_window_move (GTK_WINDOW (widget), external_border, 0);
 812     gtk_widget_queue_resize (widget);
 813 }
 814
 815 static void
 816 hildon_app_menu_style_set                       (GtkWidget *widget,
 817                                                  GtkStyle  *previous_style)
 818 {
 819     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set)
 820         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set (widget, previous_style);
 821
 822     hildon_app_menu_apply_style (widget);
 823 }
 824
 825 static void
 826 hildon_app_menu_repack_filters                  (HildonAppMenu *menu)
 827 {
 828     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 829     GList *iter;
 830
 831     for (iter = priv->filters; iter != NULL; iter = iter->next) {
 832         GtkWidget *filter = GTK_WIDGET (iter->data);
 833         GtkWidget *parent = gtk_widget_get_parent (filter);
 834         if (parent) {
 835             g_object_ref (filter);
 836             gtk_container_remove (GTK_CONTAINER (parent), filter);
 837         }
 838     }
 839
 840     for (iter = priv->filters; iter != NULL; iter = iter->next) {
 841         GtkWidget *filter = GTK_WIDGET (iter->data);
 842         if (GTK_WIDGET_VISIBLE (filter)) {
 843             gtk_box_pack_start (GTK_BOX (priv->filters_hbox), filter, TRUE, TRUE, 0);
 844             g_object_unref (filter);
 845             /* GtkButton must be realized for accelerators to work */
 846             gtk_widget_realize (filter);
 847         }
 848     }
 849 }
 850
 851 /*
 852  * When items displayed in the menu change (e.g, a new item is added,
 853  * an item is hidden or the list is reordered), the layout must be
 854  * updated. To do this we repack all items starting from a given one.
 855  */
 856 static void
 857 hildon_app_menu_repack_items                    (HildonAppMenu *menu,
 858                                                  gint           start_from)
 859 {
 860     HildonAppMenuPrivate *priv;
 861     gint row, col;
 862     GList *iter;
 863
 864     priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 865
 866     /* Remove buttons from their parent */
 867     if (start_from != -1) {
 868         for (iter = g_list_nth (priv->buttons, start_from); iter != NULL; iter = iter->next) {
 869             GtkWidget *item = GTK_WIDGET (iter->data);
 870             GtkWidget *parent = gtk_widget_get_parent (item);
 871             if (parent) {
 872                 g_object_ref (item);
 873                 gtk_container_remove (GTK_CONTAINER (parent), item);
 874             }
 875         }
 876
 877         /* If items have been removed, recalculate the size of the menu */
 878         gtk_window_resize (GTK_WINDOW (menu), 1, 1);
 879     }
 880
 881     /* Add buttons */
 882     row = col = 0;
 883     for (iter = priv->buttons; iter != NULL; iter = iter->next) {
 884         GtkWidget *item = GTK_WIDGET (iter->data);
 885         if (GTK_WIDGET_VISIBLE (item)) {
 886             /* Don't add an item to the table if it's already there */
 887             if (gtk_widget_get_parent (item) == NULL) {
 888                 gtk_table_attach_defaults (priv->table, item, col, col + 1, row, row + 1);
 889                 g_object_unref (item);
 890                 /* GtkButton must be realized for accelerators to work */
 891                 gtk_widget_realize (item);
 892             }
 893             if (++col == priv->columns) {
 894                 col = 0;
 895                 row++;
 896             }
 897         }
 898     }
 899
 900     /* The number of rows/columns might have changed, so we have to
 901      * resize the table */
 902     if (col == 0) {
 903         gtk_table_resize (priv->table, MAX (row, 1), priv->columns);
 904     } else {
 905         gtk_table_resize (priv->table, row + 1, priv->columns);
 906     }
 907 }
 908
 909 /**
 910  * hildon_app_menu_popup:
 911  * @menu: a #HildonAppMenu
 912  * @parent_window: a #GtkWindow
 913  *
 914  * Displays a menu on top of a window and makes it available for
 915  * selection.
 916  *
 917  * Since: 2.2
 918  **/
 919 void
 920 hildon_app_menu_popup                           (HildonAppMenu *menu,
 921                                                  GtkWindow     *parent_window)
 922 {
 923     g_return_if_fail (HILDON_IS_APP_MENU (menu));
 924     g_return_if_fail (GTK_IS_WINDOW (parent_window));
 925
 926     hildon_app_menu_set_parent_window (menu, parent_window);
 927     gtk_widget_show (GTK_WIDGET (menu));
 928 }
 929
 930 /**
 931  * hildon_app_menu_get_items:
 932  * @menu: a #HildonAppMenu
 933  *
 934  * Returns a list of all items (regular items, not filters) contained
 935  * in @menu.
 936  *
 937  * Returns: a newly-allocated list containing the items in @menu
 938  *
 939  * Since: 2.2
 940  **/
 941 GList *
 942 hildon_app_menu_get_items                       (HildonAppMenu *menu)
 943 {
 944     HildonAppMenuPrivate *priv;
 945
 946     g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
 947
 948     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 949
 950     return g_list_copy (priv->buttons);
 951 }
 952
 953 /**
 954  * hildon_app_menu_get_filters:
 955  * @menu: a #HildonAppMenu
 956  *
 957  * Returns a list of all filters contained in @menu.
 958  *
 959  * Returns: a newly-allocated list containing the filters in @menu
 960  *
 961  * Since: 2.2
 962  **/
 963 GList *
 964 hildon_app_menu_get_filters                     (HildonAppMenu *menu)
 965 {
 966     HildonAppMenuPrivate *priv;
 967
 968     g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
 969
 970     priv = HILDON_APP_MENU_GET_PRIVATE (menu);
 971
 972     return g_list_copy (priv->filters);
 973 }
 974
 975 static void
 976 hildon_app_menu_init                            (HildonAppMenu *menu)
 977 {
 978     GtkWidget *alignment;
 979     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
 980
 981     /* Initialize private variables */
 982     priv->parent_window = NULL;
 983     priv->transfer_window = NULL;
 984     priv->pressed_outside = FALSE;
 985     priv->buttons = NULL;
 986     priv->filters = NULL;
 987     priv->columns = 2;
 988     priv->width_request = -1;
 989     priv->find_intruder_idle_id = 0;
 990     priv->hide_idle_id = 0;
 991
 992     /* Create boxes and tables */
 993     priv->filters_hbox = GTK_BOX (gtk_hbox_new (TRUE, 0));
 994     priv->vbox = GTK_BOX (gtk_vbox_new (FALSE, 0));
 995     priv->table = GTK_TABLE (gtk_table_new (1, priv->columns, TRUE));
 996
 997     /* Align the filters to the center */
 998     alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
 999     gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (priv->filters_hbox));
1000
1001     /* Pack everything */
1002     gtk_container_add (GTK_CONTAINER (menu), GTK_WIDGET (priv->vbox));
1003     gtk_box_pack_start (priv->vbox, alignment, TRUE, TRUE, 0);
1004     gtk_box_pack_start (priv->vbox, GTK_WIDGET (priv->table), TRUE, TRUE, 0);
1005
1006     /* Make menu a modal window */
1007     gtk_window_set_modal (GTK_WINDOW (menu), TRUE);
1008
1009     /* This should be treated like a normal, ref-counted widget */
1010     g_object_force_floating (G_OBJECT (menu));
1011     GTK_WINDOW (menu)->has_user_ref_count = FALSE;
1012
1013     gtk_widget_show_all (GTK_WIDGET (priv->vbox));
1014 }
1015
1016 static void
1017 hildon_app_menu_finalize                        (GObject *object)
1018 {
1019     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(object);
1020
1021     if (priv->find_intruder_idle_id) {
1022         g_source_remove (priv->find_intruder_idle_id);
1023         priv->find_intruder_idle_id = 0;
1024     }
1025
1026     if (priv->hide_idle_id) {
1027         g_source_remove (priv->hide_idle_id);
1028         priv->hide_idle_id = 0;
1029     }
1030
1031     if (priv->parent_window) {
1032         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_topmost_notify, object);
1033         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_unmapped, object);
1034     }
1035
1036     if (priv->transfer_window)
1037         gdk_window_destroy (priv->transfer_window);
1038
1039     g_list_foreach (priv->buttons, (GFunc) g_object_unref, NULL);
1040     g_list_foreach (priv->filters, (GFunc) g_object_unref, NULL);
1041
1042     g_list_free (priv->buttons);
1043     g_list_free (priv->filters);
1044
1045     g_signal_handlers_destroy (object);
1046     G_OBJECT_CLASS (hildon_app_menu_parent_class)->finalize (object);
1047 }
1048
1049 static void
1050 hildon_app_menu_class_init                      (HildonAppMenuClass *klass)
1051 {
1052     GObjectClass *gobject_class = (GObjectClass *)klass;
1053     GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
1054
1055     gobject_class->finalize = hildon_app_menu_finalize;
1056     widget_class->show = hildon_app_menu_show;
1057     widget_class->show_all = hildon_app_menu_show_all;
1058     widget_class->hide_all = hildon_app_menu_hide_all;
1059     widget_class->map = hildon_app_menu_map;
1060     widget_class->unmap = hildon_app_menu_unmap;
1061     widget_class->realize = hildon_app_menu_realize;
1062     widget_class->unrealize = hildon_app_menu_unrealize;
1063     widget_class->grab_notify = hildon_app_menu_grab_notify;
1064     widget_class->key_press_event = hildon_app_menu_key_press;
1065     widget_class->button_press_event = hildon_app_menu_button_press;
1066     widget_class->button_release_event = hildon_app_menu_button_release;
1067     widget_class->style_set = hildon_app_menu_style_set;
1068     widget_class->delete_event = hildon_app_menu_delete_event_handler;
1069     widget_class->size_request = hildon_app_menu_size_request;
1070
1071     g_type_class_add_private (klass, sizeof (HildonAppMenuPrivate));
1072
1073     gtk_widget_class_install_style_property (
1074         widget_class,
1075         g_param_spec_uint (
1076             "horizontal-spacing",
1077             "Horizontal spacing on menu items",
1078             "Horizontal spacing between each menu item. Does not apply to filter buttons.",
1079             0, G_MAXUINT, 16,
1080             G_PARAM_READABLE));
1081
1082     gtk_widget_class_install_style_property (
1083         widget_class,
1084         g_param_spec_uint (
1085             "vertical-spacing",
1086             "Vertical spacing on menu items",
1087             "Vertical spacing between each menu item. Does not apply to filter buttons.",
1088             0, G_MAXUINT, 16,
1089             G_PARAM_READABLE));
1090
1091     gtk_widget_class_install_style_property (
1092         widget_class,
1093         g_param_spec_uint (
1094             "filter-vertical-spacing",
1095             "Vertical spacing between filters and menu items",
1096             "Vertical spacing between filters and menu items",
1097             0, G_MAXUINT, 8,
1098             G_PARAM_READABLE));
1099
1100     gtk_widget_class_install_style_property (
1101         widget_class,
1102         g_param_spec_uint (
1103             "inner-border",
1104             "Border between menu edges and buttons",
1105             "Border between menu edges and buttons",
1106             0, G_MAXUINT, 16,
1107             G_PARAM_READABLE));
1108
1109     gtk_widget_class_install_style_property (
1110         widget_class,
1111         g_param_spec_uint (
1112             "external-border",
1113             "Border between menu and screen edges (in horizontal mode)",
1114             "Border between the right and left edges of the menu and "
1115             "the screen edges (in horizontal mode)",
1116             0, G_MAXUINT, 50,
1117             G_PARAM_READABLE));
1118 }