2009-02-23 Alejandro G. Castro <alex@igalia.com>
[hildon] / 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_main_menu(). The menu will appear when
37  * the user presses the window title bar. Alternatively, you can show
38  * it by hand using gtk_widget_show().
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_main_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     /* Don't show menu if its parent window is not the topmost one */
438     if (show_menu && priv->parent_window) {
439         show_menu =
440             GTK_WIDGET_VISIBLE (priv->parent_window) &&
441             hildon_window_get_is_topmost (HILDON_WINDOW (priv->parent_window));
442     }
443
444     if (show_menu) {
445         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->show (widget);
446     }
447 }
448
449 static void
450 hildon_app_menu_show_all                        (GtkWidget *widget)
451 {
452     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
453
454     /* Show children, but not self. */
455     g_list_foreach (priv->buttons, (GFunc) gtk_widget_show_all, NULL);
456     g_list_foreach (priv->filters, (GFunc) gtk_widget_show_all, NULL);
457 }
458
459
460 static void
461 hildon_app_menu_hide_all                        (GtkWidget *widget)
462 {
463     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE (widget);
464
465     /* Hide children, but not self. */
466     g_list_foreach (priv->buttons, (GFunc) gtk_widget_hide_all, NULL);
467     g_list_foreach (priv->filters, (GFunc) gtk_widget_hide_all, NULL);
468 }
469
470
471 static void
472 hildon_app_menu_map                             (GtkWidget *widget)
473 {
474     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
475
476     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->map (widget);
477
478     /* Grab pointer and keyboard */
479     if (priv->transfer_window == NULL) {
480         gboolean has_grab = FALSE;
481
482         priv->transfer_window = grab_transfer_window_get (widget);
483
484         if (gdk_pointer_grab (priv->transfer_window, TRUE,
485                               GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
486                               GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
487                               GDK_POINTER_MOTION_MASK, NULL, NULL,
488                               GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
489             if (gdk_keyboard_grab (priv->transfer_window, TRUE,
490                                    GDK_CURRENT_TIME) == GDK_GRAB_SUCCESS) {
491                 has_grab = TRUE;
492             } else {
493                 gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
494                                             GDK_CURRENT_TIME);
495             }
496         }
497
498         if (has_grab) {
499             gtk_grab_add (widget);
500         } else {
501             gdk_window_destroy (priv->transfer_window);
502             priv->transfer_window = NULL;
503         }
504     }
505 }
506
507 static void
508 hildon_app_menu_unmap                           (GtkWidget *widget)
509 {
510     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
511
512     /* Remove the grab */
513     if (priv->transfer_window != NULL) {
514         gdk_display_pointer_ungrab (gtk_widget_get_display (widget),
515                                     GDK_CURRENT_TIME);
516         gtk_grab_remove (widget);
517
518         gdk_window_destroy (priv->transfer_window);
519         priv->transfer_window = NULL;
520     }
521
522     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unmap (widget);
523 }
524
525 static void
526 hildon_app_menu_grab_notify                     (GtkWidget *widget,
527                                                  gboolean   was_grabbed)
528 {
529     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify)
530         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->grab_notify (widget, was_grabbed);
531
532     if (!was_grabbed && GTK_WIDGET_VISIBLE (widget))
533         gtk_widget_hide (widget);
534 }
535
536 static gboolean
537 hildon_app_menu_hide_idle                       (gpointer widget)
538 {
539     gtk_widget_hide (GTK_WIDGET (widget));
540     return FALSE;
541 }
542
543 /* Send keyboard accelerators to the parent window, if necessary.
544  * This code is heavily based on gtk_menu_key_press ()
545  */
546 static gboolean
547 hildon_app_menu_key_press                       (GtkWidget   *widget,
548                                                  GdkEventKey *event)
549 {
550     GtkWindow *parent_window;
551     HildonAppMenuPrivate *priv;
552
553     g_return_val_if_fail (HILDON_IS_APP_MENU (widget), FALSE);
554     g_return_val_if_fail (event != NULL, FALSE);
555
556     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->key_press_event (widget, event))
557         return TRUE;
558
559     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
560     parent_window = priv->parent_window;
561
562     if (parent_window) {
563         guint accel_key, accel_mods;
564         GdkModifierType consumed_modifiers;
565         GdkDisplay *display;
566         GSList *accel_groups;
567         GSList *list;
568
569         display = gtk_widget_get_display (widget);
570
571         /* Figure out what modifiers went into determining the key symbol */
572         gdk_keymap_translate_keyboard_state (gdk_keymap_get_for_display (display),
573                                              event->hardware_keycode, event->state, event->group,
574                                              NULL, NULL, NULL, &consumed_modifiers);
575
576         accel_key = gdk_keyval_to_lower (event->keyval);
577         accel_mods = event->state & gtk_accelerator_get_default_mod_mask () & ~consumed_modifiers;
578
579         /* If lowercasing affects the keysym, then we need to include SHIFT in the modifiers,
580          * We re-upper case when we match against the keyval, but display and save in caseless form.
581          */
582         if (accel_key != event->keyval)
583             accel_mods |= GDK_SHIFT_MASK;
584
585         accel_groups = gtk_accel_groups_from_object (G_OBJECT (parent_window));
586
587         for (list = accel_groups; list; list = list->next) {
588             GtkAccelGroup *accel_group = list->data;
589
590             if (gtk_accel_group_query (accel_group, accel_key, accel_mods, NULL)) {
591                 gtk_window_activate_key (parent_window, event);
592                 gdk_threads_add_idle (hildon_app_menu_hide_idle, widget);
593                 break;
594             }
595         }
596     }
597
598     return TRUE;
599 }
600
601 static gboolean
602 hildon_app_menu_button_press                    (GtkWidget *widget,
603                                                  GdkEventButton *event)
604 {
605     int x, y;
606     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
607
608     gdk_window_get_position (widget->window, &x, &y);
609
610     /* Whether the button has been pressed outside the widget */
611     priv->pressed_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
612                              event->y_root < y || event->y_root > y + widget->allocation.height);
613
614     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event) {
615         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event (widget, event);
616     } else {
617         return FALSE;
618     }
619 }
620
621 static gboolean
622 hildon_app_menu_button_release                  (GtkWidget *widget,
623                                                  GdkEventButton *event)
624 {
625     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
626
627     if (priv->pressed_outside) {
628         int x, y;
629         gboolean released_outside;
630
631         gdk_window_get_position (widget->window, &x, &y);
632
633         /* Whether the button has been released outside the widget */
634         released_outside = (event->x_root < x || event->x_root > x + widget->allocation.width ||
635                             event->y_root < y || event->y_root > y + widget->allocation.height);
636
637         if (released_outside) {
638             gtk_widget_hide (widget);
639         }
640
641         priv->pressed_outside = FALSE; /* Always reset pressed_outside to FALSE */
642     }
643
644     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event) {
645         return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_release_event (widget, event);
646     } else {
647         return FALSE;
648     }
649 }
650
651 /* Grab transfer window (based on the one from GtkMenu) */
652 static GdkWindow *
653 grab_transfer_window_get                        (GtkWidget *widget)
654 {
655     GdkWindow *window;
656     GdkWindowAttr attributes;
657     gint attributes_mask;
658
659     attributes.x = 0;
660     attributes.y = 0;
661     attributes.width = 10;
662     attributes.height = 10;
663     attributes.window_type = GDK_WINDOW_TEMP;
664     attributes.wclass = GDK_INPUT_ONLY;
665     attributes.override_redirect = TRUE;
666     attributes.event_mask = 0;
667
668     attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
669
670     window = gdk_window_new (gtk_widget_get_root_window (widget),
671                                  &attributes, attributes_mask);
672     gdk_window_set_user_data (window, widget);
673
674     gdk_window_show (window);
675
676     return window;
677 }
678
679 static void
680 hildon_app_menu_realize                         (GtkWidget *widget)
681 {
682     Atom property, window_type;
683     Display *xdisplay;
684     GdkDisplay *gdkdisplay;
685     GdkScreen *screen;
686
687     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->realize (widget);
688
689     gdk_window_set_decorations (widget->window, GDK_DECOR_BORDER);
690
691     gdkdisplay = gdk_drawable_get_display (widget->window);
692     xdisplay = GDK_WINDOW_XDISPLAY (widget->window);
693
694     property = gdk_x11_get_xatom_by_name_for_display (gdkdisplay, "_NET_WM_WINDOW_TYPE");
695     window_type = XInternAtom (xdisplay, "_HILDON_WM_WINDOW_TYPE_APP_MENU", False);
696     XChangeProperty (xdisplay, GDK_WINDOW_XID (widget->window), property,
697                      XA_ATOM, 32, PropModeReplace, (guchar *) &window_type, 1);
698
699     /* Detect any screen changes */
700     screen = gtk_widget_get_screen (widget);
701     g_signal_connect (screen, "size-changed", G_CALLBACK (screen_size_changed), widget);
702
703     /* Force menu to set the initial layout */
704     screen_size_changed (screen, HILDON_APP_MENU (widget));
705 }
706
707 static void
708 hildon_app_menu_unrealize                       (GtkWidget *widget)
709 {
710     GdkScreen *screen = gtk_widget_get_screen (widget);
711     /* Disconnect "size-changed" signal handler */
712     g_signal_handlers_disconnect_by_func (screen, G_CALLBACK (screen_size_changed), widget);
713
714     GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->unrealize (widget);
715 }
716
717 static void
718 hildon_app_menu_apply_style                     (GtkWidget *widget)
719 {
720     GdkScreen *screen;
721     gint width;
722     guint horizontal_spacing, vertical_spacing, inner_border, external_border;
723     HildonAppMenuPrivate *priv;
724
725     priv = HILDON_APP_MENU_GET_PRIVATE (widget);
726
727     gtk_widget_style_get (widget,
728                           "horizontal-spacing", &horizontal_spacing,
729                           "vertical-spacing", &vertical_spacing,
730                           "inner-border", &inner_border,
731                           "external-border", &external_border,
732                           NULL);
733
734     /* Set spacings */
735     gtk_table_set_row_spacings (priv->table, vertical_spacing);
736     gtk_table_set_col_spacings (priv->table, horizontal_spacing);
737     gtk_box_set_spacing (priv->vbox, vertical_spacing);
738
739     /* Set inner border */
740     gtk_container_set_border_width (GTK_CONTAINER (widget), inner_border);
741
742     /* Set default size */
743     screen = gtk_widget_get_screen (widget);
744     width = gdk_screen_get_width (screen) - external_border * 2;
745     gtk_window_set_default_size (GTK_WINDOW (widget), width, -1);
746 }
747
748 static void
749 hildon_app_menu_style_set                       (GtkWidget *widget,
750                                                  GtkStyle  *previous_style)
751 {
752     if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set)
753         GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->style_set (widget, previous_style);
754
755     hildon_app_menu_apply_style (widget);
756 }
757
758 static void
759 hildon_app_menu_repack_filters                  (HildonAppMenu *menu)
760 {
761     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
762     GList *iter;
763
764     for (iter = priv->filters; iter != NULL; iter = iter->next) {
765         GtkWidget *filter = GTK_WIDGET (iter->data);
766         GtkWidget *parent = gtk_widget_get_parent (filter);
767         if (parent) {
768             g_object_ref (filter);
769             gtk_container_remove (GTK_CONTAINER (parent), filter);
770         }
771     }
772
773     for (iter = priv->filters; iter != NULL; iter = iter->next) {
774         GtkWidget *filter = GTK_WIDGET (iter->data);
775         if (GTK_WIDGET_VISIBLE (filter)) {
776             gtk_box_pack_start (GTK_BOX (priv->filters_hbox), filter, TRUE, TRUE, 0);
777             g_object_unref (filter);
778             /* GtkButton must be realized for accelerators to work */
779             gtk_widget_realize (filter);
780         }
781     }
782 }
783
784 /*
785  * When items displayed in the menu change (e.g, a new item is added,
786  * an item is hidden or the list is reordered), the layout must be
787  * updated. To do this we repack all items starting from a given one.
788  */
789 static void
790 hildon_app_menu_repack_items                    (HildonAppMenu *menu,
791                                                  gint           start_from)
792 {
793     HildonAppMenuPrivate *priv;
794     gint row, col;
795     GList *iter;
796
797     priv = HILDON_APP_MENU_GET_PRIVATE(menu);
798
799     /* Remove buttons from their parent */
800     if (start_from != -1) {
801         for (iter = g_list_nth (priv->buttons, start_from); iter != NULL; iter = iter->next) {
802             GtkWidget *item = GTK_WIDGET (iter->data);
803             GtkWidget *parent = gtk_widget_get_parent (item);
804             if (parent) {
805                 g_object_ref (item);
806                 gtk_container_remove (GTK_CONTAINER (parent), item);
807             }
808         }
809
810         /* If items have been removed, recalculate the size of the menu */
811         gtk_window_resize (GTK_WINDOW (menu), 1, 1);
812     }
813
814     /* Add buttons */
815     row = col = 0;
816     for (iter = priv->buttons; iter != NULL; iter = iter->next) {
817         GtkWidget *item = GTK_WIDGET (iter->data);
818         if (GTK_WIDGET_VISIBLE (item)) {
819             /* Don't add an item to the table if it's already there */
820             if (gtk_widget_get_parent (item) == NULL) {
821                 gtk_table_attach_defaults (priv->table, item, col, col + 1, row, row + 1);
822                 g_object_unref (item);
823                 /* GtkButton must be realized for accelerators to work */
824                 gtk_widget_realize (item);
825             }
826             if (++col == priv->columns) {
827                 col = 0;
828                 row++;
829             }
830         }
831     }
832
833     /* The number of rows/columns might have changed, so we have to
834      * resize the table */
835     if (col == 0) {
836         gtk_table_resize (priv->table, MAX (row, 1), priv->columns);
837     } else {
838         gtk_table_resize (priv->table, row + 1, priv->columns);
839     }
840
841     if (GTK_WIDGET_VISIBLE (GTK_WIDGET (menu))) {
842         gtk_window_reshow_with_initial_size (GTK_WINDOW (menu));
843     }
844 }
845
846 static void
847 hildon_app_menu_init                            (HildonAppMenu *menu)
848 {
849     GtkWidget *alignment;
850     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
851
852     /* Initialize private variables */
853     priv->parent_window = NULL;
854     priv->transfer_window = NULL;
855     priv->pressed_outside = FALSE;
856     priv->buttons = NULL;
857     priv->filters = NULL;
858     priv->columns = 2;
859
860     /* Create boxes and tables */
861     priv->filters_hbox = GTK_BOX (gtk_hbox_new (TRUE, 0));
862     priv->vbox = GTK_BOX (gtk_vbox_new (FALSE, 0));
863     priv->table = GTK_TABLE (gtk_table_new (1, priv->columns, TRUE));
864
865     /* Align the filters to the center */
866     alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
867     gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (priv->filters_hbox));
868
869     /* Pack everything */
870     gtk_container_add (GTK_CONTAINER (menu), GTK_WIDGET (priv->vbox));
871     gtk_box_pack_start (priv->vbox, alignment, TRUE, TRUE, 0);
872     gtk_box_pack_start (priv->vbox, GTK_WIDGET (priv->table), TRUE, TRUE, 0);
873
874     /* Make menu a modal window */
875     gtk_window_set_modal (GTK_WINDOW (menu), TRUE);
876
877     /* This should be treated like a normal, ref-counted widget */
878     g_object_force_floating (G_OBJECT (menu));
879     GTK_WINDOW (menu)->has_user_ref_count = FALSE;
880
881     gtk_widget_show_all (GTK_WIDGET (priv->vbox));
882 }
883
884 static void
885 hildon_app_menu_finalize                        (GObject *object)
886 {
887     HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(object);
888
889     if (priv->parent_window) {
890         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_topmost_notify, object);
891         g_signal_handlers_disconnect_by_func (priv->parent_window, parent_window_unmapped, object);
892     }
893
894     if (priv->transfer_window)
895         gdk_window_destroy (priv->transfer_window);
896
897     g_list_foreach (priv->buttons, (GFunc) g_object_unref, NULL);
898     g_list_foreach (priv->filters, (GFunc) g_object_unref, NULL);
899
900     g_list_free (priv->buttons);
901     g_list_free (priv->filters);
902
903     g_signal_handlers_destroy (object);
904     G_OBJECT_CLASS (hildon_app_menu_parent_class)->finalize (object);
905 }
906
907 static void
908 hildon_app_menu_class_init                      (HildonAppMenuClass *klass)
909 {
910     GObjectClass *gobject_class = (GObjectClass *)klass;
911     GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
912
913     gobject_class->finalize = hildon_app_menu_finalize;
914     widget_class->show = hildon_app_menu_show;
915     widget_class->show_all = hildon_app_menu_show_all;
916     widget_class->hide_all = hildon_app_menu_hide_all;
917     widget_class->map = hildon_app_menu_map;
918     widget_class->unmap = hildon_app_menu_unmap;
919     widget_class->realize = hildon_app_menu_realize;
920     widget_class->unrealize = hildon_app_menu_unrealize;
921     widget_class->grab_notify = hildon_app_menu_grab_notify;
922     widget_class->key_press_event = hildon_app_menu_key_press;
923     widget_class->button_press_event = hildon_app_menu_button_press;
924     widget_class->button_release_event = hildon_app_menu_button_release;
925     widget_class->style_set = hildon_app_menu_style_set;
926
927     g_type_class_add_private (klass, sizeof (HildonAppMenuPrivate));
928
929     gtk_widget_class_install_style_property (
930         widget_class,
931         g_param_spec_uint (
932             "horizontal-spacing",
933             "Horizontal spacing on menu items",
934             "Horizontal spacing between each menu item. Does not apply to filter buttons.",
935             0, G_MAXUINT, 16,
936             G_PARAM_READABLE));
937
938     gtk_widget_class_install_style_property (
939         widget_class,
940         g_param_spec_uint (
941             "vertical-spacing",
942             "Vertical spacing on menu items",
943             "Vertical spacing between each menu item. Does not apply to filter buttons.",
944             0, G_MAXUINT, 16,
945             G_PARAM_READABLE));
946
947     gtk_widget_class_install_style_property (
948         widget_class,
949         g_param_spec_uint (
950             "inner-border",
951             "Border between menu edges and buttons",
952             "Border between menu edges and buttons",
953             0, G_MAXUINT, 16,
954             G_PARAM_READABLE));
955
956     gtk_widget_class_install_style_property (
957         widget_class,
958         g_param_spec_uint (
959             "external-border",
960             "Border between menu and screen edges",
961             "Border between the right and left edges of the menu and the screen edges",
962             0, G_MAXUINT, 40,
963             G_PARAM_READABLE));
964 }