HildonTouchSelectorPrivate

typedef struct _HildonTouchSelectorPrivate HildonTouchSelectorPrivate;

HildonTouchSelectorPrintFunc ()

gchar*              (*HildonTouchSelectorPrintFunc)     (HildonTouchSelector *selector);

HildonTouchSelector

typedef struct _HildonTouchSelector HildonTouchSelector;

enum HildonTouchSelectorSelectionMode

typedef enum
{
  HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE,
  HILDON_TOUCH_SELECTOR_SELECTION_MODE_MULTIPLE
} HildonTouchSelectorSelectionMode;

hildon_touch_selector_new ()

GtkWidget*          hildon_touch_selector_new           (void);

Creates a new empty HildonTouchSelector.

hildon_touch_selector_new_text ()

GtkWidget*          hildon_touch_selector_new_text      (void);

Creates a HildonTouchSelector with a single text column that can be populated conveniently through hildon_touch_selector_append_text(), hildon_touch_selector_prepend_text(), hildon_touch_selector_insert_text().

hildon_touch_selector_append_text ()

void                hildon_touch_selector_append_text   (HildonTouchSelector *selector,
                                                         const gchar *text);

Appends a new entry in a HildonTouchSelector created with hildon_touch_selector_new_text().

hildon_touch_selector_prepend_text ()

void                hildon_touch_selector_prepend_text  (HildonTouchSelector *selector,
                                                         const gchar *text);

Prepends a new entry in a HildonTouchSelector created with hildon_touch_selector_new_text().

hildon_touch_selector_insert_text ()

void                hildon_touch_selector_insert_text   (HildonTouchSelector *selector,
                                                         gint position,
                                                         const gchar *text);

Inserts a new entry in particular position of a HildoTouchSelector created with hildon_touch_selector_new_text().

hildon_touch_selector_append_text_column ()

HildonTouchSelectorColumn* hildon_touch_selector_append_text_column
                                                        (HildonTouchSelector *selector,
                                                         GtkTreeModel *model,
                                                         gboolean center);

Equivalent to hildon_touch_selector_append_column(), but using a default text cell renderer. This is the most common use case of the widget.

hildon_touch_selector_append_column ()

HildonTouchSelectorColumn* hildon_touch_selector_append_column
                                                        (HildonTouchSelector *selector,
                                                         GtkTreeModel *model,
                                                         GtkCellRenderer *cell_renderer,
                                                         ...);

This functions adds a new column to the widget, whose data will be obtained from the model. Only widgets added this way should used on the selection logic, i.e., the print function, the "changed" signal, etc.

You can optionally pass a GtkCellRenderer in cell_renderer, together with a NULL-terminated list of pairs property/value, in the same way you would use gtk_tree_view_column_set_attributes(). This will pack cell_renderer at the start of the column, expanded by default. If you prefer not to add it this way, you can simply pass NULL to cell_renderer and use the GtkCellLayout interface on the returned HildonTouchSelectorColumn to set your renderers.

There is a prerequisite to be considered on models used: text data must be in the first column.

This method basically adds a GtkTreeView to the widget, using the model and the data received.

hildon_touch_selector_set_column_attributes ()

void                hildon_touch_selector_set_column_attributes
                                                        (HildonTouchSelector *selector,
                                                         gint num_column,
                                                         GtkCellRenderer *cell_renderer,
                                                         ...);

Sets the attributes for the given column. The attributes must be given in attribute/column pairs, just like in gtk_tree_view_column_set_attributes(). All existing attributes are removed and replaced with the new ones.

hildon_touch_selector_remove_column ()

gboolean            hildon_touch_selector_remove_column (HildonTouchSelector *selector,
                                                         gint column);

Removes a column from selector.

hildon_touch_selector_get_num_columns ()

gint                hildon_touch_selector_get_num_columns
                                                        (HildonTouchSelector *selector);

Gets the number of columns in the HildonTouchSelector.

hildon_touch_selector_set_column_selection_mode ()

void                hildon_touch_selector_set_column_selection_mode
                                                        (HildonTouchSelector *selector,
                                                         HildonTouchSelectorSelectionMode mode);

Sets the selection mode for selector. See HildonTouchSelectorSelectionMode.

hildon_touch_selector_get_column_selection_mode ()

HildonTouchSelectorSelectionMode hildon_touch_selector_get_column_selection_mode
                                                        (HildonTouchSelector *selector);

Gets the selection mode of selector.

hildon_touch_selector_get_column ()

HildonTouchSelectorColumn* hildon_touch_selector_get_column
                                                        (HildonTouchSelector *selector,
                                                         gint column);

Use this method to retrieve a HildonTouchSelectorColumn. Then, you can use the GtkCellLayout interface to set up the layout of the column.

hildon_touch_selector_set_active ()

