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-touch-selector
23 * @short_description: A selector widget with several columns.
25 * #HildonTouchSelector is a selector widget, that allows users to
26 * select items from one to many predefined lists. It is very similar
27 * to #GtkComboBox, but with several individual pannable columns.
29 * Normally, you would use #HildonTouchSelector together with a
30 * #HildonPickerDialog activated from a button. For the most common
31 * cases, you should use #HildonPickerButton.
33 * The contents of each #HildonTouchSelector column are stored in a
34 * #GtkTreeModel. To add a new column to a #HildonTouchSelector, use
35 * hildon_touch_selector_append_column(). If you want to add a
36 * text-only column, without special attributes, use
37 * hildon_touch_selector_append_text_column().
39 * It is highly recommended that you use only one column
40 * #HildonTouchSelector<!-- -->s.
41 * If you only need a text only, one column selector, you can create it with
42 * hildon_touch_selector_new_text() and populate with
43 * hildon_touch_selector_append_text(), hildon_touch_selector_prepend_text(),
44 * and hildon_touch_selector_insert_text().
46 * If you need a selector widget that also accepts user inputs, you
47 * can use #HildonTouchSelectorEntry.
49 * The current selection has a string representation. In the most common cases,
50 * each column model will contain a text column. You can configure
51 * which column in particular using the #HildonTouchSelectorColumn property
52 * #HildonTouchSelectorColumn:text-column
54 * You can get this string representation using
55 * hildon_touch_selector_get_current_text().
56 * You can configure how the selection is printed with
57 * hildon_touch_selector_set_print_func(), that sets the current hildon touch
58 * selector print function. The widget has a default print function, that
59 * uses the #HildonTouchSelectorColumn:text-column property on each
60 * #HildonTouchSelectorColumn to compose the final representation.
62 * If you create the selector using hildon_touch_selector_new_text() you
63 * don't need to take care of this property, as the model is created internally.
64 * If you create the selector using hildon_touch_selector_new(), you
65 * need to specify properly the property for your custom model in order to get a
66 * non-empty string representation, or define your custom print function.
69 * <title>Creating a HildonTouchSelector</title>
72 * selection_changed (HildonTouchSelector * selector,
73 * gpointer *user_data)
75 * gchar *current_selection = NULL;
77 * current_selection = hildon_touch_selector_get_current_text (selector);
78 * g_debug ("Current selection : %s", current_selection);
82 * create_customized_selector ()
84 * GtkWidget *selector = NULL;
85 * GSList *icon_list = NULL;
86 * GtkListStore *store_icons = NULL;
87 * GSList *item = NULL;
88 * GtkCellRenderer *renderer = NULL;
89 * HildonTouchSelectorColumn *column = NULL;
91 * selector = hildon_touch_selector_new ();
93 * icon_list = gtk_stock_list_ids ();
95 * store_icons = gtk_list_store_new (1, G_TYPE_STRING);
96 * for (item = icon_list; item; item = g_slist_next (item)) {
98 * gchar *label = item->data;
100 * gtk_list_store_append (store_icons, &iter);
101 * gtk_list_store_set (store_icons, &iter, 0, label, -1);
104 * g_slist_free (icon_list);
106 * renderer = gtk_cell_renderer_pixbuf_new ();
107 * gtk_cell_renderer_set_fixed_size (renderer, -1, 100);
109 * column = hildon_touch_selector_append_column (HILDON_TOUCH_SELECTOR (selector),
110 * GTK_TREE_MODEL (store_icons),
111 * renderer, "stock-id", 0, NULL);
113 * hildon_touch_selector_column_set_text_column (column, 0);
115 * hildon_touch_selector_set_column_selection_mode (HILDON_TOUCH_SELECTOR (selector),
116 * HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE);
118 * g_signal_connect (G_OBJECT (selector), "changed",
119 * G_CALLBACK (selection_changed), NULL);
125 * create_simple_selector ()
127 * GtkWidget *selector = NULL;
130 * selector = hildon_touch_selector_new_text ();
131 * hildon_touch_selector_set_column_selection_mode (HILDON_TOUCH_SELECTOR (selector),
132 * HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE);
134 * g_signal_connect (G_OBJECT (selector), "changed",
135 * G_CALLBACK (selection_changed), NULL);
137 * for (i = 1; i <= 10 ; i++) {
138 * gchar *label = g_strdup_printf ("Item &percnt;d", i);
140 * hildon_touch_selector_append_text (HILDON_TOUCH_SELECTOR (selector),
153 * SECTION:hildon-touch-selector-column
154 * @short_description: A visible column in a #HildonTouchSelector
156 * A #HildonTouchSelectorColumn is a column in a
157 * #HildonTouchSelector. This class implements the #GtkCellLayout interface, allowing
158 * a flexible management of the cellrenderers in each #HildonTouchSelector column.
161 #undef HILDON_DISABLE_DEPRECATED
170 #include "hildon-gtk.h"
172 #include "hildon-pannable-area.h"
173 #include "hildon-touch-selector.h"
174 #include "hildon-touch-selector-private.h"
176 #define HILDON_TOUCH_SELECTOR_GET_PRIVATE(obj) \
177 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_TOUCH_SELECTOR, HildonTouchSelectorPrivate))
179 G_DEFINE_TYPE (HildonTouchSelector, hildon_touch_selector, GTK_TYPE_VBOX)
182 * IMPLEMENTATION NOTES:
183 * Struct to maintain the data of each column. The columns are the elements
184 * of the widget that belongs properly to the selection behaviour. Although
185 * internally the columns are arranged in a private #GtkHBox, as the selector
186 * itself is a #GtkVBox, you can add more widgets, like buttons etc., so
187 * you finally could have a widget with more elements that the columns, but
188 * this doesn't belongs to the selection logic
190 struct _HildonTouchSelectorColumnPrivate
192 HildonTouchSelector *parent; /* the selector that contains this column */
195 GtkTreeView *tree_view;
196 gulong realize_handler;
197 GtkTreePath *initial_path;
199 GtkWidget *panarea; /* the pannable widget */
202 struct _HildonTouchSelectorPrivate
204 GSList *columns; /* the selection columns */
205 GtkWidget *hbox; /* the container for the selector's columns */
206 gboolean initial_scroll; /* whether initial fancy scrolling to selection */
208 gboolean changed_blocked;
210 HildonTouchSelectorPrintFunc print_func;
211 gpointer print_user_data;
212 GDestroyNotify print_destroy_func;
217 PROP_HAS_MULTIPLE_SELECTION = 1,
228 static gint hildon_touch_selector_signals[LAST_SIGNAL] = { 0 };
231 hildon_touch_selector_dispose (GObject * object);
234 hildon_touch_selector_get_property (GObject * object,
239 hildon_touch_selector_set_property (GObject *object,
246 static void hildon_touch_selector_remove (GtkContainer * container,
248 /* private functions */
249 static void _row_tapped_cb (GtkTreeView * tree_view,
252 static gchar *_default_print_func (HildonTouchSelector * selector,
255 static HildonTouchSelectorColumn *_create_new_column (HildonTouchSelector * selector,
256 GtkTreeModel * model,
257 gboolean *emit_changed,
258 GtkCellRenderer * renderer,
261 on_realize_cb (GtkWidget *widget,
264 on_row_changed (GtkTreeModel *model,
270 hildon_touch_selector_scroll_to (HildonTouchSelectorColumn *column,
274 _hildon_touch_selector_center_on_selected_items (HildonTouchSelector *selector,
275 HildonTouchSelectorColumn *column);
277 _hildon_touch_selector_set_model (HildonTouchSelector * selector,
279 GtkTreeModel * model);
281 _hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector);
284 hildon_touch_selector_emit_value_changed (HildonTouchSelector *selector,
287 /* GtkCellLayout implementation (HildonTouchSelectorColumn)*/
288 static void hildon_touch_selector_column_cell_layout_init (GtkCellLayoutIface *iface);
290 static void hildon_touch_selector_column_cell_layout_pack_start (GtkCellLayout *cell_layout,
291 GtkCellRenderer *cell,
293 static void hildon_touch_selector_column_cell_layout_pack_end (GtkCellLayout *cell_layout,
294 GtkCellRenderer *cell,
296 static void hildon_touch_selector_column_cell_layout_clear (GtkCellLayout *cell_layout);
297 static void hildon_touch_selector_column_cell_layout_add_attribute(GtkCellLayout *cell_layout,
298 GtkCellRenderer *cell,
299 const gchar *attribute,
301 static void hildon_touch_selector_column_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
302 GtkCellRenderer *cell,
303 GtkCellLayoutDataFunc func,
305 GDestroyNotify destroy);
306 static void hildon_touch_selector_column_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
307 GtkCellRenderer *cell);
308 static void hildon_touch_selector_column_cell_layout_reorder (GtkCellLayout *cell_layout,
309 GtkCellRenderer *cell,
311 static GList *hildon_touch_selector_column_cell_layout_get_cells (GtkCellLayout *cell_layout);
315 hildon_touch_selector_class_init (HildonTouchSelectorClass * class)
317 GObjectClass *gobject_class;
318 GtkObjectClass *object_class;
319 GtkContainerClass *container_class;
321 gobject_class = G_OBJECT_CLASS (class);
322 object_class = GTK_OBJECT_CLASS (class);
323 container_class = GTK_CONTAINER_CLASS (class);
326 gobject_class->dispose = hildon_touch_selector_dispose;
327 gobject_class->get_property = hildon_touch_selector_get_property;
328 gobject_class->set_property = hildon_touch_selector_set_property;
333 container_class->remove = hildon_touch_selector_remove;
335 /* HildonTouchSelector */
336 class->changed = NULL;
337 class->set_model = _hildon_touch_selector_set_model;
339 class->has_multiple_selection = _hildon_touch_selector_has_multiple_selection;
343 * HildonTouchSelector::changed:
344 * @widget: the object which received the signal
345 * @column: the number of the column that has changed
347 * The "changed" signal is emitted when the active item on any column is changed.
348 * This can be due to the user selecting a different item from the list, or
349 * due to a call to hildon_touch_selector_select_iter() on one of the columns.
353 hildon_touch_selector_signals[CHANGED] =
354 g_signal_new ("changed",
355 G_OBJECT_CLASS_TYPE (class),
357 G_STRUCT_OFFSET (HildonTouchSelectorClass, changed),
359 g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
362 * HildonTouchSelector::columns-changed:
363 * @selector: the object which received the signal
365 * The "columns-changed" signal is emitted when the number
366 * of columns in the #HildonTouchSelector change.
370 hildon_touch_selector_signals[COLUMNS_CHANGED] =
371 g_signal_new ("columns-changed",
372 G_OBJECT_CLASS_TYPE (class),
373 G_SIGNAL_RUN_LAST, 0,
375 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
379 g_object_class_install_property (gobject_class, PROP_HAS_MULTIPLE_SELECTION,
380 g_param_spec_boolean ("has-multiple-selection",
381 "has multiple selection",
382 "Whether the widget has multiple "
383 "selection (like multiple columns, "
384 "multiselection mode, or multiple "
385 "internal widgets) and therefore "
386 "it may need a confirmation button, "
391 g_object_class_install_property (G_OBJECT_CLASS (gobject_class),
393 g_param_spec_boolean ("initial-scroll",
395 "Whether to scroll to the"
396 "current selection when"
397 "the selector is first"
400 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
402 /* style properties */
403 /* We need to ensure fremantle mode for the treeview in order to work
404 properly. This is not about the appearance, this is about behaviour */
405 gtk_rc_parse_string ("style \"fremantle-htst\" {\n"
406 " GtkWidget::hildon-mode = 1\n"
407 "} widget \"*.fremantle-htst\" style \"fremantle-htst\""
408 "widget_class \"*<HildonPannableArea>.GtkTreeView\" style :highest \"fremantle-htst\"");
410 g_type_class_add_private (object_class, sizeof (HildonTouchSelectorPrivate));
414 hildon_touch_selector_get_property (GObject * object,
416 GValue * value, GParamSpec * pspec)
418 HildonTouchSelectorPrivate *priv = HILDON_TOUCH_SELECTOR (object)->priv;
421 case PROP_HAS_MULTIPLE_SELECTION:
422 g_value_set_boolean (value,
423 hildon_touch_selector_has_multiple_selection (HILDON_TOUCH_SELECTOR (object)));
425 case PROP_INITIAL_SCROLL:
426 g_value_set_boolean (value, priv->initial_scroll);
429 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
435 hildon_touch_selector_set_property (GObject *object, guint prop_id,
436 const GValue *value, GParamSpec *pspec)
438 HildonTouchSelectorPrivate *priv = HILDON_TOUCH_SELECTOR (object)->priv;
441 case PROP_INITIAL_SCROLL:
442 priv->initial_scroll = g_value_get_boolean (value);
445 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
452 hildon_touch_selector_init (HildonTouchSelector * selector)
454 selector->priv = HILDON_TOUCH_SELECTOR_GET_PRIVATE (selector);
456 GTK_WIDGET_SET_FLAGS (GTK_WIDGET (selector), GTK_NO_WINDOW);
457 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (selector), FALSE);
459 selector->priv->columns = NULL;
461 selector->priv->print_func = NULL;
462 selector->priv->print_user_data = NULL;
463 selector->priv->print_destroy_func = NULL;
464 selector->priv->initial_scroll = TRUE;
465 selector->priv->hbox = gtk_hbox_new (FALSE, 0);
467 selector->priv->changed_blocked = FALSE;
469 gtk_box_pack_end (GTK_BOX (selector), selector->priv->hbox,
471 gtk_widget_show (selector->priv->hbox);
475 hildon_touch_selector_dispose (GObject * object)
477 GObjectClass *gobject_class;
479 hildon_touch_selector_set_print_func_full (HILDON_TOUCH_SELECTOR (object),
482 gobject_class = G_OBJECT_CLASS (hildon_touch_selector_parent_class);
484 if (gobject_class->dispose)
485 (* gobject_class->dispose) (object);
489 disconnect_model_handlers (HildonTouchSelectorColumn *col, HildonTouchSelector *selector)
491 g_signal_handlers_disconnect_by_func (col->priv->model,
492 on_row_changed, selector);
496 * IMPLEMENTATION NOTES:
497 * Some people sent questions regarding a missing dispose/finalize function on
498 * this widget that could lead to leak memory, so we will clarify this topic.
500 * This is not required as #HildonTouchSelector extends #GtkContainer. When the
501 * widget is freed, the #GtkContainer freeing memory functions are called. This
502 * process includes remove each widget individually, so all the widgets are
505 * In the same way, this widget redefines gtk_container->remove function, in
506 * order to free the column related information if it is required.
508 * Please take a look to hildon_touch_selector_remove for more information.
511 /*------------------------------ GtkContainer ------------------------------ */
514 * Required in order to free the column at the columns list
517 hildon_touch_selector_remove (GtkContainer * container, GtkWidget * widget)
519 HildonTouchSelector *selector = NULL;
521 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (container));
522 selector = HILDON_TOUCH_SELECTOR (container);
524 /* Remove the extra data related to the columns, if required. */
525 if (widget == selector->priv->hbox) {
526 g_slist_foreach (selector->priv->columns, (GFunc) disconnect_model_handlers, selector);
527 g_slist_foreach (selector->priv->columns, (GFunc) g_object_unref, NULL);
529 g_slist_free (selector->priv->columns);
531 selector->priv->columns = NULL;
533 g_debug ("Freeing a widget outside the columns logic");
536 /* Now remove the widget itself from the container */
537 GTK_CONTAINER_CLASS (hildon_touch_selector_parent_class)->remove (container, widget);
540 /* ------------------------------ PRIVATE METHODS ---------------------------- */
542 hildon_touch_selector_block_changed (HildonTouchSelector *selector)
544 selector->priv->changed_blocked = TRUE;
548 hildon_touch_selector_unblock_changed (HildonTouchSelector *selector)
550 selector->priv->changed_blocked = FALSE;
554 hildon_touch_selector_emit_value_changed (HildonTouchSelector *selector,
557 if (!selector->priv->changed_blocked) {
558 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
563 * default_print_func:
564 * @selector: a #HildonTouchSelector
566 * Default print function
568 * Returns: a new string that represents the selected items
573 _default_print_func (HildonTouchSelector * selector, gpointer user_data)
575 gchar *result = NULL;
577 gint num_columns = 0;
579 GtkTreeModel *model = NULL;
580 gchar *current_string = NULL;
582 HildonTouchSelectorSelectionMode mode;
584 GtkTreePath *current_path = NULL;
585 GList *selected_rows = NULL;
586 gint initial_value = 0;
587 gint text_column = -1;
588 HildonTouchSelectorColumn *column = NULL;
590 num_columns = hildon_touch_selector_get_num_columns (selector);
592 mode = hildon_touch_selector_get_column_selection_mode (selector);
594 if ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE)
595 && (num_columns > 0)) {
596 /* In this case we get the first column first */
597 selected_rows = hildon_touch_selector_get_selected_rows (selector, 0);
598 model = hildon_touch_selector_get_model (selector, 0);
599 column = hildon_touch_selector_get_column (selector, 0);
600 text_column = hildon_touch_selector_column_get_text_column (column);
602 result = g_strdup_printf ("(");
604 for (item = selected_rows; item; item = g_list_next (item)) {
605 current_path = item->data;
606 gtk_tree_model_get_iter (model, &iter, current_path);
608 if (text_column != -1) {
609 gtk_tree_model_get (model, &iter, text_column, ¤t_string, -1);
612 if (i < g_list_length (selected_rows) - 1) {
613 aux = g_strconcat (result, current_string, ",", NULL);
617 aux = g_strconcat (result, current_string, NULL);
622 if (current_string) {
623 g_free (current_string);
624 current_string = NULL;
630 aux = g_strconcat (result, ")", NULL);
634 g_list_foreach (selected_rows, (GFunc) (gtk_tree_path_free), NULL);
635 g_list_free (selected_rows);
641 for (i = initial_value; i < num_columns; i++) {
642 model = hildon_touch_selector_get_model (selector, i);
643 column = hildon_touch_selector_get_column (selector, i);
644 text_column = hildon_touch_selector_column_get_text_column (column);
646 if (hildon_touch_selector_get_selected (selector, i, &iter)) {
647 if (text_column == -1 ) {
648 g_warning ("Trying to use the default print function in HildonTouchSelector, but "
649 "\"text-column\" property is not set for HildonTouchSelectorColumn %p.", column);
650 current_string = NULL;
652 gtk_tree_model_get (model, &iter, text_column, ¤t_string, -1);
656 result = current_string;
658 aux = g_strconcat (result, ":", current_string, NULL);
660 g_free (current_string);
661 current_string = NULL;
671 _row_tapped_cb (GtkTreeView * tree_view, GtkTreePath * path, gpointer user_data)
673 HildonTouchSelector *selector = NULL;
674 HildonTouchSelectorColumn *column = NULL;
675 gint num_column = -1;
677 column = HILDON_TOUCH_SELECTOR_COLUMN (user_data);
678 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (column->priv->parent));
680 selector = column->priv->parent;
682 num_column = g_slist_index (selector->priv->columns, column);
684 hildon_touch_selector_emit_value_changed (selector, num_column);
688 static HildonTouchSelectorColumn *
689 _create_new_column (HildonTouchSelector * selector,
690 GtkTreeModel * model,
691 gboolean *emit_changed,
692 GtkCellRenderer * renderer, va_list args)
694 HildonTouchSelectorColumn *new_column = NULL;
695 GtkTreeViewColumn *tree_column = NULL;
696 GtkTreeView *tv = NULL;
697 GtkWidget *panarea = NULL;
698 GtkTreeSelection *selection = NULL;
703 tree_column = gtk_tree_view_column_new ();
705 if (renderer != NULL) {
706 gtk_tree_view_column_pack_start (tree_column, renderer, TRUE);
708 attribute = va_arg (args, gchar *);
709 while (attribute != NULL) {
710 value = va_arg (args, gint);
711 gtk_tree_view_column_add_attribute (tree_column, renderer, attribute,
713 attribute = va_arg (args, gchar *);
718 tv = GTK_TREE_VIEW (hildon_gtk_tree_view_new (HILDON_UI_MODE_EDIT));
720 tv = GTK_TREE_VIEW (gtk_tree_view_new ());
721 #endif /* MAEMO_GTK */
723 gtk_tree_view_set_enable_search (tv, FALSE);
724 GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (tv), GTK_CAN_FOCUS);
726 gtk_tree_view_set_model (tv, model);
727 g_signal_connect (model, "row-changed",
728 G_CALLBACK (on_row_changed), selector);
729 gtk_tree_view_set_rules_hint (tv, TRUE);
731 gtk_tree_view_append_column (GTK_TREE_VIEW (tv), tree_column);
733 new_column = g_object_new (HILDON_TYPE_TOUCH_SELECTOR_COLUMN, NULL);
734 new_column->priv->parent = selector;
736 panarea = hildon_pannable_area_new ();
738 g_object_set (G_OBJECT (panarea),
739 "initial-hint", FALSE, NULL);
741 gtk_container_add (GTK_CONTAINER (panarea), GTK_WIDGET (tv));
743 new_column->priv->model = model;
744 new_column->priv->tree_view = tv;
745 new_column->priv->panarea = panarea;
746 new_column->priv->realize_handler = 0;
747 new_column->priv->initial_path = NULL;
749 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
750 gtk_tree_selection_set_mode (selection, GTK_SELECTION_BROWSE);
752 /* select the first item */
753 *emit_changed = FALSE;
754 if (gtk_tree_model_get_iter_first (model, &iter)) {
755 gtk_tree_selection_select_iter (selection, &iter);
756 *emit_changed = TRUE;
759 gtk_widget_grab_focus (GTK_WIDGET (tv));
761 /* connect to the hildon-row-tapped signal connection */
762 g_signal_connect (G_OBJECT (tv), "hildon-row-tapped",
763 G_CALLBACK (_row_tapped_cb), new_column);
769 /* ------------------------ HildonTouchSelectorColumn implementation ---------------------- */
770 G_DEFINE_TYPE_WITH_CODE (HildonTouchSelectorColumn, hildon_touch_selector_column, G_TYPE_OBJECT,
771 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
772 hildon_touch_selector_column_cell_layout_init))
780 hildon_touch_selector_column_class_init (HildonTouchSelectorColumnClass *klass);
783 hildon_touch_selector_column_get_property (GObject *object, guint property_id,
784 GValue *value, GParamSpec *pspec);
787 hildon_touch_selector_column_set_property (GObject *object, guint property_id,
788 const GValue *value, GParamSpec *pspec);
792 hildon_touch_selector_column_class_init (HildonTouchSelectorColumnClass *klass)
794 GObjectClass *gobject_class = NULL;
796 gobject_class = G_OBJECT_CLASS (klass);
798 g_type_class_add_private (gobject_class, sizeof (HildonTouchSelectorColumnPrivate));
801 gobject_class->get_property = hildon_touch_selector_column_get_property;
802 gobject_class->set_property = hildon_touch_selector_column_set_property;
804 g_object_class_install_property (G_OBJECT_CLASS(klass),
806 g_param_spec_int ("text-column",
808 "A column in the data source model to get the strings from.",
816 hildon_touch_selector_column_init (HildonTouchSelectorColumn *column)
818 column->priv = G_TYPE_INSTANCE_GET_PRIVATE (column, HILDON_TYPE_TOUCH_SELECTOR_COLUMN,
819 HildonTouchSelectorColumnPrivate);
820 column->priv->text_column = -1;
824 * hildon_touch_selector_column_set_text_column:
825 * @column: A #HildonTouchSelectorColumn
826 * @text_column: the index of a model column in the model for @column.
828 * Sets the model column to be displayed in @column. @text_column must point to a
829 * column in the model used with type %G_TYPE_STRING. Initially, this property
830 * is unset. You should set it before using the #HildonTouchSelector that uses
836 hildon_touch_selector_column_set_text_column (HildonTouchSelectorColumn *column,
839 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (column));
840 g_return_if_fail (text_column >= -1);
842 column->priv->text_column = text_column;
844 g_object_notify (G_OBJECT (column), "text-column");
848 * hildon_touch_selector_column_get_text_column:
849 * @column: a #HildonTouchSelectorColumn
851 * Gets the model column set as the text source for @column.
853 * Returns: the index of the text column for @column, or -1 if unset.
858 hildon_touch_selector_column_get_text_column (HildonTouchSelectorColumn *column)
860 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (column), -1);
862 return column->priv->text_column;
866 hildon_touch_selector_column_get_property (GObject *object, guint property_id,
867 GValue *value, GParamSpec *pspec)
869 switch (property_id) {
870 case PROP_TEXT_COLUMN:
871 g_value_set_int (value,
872 hildon_touch_selector_column_get_text_column (HILDON_TOUCH_SELECTOR_COLUMN (object)));
875 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
880 hildon_touch_selector_column_set_property (GObject *object, guint property_id,
881 const GValue *value, GParamSpec *pspec)
883 switch (property_id) {
884 case PROP_TEXT_COLUMN:
885 hildon_touch_selector_column_set_text_column (HILDON_TOUCH_SELECTOR_COLUMN (object),
886 g_value_get_int (value));
889 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
893 /* ------------------------ GtkCellLayout implementation -------------------- */
895 hildon_touch_selector_column_cell_layout_init (GtkCellLayoutIface *iface)
897 iface->pack_start = hildon_touch_selector_column_cell_layout_pack_start;
898 iface->pack_end = hildon_touch_selector_column_cell_layout_pack_end;
899 iface->clear = hildon_touch_selector_column_cell_layout_clear;
900 iface->add_attribute = hildon_touch_selector_column_cell_layout_add_attribute;
901 iface->set_cell_data_func = hildon_touch_selector_column_cell_layout_set_cell_data_func;
902 iface->clear_attributes = hildon_touch_selector_column_cell_layout_clear_attributes;
903 iface->reorder = hildon_touch_selector_column_cell_layout_reorder;
904 iface->get_cells = hildon_touch_selector_column_cell_layout_get_cells;
908 hildon_touch_selector_column_cell_layout_pack_start (GtkCellLayout *cell_layout,
909 GtkCellRenderer *cell,
912 HildonTouchSelectorColumn *sel_column = NULL;
913 GtkTreeViewColumn *view_column = NULL;
915 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
916 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
918 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
920 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT(view_column), cell, expand);
925 hildon_touch_selector_column_cell_layout_pack_end (GtkCellLayout *cell_layout,
926 GtkCellRenderer *cell,
929 HildonTouchSelectorColumn *sel_column = NULL;
930 GtkTreeViewColumn *view_column = NULL;
932 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
933 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
935 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
937 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT(view_column), cell, expand);
941 hildon_touch_selector_column_cell_layout_clear (GtkCellLayout *cell_layout)
943 HildonTouchSelectorColumn *sel_column = NULL;
944 GtkTreeViewColumn *view_column = NULL;
946 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
947 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
949 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
951 gtk_cell_layout_clear (GTK_CELL_LAYOUT(view_column));
955 hildon_touch_selector_column_cell_layout_add_attribute (GtkCellLayout *cell_layout,
956 GtkCellRenderer *cell,
957 const gchar *attribute,
960 HildonTouchSelectorColumn *sel_column = NULL;
961 GtkTreeViewColumn *view_column = NULL;
963 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
964 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
966 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
968 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT(view_column), cell, attribute, column);
973 hildon_touch_selector_column_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
974 GtkCellRenderer *cell,
975 GtkCellLayoutDataFunc func,
977 GDestroyNotify destroy)
979 HildonTouchSelectorColumn *sel_column = NULL;
980 GtkTreeViewColumn *view_column = NULL;
982 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
983 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
985 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
987 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT(view_column), cell, func,
992 hildon_touch_selector_column_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
993 GtkCellRenderer *cell)
995 HildonTouchSelectorColumn *sel_column = NULL;
996 GtkTreeViewColumn *view_column = NULL;
998 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
999 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
1001 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
1003 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (view_column), cell);
1007 hildon_touch_selector_column_cell_layout_reorder (GtkCellLayout *cell_layout,
1008 GtkCellRenderer *cell,
1011 HildonTouchSelectorColumn *sel_column = NULL;
1012 GtkTreeViewColumn *view_column = NULL;
1014 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
1015 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
1017 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
1019 gtk_cell_layout_reorder (GTK_CELL_LAYOUT(view_column), cell, position);
1023 hildon_touch_selector_column_cell_layout_get_cells (GtkCellLayout *cell_layout)
1025 HildonTouchSelectorColumn *sel_column = NULL;
1026 GtkTreeViewColumn *view_column = NULL;
1028 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout), NULL);
1029 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
1031 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
1033 return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT(view_column));
1036 /* ------------------------------ PUBLIC METHODS ---------------------------- */
1039 * hildon_touch_selector_new:
1041 * Creates a new empty #HildonTouchSelector.
1043 * Returns: a new #HildonTouchSelector.
1048 hildon_touch_selector_new (void)
1050 return g_object_new (HILDON_TYPE_TOUCH_SELECTOR, NULL);
1054 * hildon_touch_selector_new_text:
1056 * Creates a #HildonTouchSelector with a single text column that
1057 * can be populated conveniently through hildon_touch_selector_append_text(),
1058 * hildon_touch_selector_prepend_text(), hildon_touch_selector_insert_text().
1060 * Returns: A new #HildonTouchSelector
1065 hildon_touch_selector_new_text (void)
1067 GtkWidget *selector;
1068 GtkListStore *store;
1069 HildonTouchSelectorColumn *column = NULL;
1071 selector = hildon_touch_selector_new ();
1072 store = gtk_list_store_new (1, G_TYPE_STRING);
1074 column = hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
1075 GTK_TREE_MODEL (store), TRUE);
1077 hildon_touch_selector_column_set_text_column (column, 0);
1083 * hildon_touch_selector_append_text:
1084 * @selector: A #HildonTouchSelector.
1085 * @text: a non %NULL text string.
1087 * Appends a new entry in a #HildonTouchSelector created with
1088 * hildon_touch_selector_new_text().
1093 hildon_touch_selector_append_text (HildonTouchSelector * selector,
1097 GtkTreeModel *model;
1099 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1100 g_return_if_fail (text != NULL);
1102 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1104 g_return_if_fail (GTK_IS_LIST_STORE (model));
1106 gtk_list_store_append (GTK_LIST_STORE (model), &iter);
1107 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1111 * hildon_touch_selector_prepend_text:
1112 * @selector: A #HildonTouchSelector.
1113 * @text: a non %NULL text string.
1115 * Prepends a new entry in a #HildonTouchSelector created with
1116 * hildon_touch_selector_new_text().
1121 hildon_touch_selector_prepend_text (HildonTouchSelector * selector,
1125 GtkTreeModel *model;
1127 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1128 g_return_if_fail (text != NULL);
1130 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1132 g_return_if_fail (GTK_IS_LIST_STORE (model));
1134 gtk_list_store_prepend (GTK_LIST_STORE (model), &iter);
1135 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1139 * hildon_touch_selector_insert_text:
1140 * @selector: a #HildonTouchSelector.
1141 * @position: the position to insert @text.
1142 * @text: A non %NULL text string.
1144 * Inserts a new entry in a particular position of a
1145 * #HildonTouchSelector created with hildon_touch_selector_new_text().
1150 hildon_touch_selector_insert_text (HildonTouchSelector * selector,
1151 gint position, const gchar * text)
1154 GtkTreeModel *model;
1156 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1157 g_return_if_fail (text != NULL);
1158 g_return_if_fail (position >= 0);
1160 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1162 g_return_if_fail (GTK_IS_LIST_STORE (model));
1164 gtk_list_store_insert (GTK_LIST_STORE (model), &iter, position);
1165 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1169 * hildon_touch_selector_append_column
1170 * @selector: a #HildonTouchSelector
1171 * @model: the #GtkTreeModel with the data of the column
1172 * @cell_renderer: The #GtkCellRenderer where to draw each row contents.
1173 * @Varargs: a %NULL-terminated pair of attributes and column numbers.
1175 * This functions adds a new column to the widget, whose data will
1176 * be obtained from the model. Only widgets added this way should used on
1177 * the selection logic, the print function, the #HildonTouchSelector::changed
1178 * signal, etc. Internally, a #GtkTreeView will be added to the widget, using
1179 * @model as the data source.
1181 * You can optionally pass a #GtkCellRenderer in @cell_renderer,
1182 * together with a %NULL-terminated list of pairs property/value, in
1183 * the same way you would use gtk_tree_view_column_set_attributes().
1184 * This will pack @cell_renderer at the start of the column, expanded
1185 * by default. If you prefer not to add it this way, you can simply
1186 * pass %NULL to @cell_renderer and use the #GtkCellLayout interface
1187 * on the returned #HildonTouchSelectorColumn to set your
1188 * renderers. Please note that the returned #HildonTouchSelectorColumn
1189 * is owned by @selector, you shouldn't unref it after setting it
1192 * Initially, the returned #HildonTouchSelectorColumn will have its
1193 * #HildonTouchSelectorColumn:text-column property unset. You should set
1194 * it to a column in @model with type %G_TYPE_STRING. See
1195 * hildon_touch_selector_column_set_text_column().
1197 * Returns: the new column added added, %NULL otherwise.
1202 HildonTouchSelectorColumn*
1203 hildon_touch_selector_append_column (HildonTouchSelector * selector,
1204 GtkTreeModel * model,
1205 GtkCellRenderer * cell_renderer, ...)
1208 HildonTouchSelectorColumn *new_column = NULL;
1209 gboolean emit_changed = FALSE;
1212 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1213 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1215 if (model != NULL) {
1217 va_start (args, cell_renderer);
1218 new_column = _create_new_column (selector, model, &emit_changed, cell_renderer, args);
1221 selector->priv->columns = g_slist_append (selector->priv->columns,
1223 gtk_box_pack_start (GTK_BOX (selector->priv->hbox),
1224 new_column->priv->panarea,
1227 gtk_widget_show_all (new_column->priv->panarea);
1229 if (selector->priv->initial_scroll) {
1230 _hildon_touch_selector_center_on_selected_items (selector, new_column);
1237 g_signal_emit (selector, hildon_touch_selector_signals[COLUMNS_CHANGED], 0);
1239 colnum = g_slist_length (selector->priv->columns);
1240 hildon_touch_selector_emit_value_changed (selector, colnum);
1247 * hildon_touch_selector_append_text_column
1248 * @selector: a #HildonTouchSelector
1249 * @model: a #GtkTreeModel with data for the column
1250 * @center: whether to center the text on the column
1252 * Equivalent to hildon_touch_selector_append_column(), but using a
1253 * default text cell renderer. This is the most common use case of the
1256 * Returns: the new column added, NULL otherwise.
1260 HildonTouchSelectorColumn*
1261 hildon_touch_selector_append_text_column (HildonTouchSelector * selector,
1262 GtkTreeModel * model, gboolean center)
1264 gfloat xalign = center ? 0.5 : 0.0;
1265 GtkCellRenderer *renderer;
1267 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1268 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1270 renderer = gtk_cell_renderer_text_new ();
1272 g_object_set (renderer,
1277 return hildon_touch_selector_append_column (selector, model, renderer,
1282 * hildon_touch_selector_remove_column:
1283 * @selector: a #HildonTouchSelector
1284 * @column: the position of the column to be removed
1286 * Removes a column from @selector.
1288 * Returns: %TRUE if the column was removed, %FALSE otherwise
1293 hildon_touch_selector_remove_column (HildonTouchSelector * selector, gint column)
1295 HildonTouchSelectorColumn *current_column = NULL;
1296 HildonTouchSelectorPrivate *priv;
1298 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
1299 g_return_val_if_fail (column <
1300 hildon_touch_selector_get_num_columns (selector), FALSE);
1302 priv = HILDON_TOUCH_SELECTOR_GET_PRIVATE (selector);
1303 current_column = g_slist_nth_data (priv->columns, column);
1305 gtk_container_remove (GTK_CONTAINER (priv->hbox), current_column->priv->panarea);
1306 priv->columns = g_slist_remove (priv->columns, current_column);
1307 g_object_unref (current_column);
1309 g_signal_emit (selector, hildon_touch_selector_signals[COLUMNS_CHANGED], 0);
1315 * hildon_touch_selector_set_column_attributes:
1316 * @selector: a #HildonTouchSelector
1317 * @num_column: the number of the column whose attributes we're setting
1318 * @cell_renderer: the #GtkCellRendere we're setting the attributes of
1319 * @Varargs: A %NULL-terminated list of attributes.
1321 * Sets the attributes for the given column. The attributes must be given
1322 * in attribute/column pairs, just like in gtk_tree_view_column_set_attributes().
1323 * All existing attributes are removed and replaced with the new ones.
1325 * Deprecated: #HildonTouchSelectorColumn implements #GtkCellLayout, use this
1326 * interface instead. See
1327 * hildon_touch_selector_get_column().
1332 hildon_touch_selector_set_column_attributes (HildonTouchSelector * selector,
1334 GtkCellRenderer * cell_renderer,
1338 GtkTreeViewColumn *tree_column = NULL;
1339 HildonTouchSelectorColumn *current_column = NULL;
1340 gchar *attribute = NULL;
1343 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1344 g_return_if_fail (num_column <
1345 hildon_touch_selector_get_num_columns (selector));
1347 current_column = g_slist_nth_data (selector->priv->columns, num_column);
1349 tree_column = gtk_tree_view_get_column (current_column->priv->tree_view, 0);
1350 gtk_tree_view_remove_column (current_column->priv->tree_view, tree_column);
1352 tree_column = gtk_tree_view_column_new ();
1353 gtk_tree_view_column_pack_start (tree_column, cell_renderer, TRUE);
1355 va_start (args, cell_renderer);
1356 attribute = va_arg (args, gchar *);
1358 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1360 while (attribute != NULL) {
1361 value = va_arg (args, gint);
1362 gtk_tree_view_column_add_attribute (tree_column, cell_renderer,
1364 attribute = va_arg (args, gchar *);
1369 gtk_tree_view_append_column (current_column->priv->tree_view, tree_column);
1373 * hildon_touch_selector_get_num_columns:
1374 * @selector: a #HildonTouchSelector
1376 * Gets the number of columns in the #HildonTouchSelector.
1378 * Returns: the number of columns in @selector.
1383 hildon_touch_selector_get_num_columns (HildonTouchSelector * selector)
1385 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), -1);
1387 return g_slist_length (selector->priv->columns);
1391 * hildon_touch_selector_get_column_selection_mode:
1392 * @selector: a #HildonTouchSelector
1394 * Gets the selection mode of @selector.
1396 * Returns: one of #HildonTouchSelectorSelectionMode
1400 HildonTouchSelectorSelectionMode
1401 hildon_touch_selector_get_column_selection_mode (HildonTouchSelector * selector)
1403 HildonTouchSelectorSelectionMode result =
1404 HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE;
1405 GtkSelectionMode treeview_mode = GTK_SELECTION_BROWSE;
1406 HildonTouchSelectorColumn *column = NULL;
1407 GtkTreeSelection *selection = NULL;
1409 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), result);
1410 g_return_val_if_fail (hildon_touch_selector_get_num_columns (selector) > 0,
1413 column = HILDON_TOUCH_SELECTOR_COLUMN (selector->priv->columns->data);
1415 selection = gtk_tree_view_get_selection (column->priv->tree_view);
1416 treeview_mode = gtk_tree_selection_get_mode (selection);
1419 if (treeview_mode == GTK_SELECTION_MULTIPLE) {
1420 result = HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE;
1422 result = HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE;
1429 * hildon_touch_selector_set_column_selection_mode:
1430 * @selector: a #HildonTouchSelector
1431 * @mode: the #HildonTouchSelectorMode for @selector
1433 * Sets the selection mode for @selector. See #HildonTouchSelectorSelectionMode.
1438 hildon_touch_selector_set_column_selection_mode (HildonTouchSelector * selector,
1439 HildonTouchSelectorSelectionMode mode)
1441 GtkTreeView *tv = NULL;
1442 HildonTouchSelectorColumn *column = NULL;
1443 GtkTreeSelection *selection = NULL;
1444 GtkSelectionMode treeview_mode = GTK_SELECTION_MULTIPLE;
1446 HildonTouchSelectorSelectionMode current_mode;
1448 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1449 g_return_if_fail (hildon_touch_selector_get_num_columns (selector) > 0);
1451 current_mode = hildon_touch_selector_get_column_selection_mode (selector);
1453 if (current_mode == mode) {
1457 column = HILDON_TOUCH_SELECTOR_COLUMN ((g_slist_nth (selector->priv->columns, 0))->data);
1458 tv = column->priv->tree_view;
1462 case HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE:
1463 treeview_mode = GTK_SELECTION_BROWSE;
1465 case HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE:
1466 treeview_mode = GTK_SELECTION_MULTIPLE;
1470 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
1471 gtk_tree_selection_set_mode (selection, treeview_mode);
1473 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
1474 gtk_tree_model_get_iter_first (column->priv->model, &iter);
1475 gtk_tree_selection_unselect_all (selection);
1476 gtk_tree_selection_select_iter (selection, &iter);
1478 /* the column changed was the first one */
1479 hildon_touch_selector_emit_value_changed (selector, 0);
1485 * hildon_touch_selector_set_print_func:
1486 * @selector: a #HildonTouchSelector
1487 * @func: a #HildonTouchSelectorPrintFunc function
1489 * Sets the function to be used by hildon_touch_selector_get_current_text().
1490 * See hildon_touch_selector_set_print_func_full().
1495 hildon_touch_selector_set_print_func (HildonTouchSelector * selector,
1496 HildonTouchSelectorPrintFunc func)
1498 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1500 hildon_touch_selector_set_print_func_full (selector, func, NULL, NULL);
1504 * hildon_touch_selector_set_print_func_full:
1505 * @selector: a #HildonTouchSelector
1506 * @func: a #HildonTouchSelectorPrintFunc function
1507 * @user_data: a pointer to user data or %NULL
1508 * @destroy_func: a callback for freeing the user data or %NULL
1510 * Sets the function to be used by hildon_touch_selector_get_current_text()
1511 * to produce a text representation of the currently selected items in @selector.
1512 * The default function will return a concatenation of comma separated items
1513 * selected in each column in @selector. Use this to override this method if you
1514 * need a particular representation for your application.
1519 hildon_touch_selector_set_print_func_full (HildonTouchSelector *selector,
1520 HildonTouchSelectorPrintFunc func,
1522 GDestroyNotify destroy_func)
1524 gpointer old_user_data;
1525 GDestroyNotify old_destroy_func;
1527 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1529 old_user_data = selector->priv->print_user_data;
1530 old_destroy_func = selector->priv->print_destroy_func;
1532 selector->priv->print_func = func;
1533 selector->priv->print_user_data = user_data;
1534 selector->priv->print_destroy_func = destroy_func;
1536 if (old_destroy_func && old_user_data != user_data)
1537 (*old_destroy_func) (old_user_data);
1541 * hildon_touch_selector_get_print_func:
1542 * @selector: a #HildonTouchSelector
1544 * Gets the #HildonTouchSelectorPrintFunc currently used. See
1545 * hildon_touch_selector_set_print_func().
1547 * Returns: a #HildonTouchSelectorPrintFunc or %NULL if the default
1548 * one is currently used.
1550 HildonTouchSelectorPrintFunc
1551 hildon_touch_selector_get_print_func (HildonTouchSelector * selector)
1553 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1555 return selector->priv->print_func;
1559 * hildon_touch_selector_set_active:
1560 * @selector: a #HildonTouchSelector
1561 * @column: column number
1562 * @index: the index of the item to select, or -1 to have no active item
1564 * Sets the active item of the #HildonTouchSelector to @index. The
1565 * column number is taken from @column.
1567 * @selector must be in %HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE
1572 hildon_touch_selector_set_active (HildonTouchSelector *selector,
1576 GtkTreeSelection *selection = NULL;
1577 HildonTouchSelectorColumn *current_column = NULL;
1578 HildonTouchSelectorSelectionMode mode;
1581 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1582 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1583 mode = hildon_touch_selector_get_column_selection_mode (selector);
1584 g_return_if_fail (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE);
1586 current_column = g_slist_nth_data (selector->priv->columns, column);
1588 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1589 path = gtk_tree_path_new_from_indices (index, -1);
1590 gtk_tree_selection_unselect_all (selection);
1592 gtk_tree_selection_select_path (selection, path);
1594 hildon_touch_selector_emit_value_changed (selector, column);
1596 gtk_tree_path_free (path);
1600 * hildon_touch_selector_get_active:
1601 * @selector: a #HildonTouchSelector
1602 * @column: column number
1604 * Returns the index of the currently active item in column number
1605 * @column, or -1 if there's no active item.
1607 * @selector must be in %HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE
1609 * Returns: an integer which is the index of the currently active
1610 * item, or -1 if there's no active item.
1615 hildon_touch_selector_get_active (HildonTouchSelector *selector,
1618 GtkTreeSelection *selection = NULL;
1619 HildonTouchSelectorColumn *current_column = NULL;
1620 HildonTouchSelectorSelectionMode mode;
1621 GtkTreeModel *model;
1626 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), -1);
1627 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector), -1);
1628 mode = hildon_touch_selector_get_column_selection_mode (selector);
1629 g_return_val_if_fail (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE, -1);
1631 current_column = g_slist_nth_data (selector->priv->columns, column);
1633 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1634 g_return_val_if_fail (gtk_tree_selection_get_selected (selection, NULL, &iter), -1);
1636 model = gtk_tree_view_get_model (GTK_TREE_VIEW (current_column->priv->tree_view));
1637 path = gtk_tree_model_get_path (model, &iter);
1638 index = (gtk_tree_path_get_indices (path))[0];
1640 gtk_tree_path_free (path);
1646 * hildon_touch_selector_get_selected:
1647 * @selector: a #HildonTouchSelector
1648 * @column: the column number we want to get the element
1649 * @iter: #GtkTreeIter currently selected
1651 * Sets @iter to the currently selected node on the nth-column, if selection is
1652 * set to %HILDON_TOUCH_SELECTOR_SINGLE or %HILDON_TOUCH_SELECTOR_MULTIPLE with
1653 * a column different that the first one. @iter may be %NULL if you just want to
1654 * test if selection has any selected items.
1656 * This function will not work if selection is in
1657 * %HILDON_TOUCH_SELECTOR_MULTIPLE mode and the column is the first one.
1659 * See gtk_tree_selection_get_selected() for more information.
1661 * Returns: %TRUE if @iter was correctly set, %FALSE otherwise
1666 hildon_touch_selector_get_selected (HildonTouchSelector * selector,
1667 gint column, GtkTreeIter * iter)
1669 GtkTreeSelection *selection = NULL;
1670 HildonTouchSelectorColumn *current_column = NULL;
1671 HildonTouchSelectorSelectionMode mode;
1673 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
1674 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1676 mode = hildon_touch_selector_get_column_selection_mode (selector);
1677 g_return_val_if_fail
1678 ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE) ||
1679 ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE)&&(column>0)),
1682 current_column = g_slist_nth_data (selector->priv->columns, column);
1685 gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1687 return gtk_tree_selection_get_selected (selection, NULL, iter);
1691 * hildon_touch_selector_select_iter
1692 * @selector: a #HildonTouchSelector
1693 * @column: the column to selects
1694 * @iter: the #GtkTreeIter to be selected
1695 * @scroll_to: whether to smoothly scroll to the item
1697 * Sets the currently selected item in the column @column to the one pointed by @iter,
1698 * optionally smoothly scrolling to it.
1703 hildon_touch_selector_select_iter (HildonTouchSelector * selector,
1704 gint column, GtkTreeIter * iter,
1708 GtkTreeModel *model;
1709 HildonTouchSelectorColumn *current_column = NULL;
1710 GtkTreeView *tv = NULL;
1711 GtkTreeSelection *selection = NULL;
1713 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1714 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1716 current_column = g_slist_nth_data (selector->priv->columns, column);
1718 tv = current_column->priv->tree_view;
1719 selection = gtk_tree_view_get_selection (tv);
1720 model = gtk_tree_view_get_model (tv);
1721 path = gtk_tree_model_get_path (model, iter);
1723 gtk_tree_selection_select_iter (selection, iter);
1726 hildon_touch_selector_scroll_to (current_column, tv, path);
1729 hildon_touch_selector_emit_value_changed (selector, column);
1731 gtk_tree_path_free (path);
1735 * hildon_touch_selector_unselect_iter
1736 * @selector: a #HildonTouchSelector
1737 * @column: the column to unselects from
1738 * @iter: the #GtkTreeIter to be unselected
1740 * Unselect the item pointed by @iter in the column @column
1745 void hildon_touch_selector_unselect_iter (HildonTouchSelector * selector,
1749 HildonTouchSelectorColumn *current_column = NULL;
1750 GtkTreeSelection *selection = NULL;
1752 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1753 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1755 current_column = g_slist_nth_data (selector->priv->columns, column);
1756 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1757 gtk_tree_selection_unselect_iter (selection, iter);
1759 hildon_touch_selector_emit_value_changed (selector, column);
1763 * hildon_touch_selector_unselect_all:
1764 * @selector: a #HildonTouchSelector
1765 * @column: the position of the column to get the selected rows from
1767 * Unselects all the selected items in the column @column.
1772 hildon_touch_selector_unselect_all (HildonTouchSelector * selector,
1775 HildonTouchSelectorColumn *current_column = NULL;
1776 GtkTreeSelection *selection = NULL;
1778 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1779 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1781 current_column = g_slist_nth_data (selector->priv->columns, column);
1782 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1783 gtk_tree_selection_unselect_all (selection);
1785 hildon_touch_selector_emit_value_changed (selector, column);
1789 * hildon_touch_selector_get_selected_rows:
1790 * @selector: a #HildonTouchSelector
1791 * @column: the position of the column to get the selected rows from
1793 * Creates a list of #GtkTreePath<!-- -->s of all selected rows in a column. Additionally,
1794 * if you to plan to modify the model after calling this function, you may
1795 * want to convert the returned list into a list of GtkTreeRowReferences. To do this,
1796 * you can use gtk_tree_row_reference_new().
1798 * See gtk_tree_selection_get_selected_rows() for more information.
1800 * Returns: A new #GList containing a #GtkTreePath for each selected row in the column @column.
1805 hildon_touch_selector_get_selected_rows (HildonTouchSelector * selector,
1808 GList *result = NULL;
1809 HildonTouchSelectorColumn *current_column = NULL;
1810 GtkTreeSelection *selection = NULL;
1812 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1813 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1816 current_column = g_slist_nth_data (selector->priv->columns, column);
1817 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1819 result = gtk_tree_selection_get_selected_rows (selection, NULL);
1825 * hildon_touch_selector_get_model:
1826 * @selector: a #HildonTouchSelector
1827 * @column: the position of the column in @selector
1829 * Gets the model of a column of @selector.
1831 * Returns: the #GtkTreeModel for the column @column of @selector.
1836 hildon_touch_selector_get_model (HildonTouchSelector * selector, gint column)
1838 HildonTouchSelectorColumn *current_column = NULL;
1840 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1841 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1844 current_column = g_slist_nth_data (selector->priv->columns, column);
1846 return current_column->priv->model;
1850 on_row_changed (GtkTreeModel *model,
1855 HildonTouchSelector *selector;
1856 HildonTouchSelectorColumn *current_column;
1861 selector = HILDON_TOUCH_SELECTOR (userdata);
1863 for (col = selector->priv->columns; col != NULL; col = col->next) {
1864 current_column = HILDON_TOUCH_SELECTOR_COLUMN (col->data);
1865 if (current_column->priv->model == model &&
1866 gtk_tree_selection_path_is_selected (gtk_tree_view_get_selection (current_column->priv->tree_view),
1868 hildon_touch_selector_emit_value_changed (selector, column);
1875 _hildon_touch_selector_set_model (HildonTouchSelector * selector,
1876 gint column, GtkTreeModel * model)
1878 HildonTouchSelectorColumn *current_column = NULL;
1881 HILDON_TOUCH_SELECTOR_COLUMN (g_slist_nth_data (selector->priv->columns, column));
1883 if (current_column->priv->model) {
1884 g_signal_handlers_disconnect_by_func (current_column->priv->model,
1885 on_row_changed, selector);
1887 current_column->priv->model = model;
1888 gtk_tree_view_set_model (current_column->priv->tree_view,
1889 current_column->priv->model);
1890 g_signal_connect (model, "row-changed",
1891 G_CALLBACK (on_row_changed), selector);
1895 * hildon_touch_selector_set_model:
1896 * @selector: a #HildonTouchSelector
1897 * @column: the position of the column to set the model to
1898 * @model: a #GtkTreeModel
1900 * Sets the #GtkTreeModel for a particular column in @model.
1905 hildon_touch_selector_set_model (HildonTouchSelector * selector,
1906 gint column, GtkTreeModel * model)
1908 g_return_if_fail (HILDON_TOUCH_SELECTOR (selector));
1909 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1911 HILDON_TOUCH_SELECTOR_GET_CLASS (selector)->set_model (selector, column, model);
1915 * hildon_touch_selector_get_current_text:
1916 * @selector: a #HildonTouchSelector
1918 * Returns a string representing the currently selected items for
1919 * each column of @selector. See hildon_touch_selector_set_print_func().
1921 * Returns: a newly allocated string.
1926 hildon_touch_selector_get_current_text (HildonTouchSelector * selector)
1928 gchar *result = NULL;
1929 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1931 if (selector->priv->print_func) {
1932 result = (*selector->priv->print_func) (selector, selector->priv->print_user_data);
1934 result = _default_print_func (selector, NULL);
1941 search_nearest_element (HildonPannableArea *panarea,
1943 GList *selected_rows,
1944 GtkTreePath **nearest_path)
1946 GtkAdjustment *adj = NULL;
1947 gdouble target_value = 0;
1950 GtkTreePath *path = NULL;
1952 gdouble nearest_distance = -1;
1953 gdouble current_distance = -1;
1954 GtkTreePath *result_path = NULL;
1956 g_assert (nearest_path != NULL);
1958 if (selected_rows == NULL) {
1959 *nearest_path = NULL;
1963 adj = hildon_pannable_area_get_vadjustment (panarea);
1964 g_return_if_fail (adj != NULL);
1966 /* we add this in order to check the nearest to the center of
1968 target_value = gtk_adjustment_get_value (adj) + adj->page_size/2;
1970 path = result_path = selected_rows->data;
1971 gtk_tree_view_get_background_area (tv, path, NULL, &rect);
1972 gtk_tree_view_convert_bin_window_to_tree_coords (tv, 0, rect.y, NULL, &y);
1973 nearest_distance = abs (target_value - y);
1975 for (iter = selected_rows->next; iter; iter = g_list_next (iter)) {
1976 gtk_tree_view_get_background_area (tv, path, NULL, &rect);
1977 gtk_tree_view_convert_bin_window_to_tree_coords (tv, 0, rect.y, NULL, &y);
1978 current_distance = abs (target_value - y);
1979 if (current_distance < nearest_distance) {
1980 nearest_distance = current_distance;
1985 *nearest_path = result_path;
1989 on_realize_cb (GtkWidget *widget,
1992 HildonTouchSelectorColumn *column = NULL;
1996 column = HILDON_TOUCH_SELECTOR_COLUMN (data);
1998 if (column->priv->initial_path) {
1999 gtk_tree_view_get_background_area (GTK_TREE_VIEW (column->priv->tree_view),
2000 column->priv->initial_path, NULL, &rect);
2001 gtk_tree_view_convert_bin_window_to_tree_coords
2002 (GTK_TREE_VIEW (column->priv->tree_view),
2003 0, rect.y, NULL, &y);
2005 hildon_pannable_area_scroll_to (HILDON_PANNABLE_AREA (column->priv->panarea),
2008 gtk_tree_path_free (column->priv->initial_path);
2010 column->priv->initial_path = NULL;
2014 g_signal_handler_disconnect (column->priv->panarea,
2015 column->priv->realize_handler);
2021 hildon_touch_selector_scroll_to (HildonTouchSelectorColumn *column,
2025 if (GTK_WIDGET_REALIZED (column->priv->panarea)) {
2029 gtk_tree_view_get_background_area (tv,
2031 gtk_tree_view_convert_bin_window_to_tree_coords (tv,
2032 0, rect.y, NULL, &y);
2034 hildon_pannable_area_scroll_to (HILDON_PANNABLE_AREA
2035 (column->priv->panarea), -1, y);
2037 if (column->priv->realize_handler != 0) {
2039 if (column->priv->initial_path) {
2040 gtk_tree_path_free (column->priv->initial_path);
2041 column->priv->initial_path = NULL;
2044 g_signal_handler_disconnect (column->priv->panarea,
2045 column->priv->realize_handler);
2046 column->priv->realize_handler = 0;
2049 column->priv->initial_path = gtk_tree_path_copy (path);
2050 column->priv->realize_handler =
2051 g_signal_connect_after (G_OBJECT (column->priv->panarea), "realize",
2052 G_CALLBACK (on_realize_cb),
2059 * Center on the selected item of a concrete column
2061 * Returns: TRUE if was able to do that
2065 _hildon_touch_selector_center_on_selected_items (HildonTouchSelector *selector,
2066 HildonTouchSelectorColumn *column)
2068 GtkTreePath *path = NULL;
2069 GList *selected_rows = NULL;
2070 gint num_column = -1;
2072 num_column = g_slist_index (selector->priv->columns, column);
2074 selected_rows = hildon_touch_selector_get_selected_rows (selector, num_column);
2075 if (selected_rows) {
2076 search_nearest_element (HILDON_PANNABLE_AREA (column->priv->panarea),
2077 GTK_TREE_VIEW (column->priv->tree_view),
2082 hildon_touch_selector_scroll_to (column,
2083 GTK_TREE_VIEW (column->priv->tree_view),
2089 g_list_foreach (selected_rows, (GFunc) (gtk_tree_path_free), NULL);
2090 g_list_free (selected_rows);
2097 _hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector)
2099 HildonTouchSelectorSelectionMode mode;
2102 n_columns = hildon_touch_selector_get_num_columns (selector);
2103 mode = hildon_touch_selector_get_column_selection_mode (selector);
2105 return ((n_columns > 1) || (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE));
2109 * hildon_touch_selector_has_multiple_selection:
2110 * @selector: A #HildonTouchSelector
2112 * Determines whether @selector is complex enough to actually require an
2113 * extra selection step than only picking an item. This is normally %TRUE
2114 * if @selector has multiple columns, multiple selection, or when it is a
2115 * more complex widget, like #HildonTouchSelectorEntry.
2117 * This information is useful for widgets containing a #HildonTouchSelector,
2118 * like #HildonPickerDialog, that could need a "Done" button, in case that
2119 * its internal #HildonTouchSelector has multiple columns, for instance.
2121 * Returns: %TRUE if @selector requires multiple selection steps.
2126 hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector)
2128 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
2130 return HILDON_TOUCH_SELECTOR_GET_CLASS (selector)->has_multiple_selection (selector);
2135 * hildon_touch_selector_get_column:
2136 * @selector: A #HildonTouchSelector
2137 * @column: a column number
2139 * Use this method to retrieve a #HildonTouchSelectorColumn. Then, you can use
2140 * the #GtkCellLayout interface to set up the layout of the column.
2142 * Returns: the @column<!-- -->-th #HildonTouchSelectorColumn in @selector
2146 HildonTouchSelectorColumn *
2147 hildon_touch_selector_get_column (HildonTouchSelector * selector,
2150 gint num_columns = -1;
2152 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
2153 num_columns = hildon_touch_selector_get_num_columns (selector);
2154 g_return_val_if_fail (column < num_columns && column >= 0, NULL);
2156 return g_slist_nth_data (selector->priv->columns, column);
2161 * hildon_touch_selector_center_on_selected:
2162 * @selector: a #HildonTouchSelector
2164 * Ensures all the columns in a #HildonTouchSelector show a selected
2165 * item. If one of the columns is in
2166 * %HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE mode, that column
2167 * will be scrolled to ensure the selected item that is closest to the
2168 * currently visible area is shown.
2173 hildon_touch_selector_center_on_selected (HildonTouchSelector *selector)
2175 GSList *iter = NULL;
2177 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
2179 for (iter = selector->priv->columns; iter; iter = g_slist_next (iter)) {
2180 _hildon_touch_selector_center_on_selected_items (selector,
2181 HILDON_TOUCH_SELECTOR_COLUMN (iter->data));
2186 * hildon_touch_selector_optimal_size_request
2187 * @selector: a #HildonTouchSelector
2188 * @requisition: a #GtkRequisition
2190 * Gets the optimal size request of the touch selector. This function is mostly
2191 * intended for dialog implementations that include a #HildonTouchSelector and
2192 * want to optimize the screen real state, for example, when you want a dialog
2193 * to show as much of the selector, avoiding any extra empty space below the
2196 * See #HildonPickerDialog implementation for an example.
2198 * This function is oriented to be used in the size_request of a dialog or window,
2199 * if you are not sure do not use it.
2201 * There is a precondition to this function: Since this function does not
2202 * call the "size_request" method, it can only be used when you know that
2203 * gtk_widget_size_request() has been called since the last time a resize was
2209 hildon_touch_selector_optimal_size_request (HildonTouchSelector *selector,
2210 GtkRequisition *requisition)
2212 GSList *iter = NULL;
2214 gint base_height = 0;
2216 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
2218 iter = selector->priv->columns;
2220 /* Default optimal values are the current ones */
2221 gtk_widget_get_child_requisition (GTK_WIDGET (selector),
2225 height = requisition->height;
2227 /* we use the normal requisition as base, as the touch selector can has
2228 extra widgets, not only the columns (ie: HildonTouchSelectorEntry) */
2229 base_height = requisition->height;
2232 /* Compute optimal height for the columns */
2234 HildonTouchSelectorColumn *column;
2236 GtkRequisition child_requisition = {0};
2238 column = HILDON_TOUCH_SELECTOR_COLUMN (iter->data);
2239 child = GTK_WIDGET (column->priv->tree_view);
2241 gtk_widget_get_child_requisition (child, &child_requisition);
2243 height = MAX (height, child_requisition.height);
2245 iter = g_slist_next (iter);
2248 requisition->height = base_height + height;