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 composition of each column in the selector is represented by 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 * g_object_set (G_OBJECT (column), "text-column", 0, NULL);
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 * #HildonTouchSelectorColumn object represents a visible column in
157 * #HildonTouchSelector. It allows to manage the cell renderers related to each
161 #undef HILDON_DISABLE_DEPRECATED
170 #include "hildon-gtk.h"
172 #include "hildon-pannable-area.h"
173 #include "hildon-touch-selector.h"
175 #define HILDON_TOUCH_SELECTOR_GET_PRIVATE(obj) \
176 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), HILDON_TYPE_TOUCH_SELECTOR, HildonTouchSelectorPrivate))
178 G_DEFINE_TYPE (HildonTouchSelector, hildon_touch_selector, GTK_TYPE_VBOX)
181 * IMPLEMENTATION NOTES:
182 * Struct to maintain the data of each column. The columns are the elements
183 * of the widget that belongs properly to the selection behaviour. Although
184 * internally the columns are arranged in a private #GtkHBox, as the selector
185 * itself is a #GtkVBox, you can add more widgets, like buttons etc., so
186 * you finally could have a widget with more elements that the columns, but
187 * this doesn't belongs to the selection logic
189 struct _HildonTouchSelectorColumnPrivate
191 HildonTouchSelector *parent; /* the selector that contains this column */
194 GtkTreeView *tree_view;
195 gulong realize_handler;
196 GtkTreePath *initial_path;
198 GtkWidget *panarea; /* the pannable widget */
201 struct _HildonTouchSelectorPrivate
203 GSList *columns; /* the selection columns */
204 GtkWidget *hbox; /* the container for the selector's columns */
205 gboolean initial_scroll; /* whether initial fancy scrolling to selection */
207 HildonTouchSelectorPrintFunc print_func;
208 gpointer print_user_data;
209 GDestroyNotify print_destroy_func;
214 PROP_HAS_MULTIPLE_SELECTION = 1,
225 static gint hildon_touch_selector_signals[LAST_SIGNAL] = { 0 };
228 hildon_touch_selector_dispose (GObject * object);
231 hildon_touch_selector_get_property (GObject * object,
236 hildon_touch_selector_set_property (GObject *object,
243 static void hildon_touch_selector_remove (GtkContainer * container,
245 /* private functions */
246 static void _row_tapped_cb (GtkTreeView * tree_view,
249 static gchar *_default_print_func (HildonTouchSelector * selector,
252 static HildonTouchSelectorColumn *_create_new_column (HildonTouchSelector * selector,
253 GtkTreeModel * model,
254 gboolean *emit_changed,
255 GtkCellRenderer * renderer,
258 on_realize_cb (GtkWidget *widget,
261 hildon_touch_selector_scroll_to (HildonTouchSelectorColumn *column,
265 _hildon_touch_selector_center_on_selected_items (HildonTouchSelector *selector,
266 HildonTouchSelectorColumn *column);
268 _hildon_touch_selector_set_model (HildonTouchSelector * selector,
270 GtkTreeModel * model);
272 _hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector);
274 /* GtkCellLayout implementation (HildonTouchSelectorColumn)*/
275 static void hildon_touch_selector_column_cell_layout_init (GtkCellLayoutIface *iface);
277 static void hildon_touch_selector_column_cell_layout_pack_start (GtkCellLayout *cell_layout,
278 GtkCellRenderer *cell,
280 static void hildon_touch_selector_column_cell_layout_pack_end (GtkCellLayout *cell_layout,
281 GtkCellRenderer *cell,
283 static void hildon_touch_selector_column_cell_layout_clear (GtkCellLayout *cell_layout);
284 static void hildon_touch_selector_column_cell_layout_add_attribute(GtkCellLayout *cell_layout,
285 GtkCellRenderer *cell,
286 const gchar *attribute,
288 static void hildon_touch_selector_column_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
289 GtkCellRenderer *cell,
290 GtkCellLayoutDataFunc func,
292 GDestroyNotify destroy);
293 static void hildon_touch_selector_column_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
294 GtkCellRenderer *cell);
295 static void hildon_touch_selector_column_cell_layout_reorder (GtkCellLayout *cell_layout,
296 GtkCellRenderer *cell,
298 static GList *hildon_touch_selector_column_cell_layout_get_cells (GtkCellLayout *cell_layout);
302 hildon_touch_selector_class_init (HildonTouchSelectorClass * class)
304 GObjectClass *gobject_class;
305 GtkObjectClass *object_class;
306 GtkContainerClass *container_class;
308 gobject_class = G_OBJECT_CLASS (class);
309 object_class = GTK_OBJECT_CLASS (class);
310 container_class = GTK_CONTAINER_CLASS (class);
313 gobject_class->dispose = hildon_touch_selector_dispose;
314 gobject_class->get_property = hildon_touch_selector_get_property;
315 gobject_class->set_property = hildon_touch_selector_set_property;
320 container_class->remove = hildon_touch_selector_remove;
322 /* HildonTouchSelector */
323 class->changed = NULL;
324 class->set_model = _hildon_touch_selector_set_model;
326 class->has_multiple_selection = _hildon_touch_selector_has_multiple_selection;
330 * HildonTouchSelector::changed:
331 * @widget: the object which received the signal
332 * @column: the number of the column that has changed
334 * The "changed" signal is emitted when the active item on any column is changed.
335 * This can be due to the user selecting a different item from the list, or
336 * due to a call to hildon_touch_selector_select_iter() on one of the columns.
340 hildon_touch_selector_signals[CHANGED] =
341 g_signal_new ("changed",
342 G_OBJECT_CLASS_TYPE (class),
344 G_STRUCT_OFFSET (HildonTouchSelectorClass, changed),
346 g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
349 * HildonTouchSelector::columns-changed:
350 * @selector: the object which received the signal
352 * The "columns-changed" signal is emitted when the number
353 * of columns in the #HildonTouchSelector change.
357 hildon_touch_selector_signals[COLUMNS_CHANGED] =
358 g_signal_new ("columns-changed",
359 G_OBJECT_CLASS_TYPE (class),
360 G_SIGNAL_RUN_LAST, 0,
362 g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
366 g_object_class_install_property (gobject_class, PROP_HAS_MULTIPLE_SELECTION,
367 g_param_spec_boolean ("has-multiple-selection",
368 "has multiple selection",
369 "Whether the widget has multiple "
370 "selection (like multiple columns, "
371 "multiselection mode, or multiple "
372 "internal widgets) and therefore "
373 "it may need a confirmation button, "
378 g_object_class_install_property (G_OBJECT_CLASS (gobject_class),
380 g_param_spec_boolean ("initial-scroll",
382 "Whether to scroll to the"
383 "current selection when"
384 "the selector is first"
387 G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
389 /* style properties */
390 /* We need to ensure fremantle mode for the treeview in order to work
391 properly. This is not about the appearance, this is about behaviour */
392 gtk_rc_parse_string ("style \"fremantle-htst\" {\n"
393 " GtkWidget::hildon-mode = 1\n"
394 "} widget \"*.fremantle-htst\" style \"fremantle-htst\""
395 "widget_class \"*<HildonPannableArea>.GtkTreeView\" style :highest \"fremantle-htst\"");
397 g_type_class_add_private (object_class, sizeof (HildonTouchSelectorPrivate));
401 hildon_touch_selector_get_property (GObject * object,
403 GValue * value, GParamSpec * pspec)
405 HildonTouchSelectorPrivate *priv = HILDON_TOUCH_SELECTOR (object)->priv;
408 case PROP_HAS_MULTIPLE_SELECTION:
409 g_value_set_boolean (value,
410 hildon_touch_selector_has_multiple_selection (HILDON_TOUCH_SELECTOR (object)));
412 case PROP_INITIAL_SCROLL:
413 g_value_set_boolean (value, priv->initial_scroll);
416 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
422 hildon_touch_selector_set_property (GObject *object, guint prop_id,
423 const GValue *value, GParamSpec *pspec)
425 HildonTouchSelectorPrivate *priv = HILDON_TOUCH_SELECTOR (object)->priv;
428 case PROP_INITIAL_SCROLL:
429 priv->initial_scroll = g_value_get_boolean (value);
432 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
439 hildon_touch_selector_init (HildonTouchSelector * selector)
441 selector->priv = HILDON_TOUCH_SELECTOR_GET_PRIVATE (selector);
443 GTK_WIDGET_SET_FLAGS (GTK_WIDGET (selector), GTK_NO_WINDOW);
444 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (selector), FALSE);
446 selector->priv->columns = NULL;
448 selector->priv->print_func = NULL;
449 selector->priv->print_user_data = NULL;
450 selector->priv->print_destroy_func = NULL;
451 selector->priv->initial_scroll = TRUE;
452 selector->priv->hbox = gtk_hbox_new (FALSE, 0);
454 gtk_box_pack_end (GTK_BOX (selector), selector->priv->hbox,
456 gtk_widget_show (selector->priv->hbox);
460 hildon_touch_selector_dispose (GObject * object)
462 GObjectClass *gobject_class;
464 hildon_touch_selector_set_print_func_full (HILDON_TOUCH_SELECTOR (object),
467 gobject_class = G_OBJECT_CLASS (hildon_touch_selector_parent_class);
469 if (gobject_class->dispose)
470 (* gobject_class->dispose) (object);
474 * IMPLEMENTATION NOTES:
475 * Some people sent questions regarding a missing dispose/finalize function on
476 * this widget that could lead to leak memory, so we will clarify this topic.
478 * This is not required as #HildonTouchSelector extends #GtkContainer. When the
479 * widget is freed, the #GtkContainer freeing memory functions are called. This
480 * process includes remove each widget individually, so all the widgets are
483 * In the same way, this widget redefines gtk_container->remove function, in
484 * order to free the column related information if it is required.
486 * Please take a look to hildon_touch_selector_remove for more information.
489 /*------------------------------ GtkContainer ------------------------------ */
492 * Required in order to free the column at the columns list
495 hildon_touch_selector_remove (GtkContainer * container, GtkWidget * widget)
497 HildonTouchSelector *selector = NULL;
499 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (container));
500 selector = HILDON_TOUCH_SELECTOR (container);
502 /* Remove the extra data related to the columns, if required. */
503 if (widget == selector->priv->hbox) {
504 g_slist_foreach (selector->priv->columns, (GFunc) g_object_unref, NULL);
506 g_slist_free (selector->priv->columns);
508 selector->priv->columns = NULL;
510 g_debug ("Freeing a widget outside the columns logic");
513 /* Now remove the widget itself from the container */
514 GTK_CONTAINER_CLASS (hildon_touch_selector_parent_class)->remove (container, widget);
517 /* ------------------------------ PRIVATE METHODS ---------------------------- */
519 * default_print_func:
520 * @selector: a #HildonTouchSelector
522 * Default print function
524 * Returns: a new string that represents the selected items
529 _default_print_func (HildonTouchSelector * selector, gpointer user_data)
531 gchar *result = NULL;
533 gint num_columns = 0;
535 GtkTreeModel *model = NULL;
536 gchar *current_string = NULL;
538 HildonTouchSelectorSelectionMode mode;
540 GtkTreePath *current_path = NULL;
541 GList *selected_rows = NULL;
542 gint initial_value = 0;
543 gint text_column = -1;
544 HildonTouchSelectorColumn *column = NULL;
546 num_columns = hildon_touch_selector_get_num_columns (selector);
548 mode = hildon_touch_selector_get_column_selection_mode (selector);
550 if ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE)
551 && (num_columns > 0)) {
552 /* In this case we get the first column first */
553 selected_rows = hildon_touch_selector_get_selected_rows (selector, 0);
554 model = hildon_touch_selector_get_model (selector, 0);
555 column = hildon_touch_selector_get_column (selector, 0);
556 g_object_get (G_OBJECT(column), "text-column", &text_column, NULL);
558 result = g_strdup_printf ("(");
560 for (item = selected_rows; item; item = g_list_next (item)) {
561 current_path = item->data;
562 gtk_tree_model_get_iter (model, &iter, current_path);
564 if (text_column != -1) {
565 gtk_tree_model_get (model, &iter, text_column, ¤t_string, -1);
568 if (i < g_list_length (selected_rows) - 1) {
569 aux = g_strconcat (result, current_string, ",", NULL);
573 aux = g_strconcat (result, current_string, NULL);
578 if (current_string) {
579 g_free (current_string);
580 current_string = NULL;
586 aux = g_strconcat (result, ")", NULL);
590 g_list_foreach (selected_rows, (GFunc) (gtk_tree_path_free), NULL);
591 g_list_free (selected_rows);
597 for (i = initial_value; i < num_columns; i++) {
598 model = hildon_touch_selector_get_model (selector, i);
599 column = hildon_touch_selector_get_column (selector, i);
600 g_object_get (G_OBJECT(column), "text-column", &text_column, NULL);
602 if (hildon_touch_selector_get_selected (selector, i, &iter)) {
603 if (text_column == -1 ) {
604 g_warning ("Trying to use the default print function in HildonTouchSelector, but "
605 "\"text-column\" property is not set for HildonTouchSelectorColumn %p.", column);
606 current_string = NULL;
608 gtk_tree_model_get (model, &iter, text_column, ¤t_string, -1);
612 result = current_string;
614 aux = g_strconcat (result, ":", current_string, NULL);
616 g_free (current_string);
617 current_string = NULL;
627 _row_tapped_cb (GtkTreeView * tree_view, GtkTreePath * path, gpointer user_data)
629 HildonTouchSelector *selector = NULL;
630 HildonTouchSelectorColumn *column = NULL;
631 gint num_column = -1;
633 column = HILDON_TOUCH_SELECTOR_COLUMN (user_data);
634 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (column->priv->parent));
636 selector = column->priv->parent;
638 num_column = g_slist_index (selector->priv->columns, column);
640 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, num_column);
644 static HildonTouchSelectorColumn *
645 _create_new_column (HildonTouchSelector * selector,
646 GtkTreeModel * model,
647 gboolean *emit_changed,
648 GtkCellRenderer * renderer, va_list args)
650 HildonTouchSelectorColumn *new_column = NULL;
651 GtkTreeViewColumn *tree_column = NULL;
652 GtkTreeView *tv = NULL;
653 GtkWidget *panarea = NULL;
654 GtkTreeSelection *selection = NULL;
659 tree_column = gtk_tree_view_column_new ();
661 if (renderer != NULL) {
662 gtk_tree_view_column_pack_start (tree_column, renderer, TRUE);
664 attribute = va_arg (args, gchar *);
665 while (attribute != NULL) {
666 value = va_arg (args, gint);
667 gtk_tree_view_column_add_attribute (tree_column, renderer, attribute,
669 attribute = va_arg (args, gchar *);
674 tv = GTK_TREE_VIEW (hildon_gtk_tree_view_new (HILDON_UI_MODE_EDIT));
676 tv = GTK_TREE_VIEW (gtk_tree_view_new ());
677 #endif /* MAEMO_GTK */
679 gtk_tree_view_set_enable_search (tv, FALSE);
680 GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (tv), GTK_CAN_FOCUS);
682 gtk_tree_view_set_model (tv, model);
683 gtk_tree_view_set_rules_hint (tv, TRUE);
685 gtk_tree_view_append_column (GTK_TREE_VIEW (tv), tree_column);
687 new_column = g_object_new (HILDON_TYPE_TOUCH_SELECTOR_COLUMN, NULL);
688 new_column->priv->parent = selector;
690 panarea = hildon_pannable_area_new ();
692 g_object_set (G_OBJECT (panarea),
693 "initial-hint", FALSE, NULL);
695 gtk_container_add (GTK_CONTAINER (panarea), GTK_WIDGET (tv));
697 new_column->priv->model = model;
698 new_column->priv->tree_view = tv;
699 new_column->priv->panarea = panarea;
700 new_column->priv->realize_handler = 0;
701 new_column->priv->initial_path = NULL;
703 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
704 gtk_tree_selection_set_mode (selection, GTK_SELECTION_BROWSE);
706 /* select the first item */
707 *emit_changed = FALSE;
708 if (gtk_tree_model_get_iter_first (model, &iter)) {
709 gtk_tree_selection_select_iter (selection, &iter);
710 *emit_changed = TRUE;
713 gtk_widget_grab_focus (GTK_WIDGET (tv));
715 /* connect to the hildon-row-tapped signal connection */
716 g_signal_connect (G_OBJECT (tv), "hildon-row-tapped",
717 G_CALLBACK (_row_tapped_cb), new_column);
723 /* ------------------------ HildonTouchSelectorColumn implementation ---------------------- */
724 G_DEFINE_TYPE_WITH_CODE (HildonTouchSelectorColumn, hildon_touch_selector_column, G_TYPE_OBJECT,
725 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
726 hildon_touch_selector_column_cell_layout_init))
734 hildon_touch_selector_column_class_init (HildonTouchSelectorColumnClass *klass);
737 hildon_touch_selector_column_get_property (GObject *object, guint property_id,
738 GValue *value, GParamSpec *pspec);
741 hildon_touch_selector_column_set_property (GObject *object, guint property_id,
742 const GValue *value, GParamSpec *pspec);
745 hildon_touch_selector_column_set_text_column (HildonTouchSelectorColumn *column,
748 hildon_touch_selector_column_get_text_column (HildonTouchSelectorColumn *column);
752 hildon_touch_selector_column_class_init (HildonTouchSelectorColumnClass *klass)
754 GObjectClass *gobject_class = NULL;
756 gobject_class = G_OBJECT_CLASS (klass);
758 g_type_class_add_private (gobject_class, sizeof (HildonTouchSelectorColumnPrivate));
761 gobject_class->get_property = hildon_touch_selector_column_get_property;
762 gobject_class->set_property = hildon_touch_selector_column_set_property;
764 g_object_class_install_property (G_OBJECT_CLASS(klass),
766 g_param_spec_int ("text-column",
768 "A column in the data source model to get the strings from.",
776 hildon_touch_selector_column_init (HildonTouchSelectorColumn *column)
778 column->priv = G_TYPE_INSTANCE_GET_PRIVATE (column, HILDON_TYPE_TOUCH_SELECTOR_COLUMN,
779 HildonTouchSelectorColumnPrivate);
780 column->priv->text_column = -1;
784 hildon_touch_selector_column_set_text_column (HildonTouchSelectorColumn *column,
787 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (column));
788 g_return_if_fail (text_column >= -1);
790 column->priv->text_column = text_column;
792 g_object_notify (G_OBJECT (column), "text-column");
796 hildon_touch_selector_column_get_text_column (HildonTouchSelectorColumn *column)
798 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (column), -1);
800 return column->priv->text_column;
804 hildon_touch_selector_column_get_property (GObject *object, guint property_id,
805 GValue *value, GParamSpec *pspec)
807 switch (property_id) {
808 case PROP_TEXT_COLUMN:
809 g_value_set_int (value,
810 hildon_touch_selector_column_get_text_column (HILDON_TOUCH_SELECTOR_COLUMN (object)));
813 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
818 hildon_touch_selector_column_set_property (GObject *object, guint property_id,
819 const GValue *value, GParamSpec *pspec)
821 switch (property_id) {
822 case PROP_TEXT_COLUMN:
823 hildon_touch_selector_column_set_text_column (HILDON_TOUCH_SELECTOR_COLUMN (object),
824 g_value_get_int (value));
827 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
831 /* ------------------------ GtkCellLayout implementation -------------------- */
833 hildon_touch_selector_column_cell_layout_init (GtkCellLayoutIface *iface)
835 iface->pack_start = hildon_touch_selector_column_cell_layout_pack_start;
836 iface->pack_end = hildon_touch_selector_column_cell_layout_pack_end;
837 iface->clear = hildon_touch_selector_column_cell_layout_clear;
838 iface->add_attribute = hildon_touch_selector_column_cell_layout_add_attribute;
839 iface->set_cell_data_func = hildon_touch_selector_column_cell_layout_set_cell_data_func;
840 iface->clear_attributes = hildon_touch_selector_column_cell_layout_clear_attributes;
841 iface->reorder = hildon_touch_selector_column_cell_layout_reorder;
842 iface->get_cells = hildon_touch_selector_column_cell_layout_get_cells;
846 hildon_touch_selector_column_cell_layout_pack_start (GtkCellLayout *cell_layout,
847 GtkCellRenderer *cell,
850 HildonTouchSelectorColumn *sel_column = NULL;
851 GtkTreeViewColumn *view_column = NULL;
853 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
854 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
856 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
858 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT(view_column), cell, expand);
863 hildon_touch_selector_column_cell_layout_pack_end (GtkCellLayout *cell_layout,
864 GtkCellRenderer *cell,
867 HildonTouchSelectorColumn *sel_column = NULL;
868 GtkTreeViewColumn *view_column = NULL;
870 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
871 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
873 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
875 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT(view_column), cell, expand);
879 hildon_touch_selector_column_cell_layout_clear (GtkCellLayout *cell_layout)
881 HildonTouchSelectorColumn *sel_column = NULL;
882 GtkTreeViewColumn *view_column = NULL;
884 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
885 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
887 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
889 gtk_cell_layout_clear (GTK_CELL_LAYOUT(view_column));
893 hildon_touch_selector_column_cell_layout_add_attribute (GtkCellLayout *cell_layout,
894 GtkCellRenderer *cell,
895 const gchar *attribute,
898 HildonTouchSelectorColumn *sel_column = NULL;
899 GtkTreeViewColumn *view_column = NULL;
901 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
902 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
904 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
906 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT(view_column), cell, attribute, column);
911 hildon_touch_selector_column_cell_layout_set_cell_data_func (GtkCellLayout *cell_layout,
912 GtkCellRenderer *cell,
913 GtkCellLayoutDataFunc func,
915 GDestroyNotify destroy)
917 HildonTouchSelectorColumn *sel_column = NULL;
918 GtkTreeViewColumn *view_column = NULL;
920 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
921 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
923 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
925 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT(view_column), cell, func,
930 hildon_touch_selector_column_cell_layout_clear_attributes (GtkCellLayout *cell_layout,
931 GtkCellRenderer *cell)
933 HildonTouchSelectorColumn *sel_column = NULL;
934 GtkTreeViewColumn *view_column = NULL;
936 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
937 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
939 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
941 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (view_column), cell);
945 hildon_touch_selector_column_cell_layout_reorder (GtkCellLayout *cell_layout,
946 GtkCellRenderer *cell,
949 HildonTouchSelectorColumn *sel_column = NULL;
950 GtkTreeViewColumn *view_column = NULL;
952 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout));
953 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
955 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
957 gtk_cell_layout_reorder (GTK_CELL_LAYOUT(view_column), cell, position);
961 hildon_touch_selector_column_cell_layout_get_cells (GtkCellLayout *cell_layout)
963 HildonTouchSelectorColumn *sel_column = NULL;
964 GtkTreeViewColumn *view_column = NULL;
966 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR_COLUMN (cell_layout), NULL);
967 sel_column = HILDON_TOUCH_SELECTOR_COLUMN (cell_layout);
969 view_column = gtk_tree_view_get_column (sel_column->priv->tree_view, 0);
971 return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT(view_column));
974 /* ------------------------------ PUBLIC METHODS ---------------------------- */
977 * hildon_touch_selector_new:
979 * Creates a new empty #HildonTouchSelector.
981 * Returns: a new #HildonTouchSelector.
986 hildon_touch_selector_new (void)
988 return g_object_new (HILDON_TYPE_TOUCH_SELECTOR, NULL);
992 * hildon_touch_selector_new_text:
994 * Creates a #HildonTouchSelector with a single text column that
995 * can be populated conveniently through hildon_touch_selector_append_text(),
996 * hildon_touch_selector_prepend_text(), hildon_touch_selector_insert_text().
998 * Returns: A new #HildonTouchSelector
1003 hildon_touch_selector_new_text (void)
1005 GtkWidget *selector;
1006 GtkListStore *store;
1007 HildonTouchSelectorColumn *column = NULL;
1009 selector = hildon_touch_selector_new ();
1010 store = gtk_list_store_new (1, G_TYPE_STRING);
1012 column = hildon_touch_selector_append_text_column (HILDON_TOUCH_SELECTOR (selector),
1013 GTK_TREE_MODEL (store), TRUE);
1015 g_object_set (G_OBJECT (column), "text-column", 0, NULL);
1021 * hildon_touch_selector_append_text:
1022 * @selector: A #HildonTouchSelector.
1023 * @text: a non %NULL text string.
1025 * Appends a new entry in a #HildonTouchSelector created with
1026 * hildon_touch_selector_new_text().
1031 hildon_touch_selector_append_text (HildonTouchSelector * selector,
1035 GtkTreeModel *model;
1037 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1038 g_return_if_fail (text != NULL);
1040 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1042 g_return_if_fail (GTK_IS_LIST_STORE (model));
1044 gtk_list_store_append (GTK_LIST_STORE (model), &iter);
1045 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1049 * hildon_touch_selector_prepend_text:
1050 * @selector: A #HildonTouchSelector.
1051 * @text: a non %NULL text string.
1053 * Prepends a new entry in a #HildonTouchSelector created with
1054 * hildon_touch_selector_new_text().
1059 hildon_touch_selector_prepend_text (HildonTouchSelector * selector,
1063 GtkTreeModel *model;
1065 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1066 g_return_if_fail (text != NULL);
1068 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1070 g_return_if_fail (GTK_IS_LIST_STORE (model));
1072 gtk_list_store_prepend (GTK_LIST_STORE (model), &iter);
1073 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1077 * hildon_touch_selector_insert_text:
1078 * @selector: a #HildonTouchSelector.
1079 * @position: the position to insert @text.
1080 * @text: A non %NULL text string.
1082 * Inserts a new entry in a particular position of a
1083 * #HildonTouchSelector created with hildon_touch_selector_new_text().
1088 hildon_touch_selector_insert_text (HildonTouchSelector * selector,
1089 gint position, const gchar * text)
1092 GtkTreeModel *model;
1094 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1095 g_return_if_fail (text != NULL);
1096 g_return_if_fail (position >= 0);
1098 model = hildon_touch_selector_get_model (HILDON_TOUCH_SELECTOR (selector), 0);
1100 g_return_if_fail (GTK_IS_LIST_STORE (model));
1102 gtk_list_store_insert (GTK_LIST_STORE (model), &iter, position);
1103 gtk_list_store_set (GTK_LIST_STORE (model), &iter, 0, text, -1);
1107 * hildon_touch_selector_append_column
1108 * @selector: a #HildonTouchSelector
1109 * @model: the #GtkTreeModel with the data of the column
1110 * @cell_renderer: The #GtkCellRenderer where to draw each row contents.
1111 * @Varargs: a %NULL-terminated pair of attributes and column numbers.
1113 * This functions adds a new column to the widget, whose data will
1114 * be obtained from the model. Only widgets added this way should used on
1115 * the selection logic, i.e., the print function, the #HildonTouchPicker::changed
1118 * You can optionally pass a #GtkCellRenderer in @cell_renderer,
1119 * together with a %NULL-terminated list of pairs property/value, in
1120 * the same way you would use gtk_tree_view_column_set_attributes().
1121 * This will pack @cell_renderer at the start of the column, expanded by default.
1122 * If you prefer not to add it this way, you can simply pass %NULL to @cell_renderer
1123 * and use the #GtkCellLayout interface on the returned #HildonTouchSelectorColumn
1124 * to set your renderers.
1126 * There is a prerequisite to be considered on models used: text data must
1127 * be in the first column.
1129 * This method basically adds a #GtkTreeView to the widget, using the model and
1130 * the data received.
1132 * Returns: the new column added added, %NULL otherwise.
1137 HildonTouchSelectorColumn*
1138 hildon_touch_selector_append_column (HildonTouchSelector * selector,
1139 GtkTreeModel * model,
1140 GtkCellRenderer * cell_renderer, ...)
1143 HildonTouchSelectorColumn *new_column = NULL;
1144 gboolean emit_changed = FALSE;
1147 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1148 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1150 if (model != NULL) {
1152 va_start (args, cell_renderer);
1153 new_column = _create_new_column (selector, model, &emit_changed, cell_renderer, args);
1156 selector->priv->columns = g_slist_append (selector->priv->columns,
1158 gtk_box_pack_start (GTK_BOX (selector->priv->hbox),
1159 new_column->priv->panarea,
1162 gtk_widget_show_all (new_column->priv->panarea);
1164 if (selector->priv->initial_scroll) {
1165 _hildon_touch_selector_center_on_selected_items (selector, new_column);
1172 g_signal_emit (selector, hildon_touch_selector_signals[COLUMNS_CHANGED], 0);
1174 colnum = g_slist_length (selector->priv->columns);
1175 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, colnum);
1182 * hildon_touch_selector_append_text_column
1183 * @selector: a #HildonTouchSelector
1184 * @model: a #GtkTreeModel with data for the column
1185 * @center: whether to center the text on the column
1187 * Equivalent to hildon_touch_selector_append_column(), but using a
1188 * default text cell renderer. This is the most common use case of the
1191 * Returns: the new column added, NULL otherwise.
1195 HildonTouchSelectorColumn*
1196 hildon_touch_selector_append_text_column (HildonTouchSelector * selector,
1197 GtkTreeModel * model, gboolean center)
1199 gfloat xalign = center ? 0.5 : 0.0;
1200 GtkCellRenderer *renderer;
1202 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1203 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1205 renderer = gtk_cell_renderer_text_new ();
1207 g_object_set (renderer,
1211 return hildon_touch_selector_append_column (selector, model, renderer,
1216 * hildon_touch_selector_remove_column:
1217 * @selector: a #HildonTouchSelector
1218 * @column: the position of the column to be removed
1220 * Removes a column from @selector.
1222 * Returns: %TRUE if the column was removed, %FALSE otherwise
1227 hildon_touch_selector_remove_column (HildonTouchSelector * selector, gint column)
1229 HildonTouchSelectorColumn *current_column = NULL;
1230 HildonTouchSelectorPrivate *priv;
1232 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
1233 g_return_val_if_fail (column <
1234 hildon_touch_selector_get_num_columns (selector), FALSE);
1236 priv = HILDON_TOUCH_SELECTOR_GET_PRIVATE (selector);
1237 current_column = g_slist_nth_data (priv->columns, column);
1239 gtk_container_remove (GTK_CONTAINER (priv->hbox), current_column->priv->panarea);
1240 priv->columns = g_slist_remove (priv->columns, current_column);
1241 g_object_unref (current_column);
1243 g_signal_emit (selector, hildon_touch_selector_signals[COLUMNS_CHANGED], 0);
1249 * hildon_touch_selector_set_column_attributes:
1250 * @selector: a #HildonTouchSelector
1251 * @num_column: the number of the column whose attributes we're setting
1252 * @cell_renderer: the #GtkCellRendere we're setting the attributes of
1253 * @Varargs: A %NULL-terminated list of attributes.
1255 * Sets the attributes for the given column. The attributes must be given
1256 * in attribute/column pairs, just like in gtk_tree_view_column_set_attributes().
1257 * All existing attributes are removed and replaced with the new ones.
1259 * Deprecated: #HildonTouchSelectorColumn implements #GtkCellLayout, use this
1260 * interface instead. See
1261 * hildon_touch_selector_get_column().
1266 hildon_touch_selector_set_column_attributes (HildonTouchSelector * selector,
1268 GtkCellRenderer * cell_renderer,
1272 GtkTreeViewColumn *tree_column = NULL;
1273 HildonTouchSelectorColumn *current_column = NULL;
1274 gchar *attribute = NULL;
1277 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1278 g_return_if_fail (num_column <
1279 hildon_touch_selector_get_num_columns (selector));
1281 current_column = g_slist_nth_data (selector->priv->columns, num_column);
1283 tree_column = gtk_tree_view_get_column (current_column->priv->tree_view, 0);
1284 gtk_tree_view_remove_column (current_column->priv->tree_view, tree_column);
1286 tree_column = gtk_tree_view_column_new ();
1287 gtk_tree_view_column_pack_start (tree_column, cell_renderer, TRUE);
1289 va_start (args, cell_renderer);
1290 attribute = va_arg (args, gchar *);
1292 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1294 while (attribute != NULL) {
1295 value = va_arg (args, gint);
1296 gtk_tree_view_column_add_attribute (tree_column, cell_renderer,
1298 attribute = va_arg (args, gchar *);
1303 gtk_tree_view_append_column (current_column->priv->tree_view, tree_column);
1307 * hildon_touch_selector_get_num_columns:
1308 * @selector: a #HildonTouchSelector
1310 * Gets the number of columns in the #HildonTouchSelector.
1312 * Returns: the number of columns in @selector.
1317 hildon_touch_selector_get_num_columns (HildonTouchSelector * selector)
1319 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), -1);
1321 return g_slist_length (selector->priv->columns);
1325 * hildon_touch_selector_get_column_selection_mode:
1326 * @selector: a #HildonTouchSelector
1328 * Gets the selection mode of @selector.
1330 * Returns: one of #HildonTouchSelectorSelectionMode
1334 HildonTouchSelectorSelectionMode
1335 hildon_touch_selector_get_column_selection_mode (HildonTouchSelector * selector)
1337 HildonTouchSelectorSelectionMode result =
1338 HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE;
1339 GtkSelectionMode treeview_mode = GTK_SELECTION_BROWSE;
1340 HildonTouchSelectorColumn *column = NULL;
1341 GtkTreeSelection *selection = NULL;
1343 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), result);
1344 g_return_val_if_fail (hildon_touch_selector_get_num_columns (selector) > 0,
1347 column = HILDON_TOUCH_SELECTOR_COLUMN (selector->priv->columns->data);
1349 selection = gtk_tree_view_get_selection (column->priv->tree_view);
1350 treeview_mode = gtk_tree_selection_get_mode (selection);
1353 if (treeview_mode == GTK_SELECTION_MULTIPLE) {
1354 result = HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE;
1356 result = HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE;
1363 * hildon_touch_selector_set_column_selection_mode:
1364 * @selector: a #HildonTouchSelector
1365 * @mode: the #HildonTouchSelectorMode for @selector
1367 * Sets the selection mode for @selector. See #HildonTouchSelectorSelectionMode.
1372 hildon_touch_selector_set_column_selection_mode (HildonTouchSelector * selector,
1373 HildonTouchSelectorSelectionMode mode)
1375 GtkTreeView *tv = NULL;
1376 HildonTouchSelectorColumn *column = NULL;
1377 GtkTreeSelection *selection = NULL;
1378 GtkSelectionMode treeview_mode = GTK_SELECTION_MULTIPLE;
1380 HildonTouchSelectorSelectionMode current_mode;
1382 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1383 g_return_if_fail (hildon_touch_selector_get_num_columns (selector) > 0);
1385 current_mode = hildon_touch_selector_get_column_selection_mode (selector);
1387 if (current_mode == mode) {
1391 column = HILDON_TOUCH_SELECTOR_COLUMN ((g_slist_nth (selector->priv->columns, 0))->data);
1392 tv = column->priv->tree_view;
1396 case HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE:
1397 treeview_mode = GTK_SELECTION_BROWSE;
1399 case HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE:
1400 treeview_mode = GTK_SELECTION_MULTIPLE;
1404 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
1405 gtk_tree_selection_set_mode (selection, treeview_mode);
1407 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (tv));
1408 gtk_tree_model_get_iter_first (column->priv->model, &iter);
1409 gtk_tree_selection_unselect_all (selection);
1410 gtk_tree_selection_select_iter (selection, &iter);
1412 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
1418 * hildon_touch_selector_set_print_func:
1419 * @selector: a #HildonTouchSelector
1420 * @func: a #HildonTouchSelectorPrintFunc function
1422 * Sets the function to be used by hildon_touch_selector_get_current_text()
1423 * to produce a text representation of the currently selected items in @selector.
1424 * The default function will return a concatenation of comma separated items
1425 * selected in each column in @selector. Use this to override this method if you
1426 * need a particular representation for your application.
1431 hildon_touch_selector_set_print_func (HildonTouchSelector * selector,
1432 HildonTouchSelectorPrintFunc func)
1434 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1436 hildon_touch_selector_set_print_func_full (selector, func, NULL, NULL);
1440 * hildon_touch_selector_set_print_func_full:
1441 * @selector: a #HildonTouchSelector
1442 * @func: a #HildonTouchSelectorPrintFunc function
1443 * @user_data: a pointer to user data or %NULL
1444 * @destroy_func: a callback for freeing the user data or %NULL
1446 * Sets the function to be used by hildon_touch_selector_get_current_text()
1447 * to produce a text representation of the currently selected items in @selector.
1448 * The default function will return a concatenation of comma separated items
1449 * selected in each column in @selector. Use this to override this method if you
1450 * need a particular representation for your application.
1455 hildon_touch_selector_set_print_func_full (HildonTouchSelector *selector,
1456 HildonTouchSelectorPrintFunc func,
1458 GDestroyNotify destroy_func)
1460 gpointer old_user_data;
1461 GDestroyNotify old_destroy_func;
1463 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1465 old_user_data = selector->priv->print_user_data;
1466 old_destroy_func = selector->priv->print_destroy_func;
1468 selector->priv->print_func = func;
1469 selector->priv->print_user_data = user_data;
1470 selector->priv->print_destroy_func = destroy_func;
1472 if (old_destroy_func && old_user_data != user_data)
1473 (*old_destroy_func) (old_user_data);
1477 * hildon_touch_selector_get_print_func:
1478 * @selector: a #HildonTouchSelector
1480 * Gets the #HildonTouchSelectorPrintFunc currently used. See
1481 * hildon_touch_selector_set_print_func().
1483 * Returns: a #HildonTouchSelectorPrintFunc or %NULL if the default
1484 * one is currently used.
1486 HildonTouchSelectorPrintFunc
1487 hildon_touch_selector_get_print_func (HildonTouchSelector * selector)
1489 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1491 return selector->priv->print_func;
1495 * hildon_touch_selector_set_active:
1496 * @selector: a #HildonTouchSelector
1497 * @column: column number
1498 * @index: the index of the item to select, or -1 to have no active item
1500 * Sets the active item of the #HildonTouchSelector to @index. The
1501 * column number is taken from @column.
1503 * @selector must be in %HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE
1508 hildon_touch_selector_set_active (HildonTouchSelector *selector,
1512 GtkTreeSelection *selection = NULL;
1513 HildonTouchSelectorColumn *current_column = NULL;
1514 HildonTouchSelectorSelectionMode mode;
1517 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1518 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1519 mode = hildon_touch_selector_get_column_selection_mode (selector);
1520 g_return_if_fail (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE);
1522 current_column = g_slist_nth_data (selector->priv->columns, column);
1524 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1525 path = gtk_tree_path_new_from_indices (index, -1);
1526 gtk_tree_selection_unselect_all (selection);
1528 gtk_tree_selection_select_path (selection, path);
1530 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
1532 gtk_tree_path_free (path);
1536 * hildon_touch_selector_get_active:
1537 * @selector: a #HildonTouchSelector
1538 * @column: column number
1540 * Returns the index of the currently active item in column number
1541 * @column, or -1 if there's no active item.
1543 * @selector must be in %HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE
1545 * Returns: an integer which is the index of the currently active
1546 * item, or -1 if there's no active item.
1551 hildon_touch_selector_get_active (HildonTouchSelector *selector,
1554 GtkTreeSelection *selection = NULL;
1555 HildonTouchSelectorColumn *current_column = NULL;
1556 HildonTouchSelectorSelectionMode mode;
1557 GtkTreeModel *model;
1562 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), -1);
1563 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector), -1);
1564 mode = hildon_touch_selector_get_column_selection_mode (selector);
1565 g_return_val_if_fail (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE, -1);
1567 current_column = g_slist_nth_data (selector->priv->columns, column);
1569 selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1570 g_return_val_if_fail (gtk_tree_selection_get_selected (selection, NULL, &iter), -1);
1572 model = gtk_tree_view_get_model (GTK_TREE_VIEW (current_column->priv->tree_view));
1573 path = gtk_tree_model_get_path (model, &iter);
1574 index = (gtk_tree_path_get_indices (path))[0];
1576 gtk_tree_path_free (path);
1582 * hildon_touch_selector_get_selected:
1583 * @selector: a #HildonTouchSelector
1584 * @column: the column number we want to get the element
1585 * @iter: #GtkTreeIter currently selected
1587 * Sets @iter to the currently selected node on the nth-column, if selection is
1588 * set to %HILDON_TOUCH_SELECTOR_SINGLE or %HILDON_TOUCH_SELECTOR_MULTIPLE with
1589 * a column different that the first one. @iter may be %NULL if you just want to
1590 * test if selection has any selected items.
1592 * This function will not work if selection is in
1593 * %HILDON_TOUCH_SELECTOR_MULTIPLE mode and the column is the first one.
1595 * See gtk_tree_selection_get_selected() for more information.
1597 * Returns: %TRUE if @iter was correctly set, %FALSE otherwise
1602 hildon_touch_selector_get_selected (HildonTouchSelector * selector,
1603 gint column, GtkTreeIter * iter)
1605 GtkTreeSelection *selection = NULL;
1606 HildonTouchSelectorColumn *current_column = NULL;
1607 HildonTouchSelectorSelectionMode mode;
1609 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
1610 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1612 mode = hildon_touch_selector_get_column_selection_mode (selector);
1613 g_return_val_if_fail
1614 ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE) ||
1615 ((mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE)&&(column>0)),
1618 current_column = g_slist_nth_data (selector->priv->columns, column);
1621 gtk_tree_view_get_selection (GTK_TREE_VIEW (current_column->priv->tree_view));
1623 return gtk_tree_selection_get_selected (selection, NULL, iter);
1627 * hildon_touch_selector_select_iter
1628 * @selector: a #HildonTouchSelector
1629 * @column: the column to selects
1630 * @iter: the #GtkTreeIter to be selected
1631 * @scroll_to: whether to smoothly scroll to the item
1633 * Sets the currently selected item in the column @column to the one pointed by @iter,
1634 * optionally smoothly scrolling to it.
1639 hildon_touch_selector_select_iter (HildonTouchSelector * selector,
1640 gint column, GtkTreeIter * iter,
1644 GtkTreeModel *model;
1645 HildonTouchSelectorColumn *current_column = NULL;
1646 GtkTreeView *tv = NULL;
1647 GtkTreeSelection *selection = NULL;
1649 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1650 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1652 current_column = g_slist_nth_data (selector->priv->columns, column);
1654 tv = current_column->priv->tree_view;
1655 selection = gtk_tree_view_get_selection (tv);
1656 model = gtk_tree_view_get_model (tv);
1657 path = gtk_tree_model_get_path (model, iter);
1659 gtk_tree_selection_select_iter (selection, iter);
1662 hildon_touch_selector_scroll_to (current_column, tv, path);
1665 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
1667 gtk_tree_path_free (path);
1671 * hildon_touch_selector_unselect_iter
1672 * @selector: a #HildonTouchSelector
1673 * @column: the column to unselects from
1674 * @iter: the #GtkTreeIter to be unselected
1676 * Unselect the item pointed by @iter in the column @column
1681 void hildon_touch_selector_unselect_iter (HildonTouchSelector * selector,
1685 HildonTouchSelectorColumn *current_column = NULL;
1686 GtkTreeSelection *selection = NULL;
1688 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1689 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1691 current_column = g_slist_nth_data (selector->priv->columns, column);
1692 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1693 gtk_tree_selection_unselect_iter (selection, iter);
1695 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
1699 * hildon_touch_selector_unselect_all:
1700 * @selector: a #HildonTouchSelector
1701 * @column: the position of the column to get the selected rows from
1703 * Unselects all the selected items in the column @column.
1708 hildon_touch_selector_unselect_all (HildonTouchSelector * selector,
1711 HildonTouchSelectorColumn *current_column = NULL;
1712 GtkTreeSelection *selection = NULL;
1714 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
1715 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1717 current_column = g_slist_nth_data (selector->priv->columns, column);
1718 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1719 gtk_tree_selection_unselect_all (selection);
1721 g_signal_emit (selector, hildon_touch_selector_signals[CHANGED], 0, column);
1725 * hildon_touch_selector_get_selected_rows:
1726 * @selector: a #HildonTouchSelector
1727 * @column: the position of the column to get the selected rows from
1729 * Creates a list of #GtkTreePath<!-- -->s of all selected rows in a column. Additionally,
1730 * if you to plan to modify the model after calling this function, you may
1731 * want to convert the returned list into a list of GtkTreeRowReferences. To do this,
1732 * you can use gtk_tree_row_reference_new().
1734 * See gtk_tree_selection_get_selected_rows() for more information.
1736 * Returns: A new #GList containing a #GtkTreePath for each selected row in the column @column.
1741 hildon_touch_selector_get_selected_rows (HildonTouchSelector * selector,
1744 GList *result = NULL;
1745 HildonTouchSelectorColumn *current_column = NULL;
1746 GtkTreeSelection *selection = NULL;
1748 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1749 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1752 current_column = g_slist_nth_data (selector->priv->columns, column);
1753 selection = gtk_tree_view_get_selection (current_column->priv->tree_view);
1755 result = gtk_tree_selection_get_selected_rows (selection, NULL);
1761 * hildon_touch_selector_get_model:
1762 * @selector: a #HildonTouchSelector
1763 * @column: the position of the column in @selector
1765 * Gets the model of a column of @selector.
1767 * Returns: the #GtkTreeModel for the column @column of @selector.
1772 hildon_touch_selector_get_model (HildonTouchSelector * selector, gint column)
1774 HildonTouchSelectorColumn *current_column = NULL;
1776 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1777 g_return_val_if_fail (column < hildon_touch_selector_get_num_columns (selector),
1780 current_column = g_slist_nth_data (selector->priv->columns, column);
1782 return current_column->priv->model;
1786 _hildon_touch_selector_set_model (HildonTouchSelector * selector,
1787 gint column, GtkTreeModel * model)
1789 HildonTouchSelectorColumn *current_column = NULL;
1792 HILDON_TOUCH_SELECTOR_COLUMN (g_slist_nth_data (selector->priv->columns, column));
1794 current_column->priv->model = model;
1795 gtk_tree_view_set_model (current_column->priv->tree_view,
1796 current_column->priv->model);
1800 * hildon_touch_selector_set_model:
1801 * @selector: a #HildonTouchSelector
1802 * @column: the position of the column to set the model to
1803 * @model: a #GtkTreeModel
1805 * Sets the #GtkTreeModel for a particular column in @model.
1810 hildon_touch_selector_set_model (HildonTouchSelector * selector,
1811 gint column, GtkTreeModel * model)
1813 g_return_if_fail (HILDON_TOUCH_SELECTOR (selector));
1814 g_return_if_fail (column < hildon_touch_selector_get_num_columns (selector));
1816 HILDON_TOUCH_SELECTOR_GET_CLASS (selector)->set_model (selector, column, model);
1820 * hildon_touch_selector_get_current_text:
1821 * @selector: a #HildonTouchSelector
1823 * Returns a string representing the currently selected items for
1824 * each column of @selector. See hildon_touch_selector_set_print_func().
1826 * Returns: a newly allocated string.
1831 hildon_touch_selector_get_current_text (HildonTouchSelector * selector)
1833 gchar *result = NULL;
1834 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
1836 if (selector->priv->print_func) {
1837 result = (*selector->priv->print_func) (selector, selector->priv->print_user_data);
1839 result = _default_print_func (selector, NULL);
1846 search_nearest_element (HildonPannableArea *panarea,
1848 GList *selected_rows,
1849 GtkTreePath **nearest_path)
1851 GtkAdjustment *adj = NULL;
1852 gdouble target_value = 0;
1855 GtkTreePath *path = NULL;
1857 gdouble nearest_distance = -1;
1858 gdouble current_distance = -1;
1859 GtkTreePath *result_path = NULL;
1861 g_assert (nearest_path != NULL);
1863 if (selected_rows == NULL) {
1864 *nearest_path = NULL;
1868 adj = hildon_pannable_area_get_vadjustment (panarea);
1869 g_return_if_fail (adj != NULL);
1871 /* we add this in order to check the nearest to the center of
1873 target_value = gtk_adjustment_get_value (adj) + adj->page_size/2;
1875 path = result_path = selected_rows->data;
1876 gtk_tree_view_get_background_area (tv, path, NULL, &rect);
1877 gtk_tree_view_convert_bin_window_to_tree_coords (tv, 0, rect.y, NULL, &y);
1878 nearest_distance = abs (target_value - y);
1880 for (iter = selected_rows->next; iter; iter = g_list_next (iter)) {
1881 gtk_tree_view_get_background_area (tv, path, NULL, &rect);
1882 gtk_tree_view_convert_bin_window_to_tree_coords (tv, 0, rect.y, NULL, &y);
1883 current_distance = abs (target_value - y);
1884 if (current_distance < nearest_distance) {
1885 nearest_distance = current_distance;
1890 *nearest_path = result_path;
1894 on_realize_cb (GtkWidget *widget,
1897 HildonTouchSelectorColumn *column = NULL;
1901 column = HILDON_TOUCH_SELECTOR_COLUMN (data);
1903 if (column->priv->initial_path) {
1904 gtk_tree_view_get_background_area (GTK_TREE_VIEW (column->priv->tree_view),
1905 column->priv->initial_path, NULL, &rect);
1906 gtk_tree_view_convert_bin_window_to_tree_coords
1907 (GTK_TREE_VIEW (column->priv->tree_view),
1908 0, rect.y, NULL, &y);
1910 hildon_pannable_area_scroll_to (HILDON_PANNABLE_AREA (column->priv->panarea),
1913 gtk_tree_path_free (column->priv->initial_path);
1915 column->priv->initial_path = NULL;
1919 g_signal_handler_disconnect (column->priv->panarea,
1920 column->priv->realize_handler);
1926 hildon_touch_selector_scroll_to (HildonTouchSelectorColumn *column,
1930 if (GTK_WIDGET_REALIZED (column->priv->panarea)) {
1934 gtk_tree_view_get_background_area (tv,
1936 gtk_tree_view_convert_bin_window_to_tree_coords (tv,
1937 0, rect.y, NULL, &y);
1939 hildon_pannable_area_scroll_to (HILDON_PANNABLE_AREA
1940 (column->priv->panarea), -1, y);
1942 if (column->priv->realize_handler != 0) {
1944 if (column->priv->initial_path) {
1945 gtk_tree_path_free (column->priv->initial_path);
1946 column->priv->initial_path = NULL;
1949 g_signal_handler_disconnect (column->priv->panarea,
1950 column->priv->realize_handler);
1951 column->priv->realize_handler = 0;
1954 column->priv->initial_path = gtk_tree_path_copy (path);
1955 column->priv->realize_handler =
1956 g_signal_connect_after (G_OBJECT (column->priv->panarea), "realize",
1957 G_CALLBACK (on_realize_cb),
1964 * Center on the selected item of a concrete column
1966 * Returns: TRUE if was able to do that
1970 _hildon_touch_selector_center_on_selected_items (HildonTouchSelector *selector,
1971 HildonTouchSelectorColumn *column)
1973 GtkTreePath *path = NULL;
1974 GList *selected_rows = NULL;
1975 gint num_column = -1;
1977 num_column = g_slist_index (selector->priv->columns, column);
1979 selected_rows = hildon_touch_selector_get_selected_rows (selector, num_column);
1980 if (selected_rows) {
1981 search_nearest_element (HILDON_PANNABLE_AREA (column->priv->panarea),
1982 GTK_TREE_VIEW (column->priv->tree_view),
1987 hildon_touch_selector_scroll_to (column,
1988 GTK_TREE_VIEW (column->priv->tree_view),
1994 g_list_foreach (selected_rows, (GFunc) (gtk_tree_path_free), NULL);
1995 g_list_free (selected_rows);
2002 _hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector)
2004 HildonTouchSelectorSelectionMode mode;
2007 n_columns = hildon_touch_selector_get_num_columns (selector);
2008 mode = hildon_touch_selector_get_column_selection_mode (selector);
2010 return ((n_columns > 1) || (mode == HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE));
2014 * hildon_touch_selector_has_multiple_selection:
2015 * @selector: A #HildonTouchSelector
2017 * Determines whether @selector is complex enough to actually require an
2018 * extra selection step than only picking an item. This is normally %TRUE
2019 * if @selector has multiple columns, multiple selection, or when it is a
2020 * more complex widget, like #HildonTouchSelectorEntry.
2022 * This information is useful for widgets containing a #HildonTouchSelector,
2023 * like #HildonPickerDialog, that could need a "Done" button, in case that
2024 * its internal #HildonTouchSelector has multiple columns, for instance.
2026 * Returns: %TRUE if @selector requires multiple selection steps.
2031 hildon_touch_selector_has_multiple_selection (HildonTouchSelector * selector)
2033 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), FALSE);
2035 return HILDON_TOUCH_SELECTOR_GET_CLASS (selector)->has_multiple_selection (selector);
2040 * hildon_touch_selector_get_column:
2041 * @selector: A #HildonTouchSelector
2042 * @column: a column number
2044 * Use this method to retrieve a #HildonTouchSelectorColumn. Then, you can use
2045 * the #GtkCellLayout interface to set up the layout of the column.
2047 * Returns: the @column<!-- -->-th #HildonTouchSelectorColumn in @selector
2051 HildonTouchSelectorColumn *
2052 hildon_touch_selector_get_column (HildonTouchSelector * selector,
2055 gint num_columns = -1;
2057 g_return_val_if_fail (HILDON_IS_TOUCH_SELECTOR (selector), NULL);
2058 num_columns = hildon_touch_selector_get_num_columns (selector);
2059 g_return_val_if_fail (column < num_columns && column >= 0, NULL);
2061 return g_slist_nth_data (selector->priv->columns, column);
2066 * hildon_touch_selector_center_on_selected:
2067 * @selector: a #HildonTouchSelector
2069 * Ensures all the columns in a #HildonTouchSelector show a selected
2070 * item. If one of the columns is in
2071 * %HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE mode, that column
2072 * will be scrolled to ensure the selected item that is closest to the
2073 * currently visible area is shown.
2078 hildon_touch_selector_center_on_selected (HildonTouchSelector *selector)
2080 GSList *iter = NULL;
2082 g_return_if_fail (HILDON_IS_TOUCH_SELECTOR (selector));
2084 for (iter = selector->priv->columns; iter; iter = g_slist_next (iter)) {
2085 _hildon_touch_selector_center_on_selected_items (selector,
2086 HILDON_TOUCH_SELECTOR_COLUMN (iter->data));