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