2 * This file is a part of hildon
4 * Copyright (C) 2008 Nokia Corporation, all rights reserved.
6 * Contact: Karl Lattimer <karl.lattimer@nokia.com>
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.
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.
20 * SECTION:hildon-app-menu
21 * @short_description: Widget representing the application menu in the Hildon framework.
23 * The #HildonAppMenu is a GTK widget which represents an application
24 * menu in the Hildon framework.
26 * This menu opens from the top of the screen and contains a number of
27 * entries (#GtkButton) organized in two columns. Entries are added
28 * left to right and top to bottom.
30 * Besides that, the #HildonAppMenu can contain filter buttons
31 * (#GtkToggleButton or #GtkRadioButton), which can be grouped.
34 * <title>Creating a HildonAppMenu</title>
36 * HildonAppMenu *menu;
39 * GtkWidget *filtergroup;
41 * menu = HILDON_APP_MENU (hildon_app_menu_new ());
43 * // Create a button and add it to the menu
44 * button = gtk_button_new_with_label ("Menu command one");
45 * g_signal_connect (button, "clicked", G_CALLBACK (button_one_clicked), userdata);
46 * hildon_app_menu_append (menu, GTK_BUTTON (button));
48 * button = gtk_button_new_with_label ("Menu command two");
49 * g_signal_connect (button, "clicked", G_CALLBACK (button_two_clicked), userdata);
50 * hildon_app_menu_append (menu, GTK_BUTTON (button));
52 * // Create a filter and add it to the menu
53 * filter = gtk_toggle_button_new_with_label ("Filter one");
54 * g_signal_connect (filter, "clicked", G_CALLBACK (filter_one_clicked), userdata);
55 * hildon_app_menu_add_filter (menu, GTK_BUTTON (filter), NULL);
57 * // Create another filter and add it to a new filter group
58 * filter = gtk_radio_button_new_with_label (NULL, "Filter two");
59 * gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (filter), FALSE);
60 * g_signal_connect (filter, "clicked", G_CALLBACK (filter_two_clicked), userdata);
61 * filtergroup = hildon_app_menu_add_filter (menu, GTK_BUTTON (filter), NULL);
62 * // Add a new filter to the same filter group
63 * filter = gtk_radio_button_new_with_label_from_widget (GTK_RADIO_BUTTON (filter), "Filter three");
64 * gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (filter), FALSE);
65 * g_signal_connect (filter, "clicked", G_CALLBACK (filter_three_clicked), userdata);
66 * hildon_app_menu_add_filter (menu, GTK_BUTTON (filter), filtergroup);
69 * hildon_app_menu_popup (menu);
75 #include "hildon-app-menu.h"
76 #include "hildon-app-menu-private.h"
79 hildon_app_menu_popdown (HildonAppMenu *menu);
82 grab_transfer_window_get (HildonAppMenu *menu);
84 G_DEFINE_TYPE (HildonAppMenu, hildon_app_menu, GTK_TYPE_WINDOW);
87 * hildon_app_menu_new:
89 * Creates a new HildonAppMenu.
91 * Return value: A @HildonAppMenu.
94 hildon_app_menu_new (void)
96 GtkWidget *menu = g_object_new (HILDON_TYPE_APP_MENU, NULL);
101 * hildon_app_menu_append
102 * @menu : A @HildonAppMenu
103 * @item : A @GtkButton to add to the HildonAppMenu
105 * Adds the @item to the @HildonAppMenu
108 hildon_app_menu_append (HildonAppMenu *menu,
111 HildonAppMenuPrivate *priv;
114 g_return_if_fail (HILDON_IS_APP_MENU (menu));
115 g_return_if_fail (GTK_IS_BUTTON (item));
117 priv = HILDON_APP_MENU_GET_PRIVATE(menu);
119 /* Calculate the row and column number */
120 col = priv->nitems % 2;
121 row = (priv->nitems - col) / 2;
124 /* GtkTable already calls gtk_table_resize() if necessary */
125 gtk_table_attach_defaults (priv->table, GTK_WIDGET (item), col, col + 1, row, row + 1);
127 /* Close the menu when the button is pressed */
128 g_signal_connect_swapped (item, "clicked", G_CALLBACK (hildon_app_menu_popdown), menu);
130 gtk_widget_show (GTK_WIDGET (item));
134 * hildon_app_menu_add_filter
135 * @menu : A @HildonAppMenu
136 * @filter : A @GtkButton to add to the HildonAppMenu
137 * @group : An existing filter group, or %NULL to create a new one
139 * Adds the @filter to the @HildonAppMenu, to the group specified by @group
141 * Return value: The filter group where the filter has been added
144 hildon_app_menu_add_filter (HildonAppMenu *menu,
148 HildonAppMenuPrivate *priv;
150 g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
151 g_return_val_if_fail (GTK_IS_BUTTON (filter), NULL);
152 g_return_val_if_fail (!group || GTK_IS_BOX (group), NULL);
154 priv = HILDON_APP_MENU_GET_PRIVATE(menu);
156 /* Create a new group if needed */
158 group = gtk_hbox_new (TRUE, 0);
159 gtk_box_pack_start (priv->filters_hbox, group, TRUE, TRUE, 0);
160 gtk_widget_show (group);
163 /* Pack the filter in the group and set its size */
164 gtk_box_pack_start (GTK_BOX (group), GTK_WIDGET (filter), TRUE, TRUE, 0);
165 gtk_size_group_add_widget (priv->sizegroup, GTK_WIDGET (filter));
167 /* Close the menu when the button is pressed */
168 g_signal_connect_swapped (filter, "clicked", G_CALLBACK (hildon_app_menu_popdown), menu);
170 gtk_widget_show (GTK_WIDGET (filter));
176 * hildon_app_menu_get_group_from_filter
177 * @menu : A @HildonAppMenu
178 * @filter : A @GtkButton previously added to the menu
180 * Gets the filter group from a @filter previously added to a @HildonAppMenu
182 * Return value: The group where the @filter is in, or %NULL
185 hildon_app_menu_get_group_from_filter (HildonAppMenu *menu,
188 HildonAppMenuPrivate *priv;
190 GtkWidget *result = NULL;
192 g_return_val_if_fail (HILDON_IS_APP_MENU (menu), NULL);
193 g_return_val_if_fail (GTK_IS_BUTTON (filter), NULL);
195 priv = HILDON_APP_MENU_GET_PRIVATE(menu);
197 /* Get the list of filter groups */
198 grouplist = gtk_container_get_children (GTK_CONTAINER (priv->filters_hbox));
200 for (; grouplist != NULL && !result; grouplist = grouplist->next) {
202 GtkBox *group = GTK_BOX (grouplist->data);
203 GList *items = gtk_container_get_children (GTK_CONTAINER (group));
205 /* Look for the filter inside each filter group */
206 for (; items != NULL && !result; items = items->next) {
207 if (filter == items->data) {
208 result = GTK_WIDGET (group);
214 g_list_free (grouplist);
217 g_critical("Filter not found in hildon app menu!");
223 * hildon_app_menu_popup
224 * @menu : A @HildonAppMenu
226 * Displays the @HildonAppMenu on top of the screen
229 hildon_app_menu_popup (HildonAppMenu *menu)
231 g_return_if_fail (HILDON_IS_APP_MENU (menu));
234 HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
235 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (menu));
237 /* Grab pointer and keyboard */
238 if (priv->transfer_window == NULL) {
239 priv->transfer_window = grab_transfer_window_get (menu);
241 priv->transfer_window, TRUE,
242 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
243 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
244 GDK_POINTER_MOTION_MASK, NULL, NULL, GDK_CURRENT_TIME);
245 gdk_keyboard_grab (priv->transfer_window, TRUE, GDK_CURRENT_TIME);
246 gtk_grab_add (GTK_WIDGET (menu));
249 /* Position the menu in the top center of the screen */
250 gtk_window_get_default_size (GTK_WINDOW (menu), &x, NULL);
251 gtk_widget_size_request (GTK_WIDGET (menu), &req);
252 xpos = (gdk_screen_get_width (screen) - MAX(x, req.width)) / 2;
253 gtk_window_move (GTK_WINDOW (menu), xpos, 0);
255 gtk_widget_show (GTK_WIDGET (menu));
259 hildon_app_menu_popdown (HildonAppMenu *menu)
261 g_return_if_fail (HILDON_IS_APP_MENU (menu));
262 HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
264 if (priv->transfer_window != NULL) {
265 /* Remove the grab */
266 gdk_display_pointer_ungrab (gtk_widget_get_display (GTK_WIDGET (menu)),
268 gtk_grab_remove (GTK_WIDGET (menu));
270 /* Destroy the transfer window */
271 gdk_window_destroy (priv->transfer_window);
272 priv->transfer_window = NULL;
275 gtk_widget_hide (GTK_WIDGET (menu));
279 hildon_app_menu_button_press (GtkWidget *widget,
280 GdkEventButton *event)
283 HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(widget);
284 gdk_window_get_position(widget->window, &x, &y);
285 if (event->window != priv->transfer_window ||
286 event->x < x || event->x > x + widget->allocation.width ||
287 event->y < y || event->y > y + widget->allocation.height) {
288 hildon_app_menu_popdown (HILDON_APP_MENU (widget));
290 } else if (GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event) {
291 return GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->button_press_event (widget, event);
297 /* Grab transfer window (based on the one from GtkMenu) */
299 grab_transfer_window_get (HildonAppMenu *menu)
302 GdkWindowAttr attributes;
303 gint attributes_mask;
307 attributes.width = 10;
308 attributes.height = 10;
309 attributes.window_type = GDK_WINDOW_TEMP;
310 attributes.wclass = GDK_INPUT_ONLY;
311 attributes.override_redirect = TRUE;
312 attributes.event_mask = 0;
314 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
316 window = gdk_window_new (gtk_widget_get_root_window (GTK_WIDGET (menu)),
317 &attributes, attributes_mask);
318 gdk_window_set_user_data (window, menu);
320 gdk_window_show (window);
326 hildon_app_menu_realize (GtkWidget *widget)
328 GTK_WIDGET_CLASS (hildon_app_menu_parent_class)->realize (widget);
329 gdk_window_set_override_redirect(widget->window, TRUE);
333 hildon_app_menu_init (HildonAppMenu *menu)
335 GtkWidget *alignment;
338 guint filter_group_spacing, horizontal_spacing, vertical_spacing,
340 HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(menu);
342 gtk_widget_style_get (GTK_WIDGET (menu),
343 "filter-group-spacing", &filter_group_spacing,
344 "horizontal-spacing", &horizontal_spacing,
345 "vertical-spacing", &vertical_spacing,
346 "external-border", &external_border,
349 /* Initialize private variables */
350 priv->filters_hbox = GTK_BOX (gtk_hbox_new (FALSE, filter_group_spacing));
351 priv->vbox = GTK_BOX (gtk_vbox_new (FALSE, 10));
352 priv->table = GTK_TABLE (gtk_table_new (1, 2, TRUE));
353 priv->sizegroup = GTK_SIZE_GROUP (gtk_size_group_new (GTK_SIZE_GROUP_BOTH));
355 priv->transfer_window = NULL;
357 /* Set spacing between table elements */
358 gtk_table_set_row_spacings (priv->table, vertical_spacing);
359 gtk_table_set_col_spacings (priv->table, horizontal_spacing);
361 /* Align the filters to the center */
362 alignment = gtk_alignment_new (0.5, 0.5, 0, 0);
363 gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (priv->filters_hbox));
365 /* Pack everything */
366 gtk_container_add (GTK_CONTAINER (menu), GTK_WIDGET (priv->vbox));
367 gtk_box_pack_start (priv->vbox, alignment, TRUE, TRUE, 0);
368 gtk_box_pack_start (priv->vbox, GTK_WIDGET (priv->table), TRUE, TRUE, 0);
370 /* Set default size */
371 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
372 width = gdk_screen_get_width (screen) - external_border * 2;
373 gtk_window_set_default_size (GTK_WINDOW (menu), width, -1);
375 gtk_widget_show_all (GTK_WIDGET (priv->vbox));
377 gtk_window_set_type_hint (GTK_WINDOW (menu), GDK_WINDOW_TYPE_HINT_POPUP_MENU);
381 hildon_app_menu_finalize (GObject *object)
383 HildonAppMenuPrivate *priv = HILDON_APP_MENU_GET_PRIVATE(object);
385 g_object_unref (priv->sizegroup);
386 if (priv->transfer_window)
387 gdk_window_destroy (priv->transfer_window);
389 g_signal_handlers_destroy (object);
390 G_OBJECT_CLASS (hildon_app_menu_parent_class)->finalize (object);
394 hildon_app_menu_class_init (HildonAppMenuClass *klass)
396 GObjectClass *gobject_class = (GObjectClass *)klass;
397 GtkWidgetClass *widget_class = (GtkWidgetClass *)klass;
399 gobject_class->finalize = hildon_app_menu_finalize;
400 widget_class->realize = hildon_app_menu_realize;
401 widget_class->button_press_event = hildon_app_menu_button_press;
403 g_type_class_add_private (klass, sizeof (HildonAppMenuPrivate));
405 gtk_widget_class_install_style_property (
408 "filter-group-spacing",
409 "Space between filter groups",
410 "Space in pixels between the filter groups",
414 gtk_widget_class_install_style_property (
417 "horizontal-spacing",
418 "Horizontal spacing on menu items",
419 "Horizontal spacing between each menu item (but not filters)",
423 gtk_widget_class_install_style_property (
427 "Vertical spacing on menu items",
428 "Vertical spacing between each menu item (but not filters)",
432 gtk_widget_class_install_style_property (
436 "Border between menu and screen edges",
437 "Border between the right and left edges of the menu and the screen edges",