void                hildon_touch_selector_set_active    (HildonTouchSelector *selector,
                                                         gint column,
                                                         gint index);

Sets the active item of the HildonTouchSelector to index. The column number is taken from column.

selector must be in HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE

hildon_touch_selector_get_active ()

gint                hildon_touch_selector_get_active    (HildonTouchSelector *selector,
                                                         gint column);

Returns the index of the currently active item in column number column, or -1 if there's no active item.

selector must be in HILDON_TOUCH_SELECTOR_SELECTION_MODE_SINGLE

hildon_touch_selector_get_selected ()

gboolean            hildon_touch_selector_get_selected  (HildonTouchSelector *selector,
                                                         gint column,
                                                         GtkTreeIter *iter);

Sets iter to the currently selected node on the nth-column, if selection is set to HILDON_TOUCH_SELECTOR_SINGLE or HILDON_TOUCH_SELECTOR_MULTIPLE with a column different that the first one. iter may be NULL if you just want to test if selection has any selected items.

This function will not work if selection is in HILDON_TOUCH_SELECTOR_MULTIPLE mode and the column is the first one.

See gtk_tree_selection_get_selected() for more information.

hildon_touch_selector_select_iter ()

void                hildon_touch_selector_select_iter   (HildonTouchSelector *selector,
                                                         gint column,
                                                         GtkTreeIter *iter,
                                                         gboolean scroll_to);

Sets the currently selected item in the column column to the one pointed by iter, optionally smoothly scrolling to it.

hildon_touch_selector_unselect_iter ()

void                hildon_touch_selector_unselect_iter (HildonTouchSelector *selector,
                                                         gint column,
                                                         GtkTreeIter *iter);

Unselect the item pointed by iter in the column column

hildon_touch_selector_get_selected_rows ()

GList*              hildon_touch_selector_get_selected_rows
                                                        (HildonTouchSelector *selector,
                                                         gint column);

Creates a list of GtkTreePaths of all selected rows in a column. Additionally, if you to plan to modify the model after calling this function, you may want to convert the returned list into a list of GtkTreeRowReferences. To do this, you can use gtk_tree_row_reference_new().

See gtk_tree_selection_get_selected_rows() for more information.

hildon_touch_selector_set_model ()

void                hildon_touch_selector_set_model     (HildonTouchSelector *selector,
                                                         gint column,
                                                         GtkTreeModel *model);

Sets the GtkTreeModel for a particular column in model.

hildon_touch_selector_get_model ()

GtkTreeModel*       hildon_touch_selector_get_model     (HildonTouchSelector *selector,
                                                         gint column);

Gets the model of a column of selector.

hildon_touch_selector_get_current_text ()

gchar*              hildon_touch_selector_get_current_text
                                                        (HildonTouchSelector *selector);

Returns a string representing the currently selected items for each column of selector. See hildon_touch_selector_set_print_func().

hildon_touch_selector_set_print_func ()

void                hildon_touch_selector_set_print_func
                                                        (HildonTouchSelector *selector,
                                                         HildonTouchSelectorPrintFunc func);

Sets the function to be used by hildon_touch_selector_get_current_text() to produce a text representation of the currently selected items in selector. The default function will return a concatenation of comma separated items selected in each column in selector. Use this to override this method if you need a particular representation for your application.

hildon_touch_selector_get_print_func ()

HildonTouchSelectorPrintFunc hildon_touch_selector_get_print_func
                                                        (HildonTouchSelector *selector);

Gets the HildonTouchSelectorPrintFunc currently used. See hildon_touch_selector_set_print_func().

hildon_touch_selector_has_multiple_selection ()

gboolean            hildon_touch_selector_has_multiple_selection
                                                        (HildonTouchSelector *selector);

Determines whether selector is complex enough to actually require an extra selection step than only picking an item. This is normally TRUE if selector has multiple columns, multiple selection, or when it is a more complex widget, like HildonTouchSelectorEntry.

This information is useful for widgets containing a HildonTouchSelector, like HildonPickerDialog, that could need a "Done" button, in case that its internal HildonTouchSelector has multiple columns, for instance.

The "has-multiple-selection" property

  "has-multiple-selection"   gboolean              : Read

Whether the widget has multiple selection (like multiple columns, multiselection mode, or multiple internal widgets) and therefore it may need a confirmation button, for instance.

Default value: FALSE

The "initial-scroll" property

  "initial-scroll"           gboolean              : Read / Write / Construct

Whether to scroll to thecurrent selection whenthe selector is firstshown.

Default value: TRUE

The "changed" signal

void                user_function                      (HildonTouchSelector *column,
                                                        gint                 widget,
                                                        gpointer             user_data)      : Run Last

The changed signal is emitted when the active item on any column is changed. This can be due to the user selecting a different item from the list, or due to a call to hildon_touch_selector_select_iter() on one of the columns.