2 * This file is a part of hildon
4 * Copyright (C) 2005, 2008 Nokia Corporation.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version. or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free
18 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * SECTION:hildon-picker-dialog
23 * @short_description: A utility widget that shows a #HildonTouchSelector widget
25 * #HildonPickerDialog is a dialog that is used to show a
26 * #HildonTouchSelector widget and a 'Done' button to allow users to
27 * finish their selections.
29 * The #HildonPickerDialog will show a 'Done' button in case the
30 * #HildonTouchSelector allows multiple selection. The label of the
31 * button can be set using hildon_picker_dialog_set_done_label() and
32 * retrieved using hildon_picker_dialog_get_done_label()
34 * Note that in most cases developers don't need to deal directly with
35 * this widget. #HildonPickerButton is designed to pop up a
36 * #HildonPickerDialog and manage the interaction with it.
47 #include "hildon-touch-selector.h"
48 #include "hildon-touch-selector-entry.h"
49 #include "hildon-picker-dialog.h"
51 #define _(String) dgettext("hildon-libs", String)
53 #define HILDON_PICKER_DIALOG_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_PICKER_DIALOG, HildonPickerDialogPrivate))
55 G_DEFINE_TYPE (HildonPickerDialog, hildon_picker_dialog, HILDON_TYPE_DIALOG)
57 struct _HildonPickerDialogPrivate
62 gulong signal_changed_id;
63 gulong signal_columns_changed_id;
65 gboolean center_on_show;
66 GSList *current_selection;
74 PROP_DONE_BUTTON_TEXT,
85 #define DEFAULT_DONE_BUTTON_TEXT _("wdgt_bd_done")
88 hildon_picker_dialog_set_property (GObject * object,
94 hildon_picker_dialog_get_property (GObject * object,
96 GValue * value, GParamSpec * pspec);
99 hildon_picker_dialog_finalize (GObject *object);
103 hildon_picker_dialog_show (GtkWidget *widget);
106 hildon_picker_dialog_realize (GtkWidget *widget);
109 hildon_picker_dialog_size_request (GtkWidget *widget,
110 GtkRequisition *requisition);
112 /* private functions */
114 requires_done_button (HildonPickerDialog * dialog);
117 prepare_action_area (HildonPickerDialog *dialog);
120 setup_interaction_mode (HildonPickerDialog * dialog);
123 _select_on_selector_changed_cb (HildonTouchSelector * dialog,
128 _hildon_picker_dialog_set_selector (HildonPickerDialog * dialog,
129 HildonTouchSelector * selector);
132 _on_dialog_response (GtkDialog *dialog,
137 _save_current_selection (HildonPickerDialog *dialog);
140 _restore_current_selection (HildonPickerDialog *dialog);
143 _clean_current_selection (HildonPickerDialog *dialog);
146 hildon_picker_dialog_get_max_height (HildonPickerDialog *dialog);
148 /**********************************************************************************/
151 hildon_picker_dialog_class_init (HildonPickerDialogClass * class)
153 GObjectClass *gobject_class;
154 GtkObjectClass *object_class;
155 GtkWidgetClass *widget_class;
156 GtkContainerClass *container_class;
158 gobject_class = (GObjectClass *) class;
159 object_class = (GtkObjectClass *) class;
160 widget_class = (GtkWidgetClass *) class;
161 container_class = (GtkContainerClass *) class;
164 gobject_class->set_property = hildon_picker_dialog_set_property;
165 gobject_class->get_property = hildon_picker_dialog_get_property;
166 gobject_class->finalize = hildon_picker_dialog_finalize;
169 widget_class->show = hildon_picker_dialog_show;
170 widget_class->realize = hildon_picker_dialog_realize;
171 widget_class->size_request = hildon_picker_dialog_size_request,
173 /* HildonPickerDialog */
174 class->set_selector = _hildon_picker_dialog_set_selector;
186 g_object_class_install_property (gobject_class,
187 PROP_DONE_BUTTON_TEXT,
188 g_param_spec_string ("done-button-text",
191 DEFAULT_DONE_BUTTON_TEXT,
196 g_object_class_install_property (gobject_class,
198 g_param_spec_boolean ("center-on-show",
200 "If the dialog should center"
201 " on the current selection"
202 " when it is showed",
207 /* Using the default height, we get 5 full rows. With the header it sums 404 pixels */
208 gtk_widget_class_install_style_property (widget_class,
210 ("max-height-landscape",
211 "Max dialog height on landscape mode",
212 "Maximum dialog height on landscape mode",
218 /* Using the default height, we get 9 full rows. With the header it sums 684 pixels */
219 gtk_widget_class_install_style_property (widget_class,
221 ("max-height-portrait",
222 "Max dialog height on portrait mode",
223 "Maximum dialog height on portrait mode",
229 g_type_class_add_private (object_class, sizeof (HildonPickerDialogPrivate));
234 hildon_picker_dialog_init (HildonPickerDialog * dialog)
236 dialog->priv = HILDON_PICKER_DIALOG_GET_PRIVATE (dialog);
238 dialog->priv->selector = NULL;
239 dialog->priv->button =
240 gtk_dialog_add_button (GTK_DIALOG (dialog), "", GTK_RESPONSE_OK);
241 gtk_widget_grab_default (dialog->priv->button);
243 dialog->priv->signal_changed_id = 0;
244 dialog->priv->signal_columns_changed_id = 0;
245 dialog->priv->center_on_show = TRUE;
246 dialog->priv->current_selection = NULL;
247 dialog->priv->current_text = NULL;
249 g_signal_connect (G_OBJECT (dialog),
250 "response", G_CALLBACK (_on_dialog_response),
256 hildon_picker_dialog_set_property (GObject * object,
258 const GValue * value, GParamSpec * pspec)
260 HildonPickerDialog *dialog;
262 dialog = HILDON_PICKER_DIALOG (object);
265 case PROP_DONE_BUTTON_TEXT:
266 hildon_picker_dialog_set_done_label (HILDON_PICKER_DIALOG (object),
267 g_value_get_string (value));
269 case PROP_CENTER_ON_SHOW:
270 dialog->priv->center_on_show = g_value_get_boolean (value);
273 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
279 hildon_picker_dialog_get_property (GObject * object,
281 GValue * value, GParamSpec * pspec)
283 HildonPickerDialog *dialog;
285 dialog = HILDON_PICKER_DIALOG (object);
288 case PROP_DONE_BUTTON_TEXT:
289 g_value_set_string (value, hildon_picker_dialog_get_done_label (dialog));
291 case PROP_CENTER_ON_SHOW:
292 g_value_set_boolean (value, dialog->priv->center_on_show);
295 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
301 hildon_picker_dialog_finalize (GObject *object)
303 _clean_current_selection (HILDON_PICKER_DIALOG (object));
305 G_OBJECT_CLASS (hildon_picker_dialog_parent_class)->finalize (object);
309 hildon_picker_dialog_show (GtkWidget *widget)
311 HildonPickerDialog *dialog = HILDON_PICKER_DIALOG (widget);
312 HildonTouchSelector *selector;
314 GTK_WIDGET_CLASS (hildon_picker_dialog_parent_class)->show (widget);
316 if (dialog->priv->center_on_show) {
317 selector = hildon_picker_dialog_get_selector (dialog);
318 hildon_touch_selector_center_on_selected (selector);
321 _save_current_selection (dialog);
322 prepare_action_area (dialog);
327 hildon_picker_dialog_size_request (GtkWidget *widget,
328 GtkRequisition *requisition)
330 HildonTouchSelector *selector;
332 selector = hildon_picker_dialog_get_selector (HILDON_PICKER_DIALOG (widget));
335 GtkRequisition child_requisition;
336 GtkRequisition optimal_requisition;
340 bin = GTK_BIN (widget);
342 requisition->width = GTK_CONTAINER (widget)->border_width * 2;
343 /* Adding pannable container border using 4 instead of 2 */
344 requisition->height = GTK_CONTAINER (widget)->border_width * 4;
346 /* assure the requisition is done */
347 gtk_widget_size_request (bin->child, &child_requisition);
349 hildon_touch_selector_optimal_size_request (selector,
350 &optimal_requisition);
352 requisition->width += child_requisition.width;
354 max_height = hildon_picker_dialog_get_max_height (HILDON_PICKER_DIALOG (widget));
356 requisition->height = MIN (max_height,
357 requisition->height + optimal_requisition.height);
359 GTK_WIDGET_CLASS (hildon_picker_dialog_parent_class)->size_request
360 (widget, requisition);
364 hildon_picker_dialog_realize (GtkWidget *widget)
366 setup_interaction_mode (HILDON_PICKER_DIALOG (widget));
368 GTK_WIDGET_CLASS (hildon_picker_dialog_parent_class)->realize (widget);
371 /* ------------------------------ PRIVATE METHODS ---------------------------- */
374 hildon_picker_dialog_get_max_height (HildonPickerDialog *dialog)
376 gboolean landscape = TRUE;
378 GdkScreen *screen = NULL;
380 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
381 if (screen != NULL) {
382 if (gdk_screen_get_width (screen) > gdk_screen_get_height (screen)) {
390 gtk_widget_style_get (GTK_WIDGET (dialog), "max-height-landscape",
393 gtk_widget_style_get (GTK_WIDGET (dialog), "max-height-portrait",
402 _select_on_selector_changed_cb (HildonTouchSelector * selector,
403 gint column, gpointer data)
405 g_return_if_fail (HILDON_IS_PICKER_DIALOG (data));
407 gtk_dialog_response (GTK_DIALOG (data), GTK_RESPONSE_OK);
411 selection_completed (HildonPickerDialog *dialog)
413 HildonPickerDialogPrivate *priv;
416 gboolean all_selected = TRUE;
418 priv = HILDON_PICKER_DIALOG_GET_PRIVATE (dialog);
420 n_cols = hildon_touch_selector_get_num_columns (HILDON_TOUCH_SELECTOR (priv->selector));
421 for (i = 0; i < n_cols; i++) {
422 list = hildon_touch_selector_get_selected_rows (HILDON_TOUCH_SELECTOR (priv->selector), i);
424 all_selected = FALSE;
427 g_list_foreach (list, (GFunc)gtk_tree_path_free, NULL);
435 _on_dialog_response (GtkDialog *dialog,
439 if (response_id == GTK_RESPONSE_OK) {
440 if (selection_completed (HILDON_PICKER_DIALOG (dialog)) == FALSE) {
441 g_signal_stop_emission_by_name (dialog, "response");
443 } else if (response_id == GTK_RESPONSE_DELETE_EVENT) {
444 _restore_current_selection (HILDON_PICKER_DIALOG (dialog));
449 on_selector_columns_changed (HildonTouchSelector * selector, gpointer userdata)
451 HildonPickerDialog * dialog;
453 dialog = HILDON_PICKER_DIALOG (userdata);
455 prepare_action_area (dialog);
456 if (GTK_WIDGET_REALIZED (dialog)) {
457 setup_interaction_mode (dialog);
462 * hildon_picker_dialog_set_done_label:
463 * @dialog: a #HildonPickerDialog
466 * Sets a custom string to be used as the 'Done' button label in @dialog.
471 hildon_picker_dialog_set_done_label (HildonPickerDialog * dialog,
474 HildonPickerDialogPrivate *priv;
476 g_return_if_fail (HILDON_IS_PICKER_DIALOG (dialog));
477 g_return_if_fail (label != NULL);
479 priv = HILDON_PICKER_DIALOG_GET_PRIVATE (dialog);
481 gtk_button_set_label (GTK_BUTTON (priv->button), label);
485 * hildon_picker_dialog_get_done_label:
486 * @dialog: a #HildonPickerDialog
488 * Retrieves current 'Done' button label.
490 * Returns: the custom string to be used.
495 hildon_picker_dialog_get_done_label (HildonPickerDialog * dialog)
497 HildonPickerDialogPrivate *priv;
499 g_return_val_if_fail (HILDON_IS_PICKER_DIALOG (dialog), NULL);
501 priv = HILDON_PICKER_DIALOG_GET_PRIVATE (dialog);
503 return gtk_button_get_label (GTK_BUTTON (priv->button));
507 free_path_list (GList *list)
509 g_list_foreach (list, (GFunc) gtk_tree_path_free, NULL);
514 _clean_current_selection (HildonPickerDialog *dialog)
516 if (dialog->priv->current_selection) {
517 g_slist_foreach (dialog->priv->current_selection, (GFunc) free_path_list, NULL);
518 g_slist_free (dialog->priv->current_selection);
519 dialog->priv->current_selection = NULL;
521 if (dialog->priv->current_text) {
522 g_free (dialog->priv->current_text);
523 dialog->priv->current_text = NULL;
528 _save_current_selection (HildonPickerDialog *dialog)
530 HildonTouchSelector *selector;
533 selector = HILDON_TOUCH_SELECTOR (dialog->priv->selector);
535 _clean_current_selection (dialog);
537 columns = hildon_touch_selector_get_num_columns (selector);
538 for (i = 0; i < columns; i++) {
539 dialog->priv->current_selection
540 = g_slist_append (dialog->priv->current_selection,
541 hildon_touch_selector_get_selected_rows (selector, i));
543 if (HILDON_IS_TOUCH_SELECTOR_ENTRY (selector)) {
544 HildonEntry *entry = hildon_touch_selector_entry_get_entry (HILDON_TOUCH_SELECTOR_ENTRY (selector));
545 dialog->priv->current_text = g_strdup (hildon_entry_get_text (entry));
550 _restore_current_selection (HildonPickerDialog *dialog)
552 GSList *current_selection, *iter;
553 GList *selected, *selected_iter;
554 GtkTreePath *current_path;
555 HildonTouchSelector *selector;
557 GtkTreeIter tree_iter;
560 if (dialog->priv->current_selection == NULL)
563 current_selection = dialog->priv->current_selection;
564 selector = HILDON_TOUCH_SELECTOR (dialog->priv->selector);
566 if (hildon_touch_selector_get_num_columns (selector) !=
567 g_slist_length (current_selection)) {
568 /* We conclude that if the current selection has the same
569 numbers of columns that the selector, all this ok
570 Anyway this shouldn't happen. */
571 g_critical ("Trying to restore the selection on a selector after change"
572 " the number of columns. Are you removing columns while the"
577 if (dialog->priv->signal_changed_id)
578 g_signal_handler_block (selector, dialog->priv->signal_changed_id);
579 for (iter = current_selection, i = 0; iter; iter = g_slist_next (iter), i++) {
580 selected = (GList *) (iter->data);
581 model = hildon_touch_selector_get_model (selector, i);
582 hildon_touch_selector_unselect_all (selector, i);
583 for (selected_iter = selected; selected_iter; selected_iter = g_list_next (selected_iter)) {
584 current_path = (GtkTreePath *) selected_iter->data;
585 gtk_tree_model_get_iter (model, &tree_iter, current_path);
586 hildon_touch_selector_select_iter (selector, i, &tree_iter, FALSE);
589 if (HILDON_IS_TOUCH_SELECTOR_ENTRY (selector) && dialog->priv->current_text != NULL) {
590 HildonEntry *entry = hildon_touch_selector_entry_get_entry (HILDON_TOUCH_SELECTOR_ENTRY (selector));
591 hildon_entry_set_text (entry, dialog->priv->current_text);
593 if (dialog->priv->signal_changed_id)
594 g_signal_handler_unblock (selector, dialog->priv->signal_changed_id);
598 requires_done_button (HildonPickerDialog * dialog)
600 return hildon_touch_selector_has_multiple_selection
601 (HILDON_TOUCH_SELECTOR (dialog->priv->selector));
605 prepare_action_area (HildonPickerDialog *dialog)
607 if (requires_done_button (dialog)) {
608 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), TRUE);
609 gtk_widget_show (GTK_DIALOG (dialog)->action_area);
611 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
612 gtk_widget_hide (GTK_DIALOG (dialog)->action_area);
617 setup_interaction_mode (HildonPickerDialog * dialog)
619 if (dialog->priv->signal_changed_id) {
620 g_signal_handler_disconnect (dialog->priv->selector,
621 dialog->priv->signal_changed_id);
624 if (requires_done_button (dialog) == FALSE) {
625 dialog->priv->signal_changed_id =
626 g_signal_connect (G_OBJECT (dialog->priv->selector), "changed",
627 G_CALLBACK (_select_on_selector_changed_cb), dialog);
631 /*------------------------- PUBLIC METHODS ---------------------------- */
634 * hildon_picker_dialog_new:
635 * @parent: the parent window
637 * Creates a new #HildonPickerDialog
639 * Returns: a new #HildonPickerDialog
644 hildon_picker_dialog_new (GtkWindow * parent)
646 GtkDialog *dialog = NULL;
648 dialog = g_object_new (HILDON_TYPE_PICKER_DIALOG, NULL);
651 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
654 return GTK_WIDGET (dialog);
659 _hildon_picker_dialog_set_selector (HildonPickerDialog * dialog,
660 HildonTouchSelector * selector)
662 g_object_ref (selector);
664 /* Remove the old selector, if any */
665 if (dialog->priv->selector != NULL) {
666 gtk_container_remove (GTK_CONTAINER (GTK_DIALOG (dialog)->vbox),
667 dialog->priv->selector);
668 if (dialog->priv->signal_columns_changed_id) {
669 g_signal_handler_disconnect (dialog->priv->selector,
670 dialog->priv->signal_columns_changed_id);
674 dialog->priv->selector = GTK_WIDGET (selector);
676 /* Pack the new selector */
677 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
678 dialog->priv->selector, TRUE, TRUE, 0);
680 g_object_unref (selector);
682 gtk_widget_show (dialog->priv->selector);
684 prepare_action_area (dialog);
685 if (GTK_WIDGET_REALIZED (dialog)) {
686 setup_interaction_mode (dialog);
689 dialog->priv->signal_columns_changed_id = g_signal_connect (G_OBJECT (dialog->priv->selector),
691 G_CALLBACK (on_selector_columns_changed), dialog);
696 * hildon_picker_dialog_set_selector:
697 * @dialog: a #HildonPickerDialog
698 * @selector: a #HildonTouchSelector
700 * Sets @selector as the #HildonTouchSelector to be shown in @dialog
702 * Returns: %TRUE if @selector was set, %FALSE otherwise
707 hildon_picker_dialog_set_selector (HildonPickerDialog * dialog,
708 HildonTouchSelector * selector)
710 g_return_val_if_fail (HILDON_IS_PICKER_DIALOG (dialog), FALSE);
711 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
713 return HILDON_PICKER_DIALOG_GET_CLASS (dialog)->set_selector (dialog, selector);
717 * hildon_picker_dialog_get_selector:
718 * @dialog: a #HildonPickerDialog
720 * Retrieves the #HildonTouchSelector associated to @dialog.
722 * Returns: a #HildonTouchSelector
726 HildonTouchSelector *
727 hildon_picker_dialog_get_selector (HildonPickerDialog * dialog)
729 g_return_val_if_fail (HILDON_IS_PICKER_DIALOG (dialog), NULL);
731 return HILDON_TOUCH_SELECTOR (dialog->priv->selector);