HildonLiveSearch

typedef struct _HildonLiveSearch HildonLiveSearch;

HildonLiveSearchVisibleFunc ()

gboolean            (*HildonLiveSearchVisibleFunc)      (GtkTreeModel *model,
                                                         GtkTreeIter *iter,
                                                         gchar *text,
                                                         gpointer data);

Since 2.2.5

hildon_live_search_append_text ()

void                hildon_live_search_append_text      (HildonLiveSearch *livesearch,
                                                         const char *text);

Appends a string to the entry text in the live search widget.

Since 2.2.4

hildon_live_search_set_text ()

void                hildon_live_search_set_text         (HildonLiveSearch *livesearch,
                                                         const char *text);

Sets a string to the entry text in the live search widget.

Since 2.2.15

hildon_live_search_get_text ()

const char*         hildon_live_search_get_text         (HildonLiveSearch *livesearch);

Retrieves the text contents of the HildonLiveSearch widget.

Since 2.2.4

hildon_live_search_new ()

GtkWidget*          hildon_live_search_new              (void);

Creates and returns a new HildonLiveSearch widget.

Since 2.2.4

hildon_live_search_restore_state ()

void                hildon_live_search_restore_state    (HildonLiveSearch *livesearch,
                                                         GKeyFile *key_file);

Restores a live search widget's text from a GKeyFile.

Since 2.2.4

hildon_live_search_save_state ()

void                hildon_live_search_save_state       (HildonLiveSearch *livesearch,
                                                         GKeyFile *key_file);

Saves the live search text to a GKeyFile.

Since 2.2.4

hildon_live_search_set_filter ()

void                hildon_live_search_set_filter       (HildonLiveSearch *livesearch,
                                                         GtkTreeModelFilter *filter);

Sets a filter for livesearch.

Since 2.2.4

hildon_live_search_get_filter ()

GtkTreeModelFilter* hildon_live_search_get_filter       (HildonLiveSearch *livesearch);

Since 2.2.5

hildon_live_search_set_visible_func ()

void                hildon_live_search_set_visible_func (HildonLiveSearch *livesearch,
                                                         HildonLiveSearchVisibleFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);

Sets the function to use to determine whether a row should be visible when the text in the entry changes. Internally, gtk_tree_model_filter_set_visible_func() is used.

This is convenience API to replace GtkTreeModelFilter's visible function by one that gives the current text in the entry.

If this function is unset, "text-column" is used.

Since 2.2.5

hildon_live_search_set_text_column ()

void                hildon_live_search_set_text_column  (HildonLiveSearch *livesearch,
                                                         gint text_column);

Sets the column to be used by the default filtering method. This column must be of type G_TYPE_STRING.

Calling this method will trigger filtering of the model, so use with moderation. Note that you can only use either "text-column" or hildon_live_search_set_visible_func().

Since 2.2.4

hildon_live_search_widget_hook ()

void                hildon_live_search_widget_hook      (HildonLiveSearch *livesearch,
                                                         GtkWidget *hook_widget,
                                                         GtkWidget *kb_focus);

This function must be called after a HildonLiveSearch widget is constructed to set the hook widget and the focus widget for livesearch. After that, the HildonLiveSearch widget can be packed into a container and used.

Since 2.2.4

hildon_live_search_widget_unhook ()

void                hildon_live_search_widget_unhook    (HildonLiveSearch *livesearch);

This function unsets the hook and focus widgets which were set earlier using hildon_live_search_widget_hook().

Since 2.2.4

hildon_live_search_clean_selection_map ()

void                hildon_live_search_clean_selection_map
                                                        (HildonLiveSearch *livesearch);

Cleans the selection map maintained by livesearch. When used together with a GtkTreeView, HildonLiveSearch maintains internally a selection map, to make sure that selection is invariant to filtering.

In some cases, you might want to clean this selection mapping, to ensure that after removing the entered text from livesearch, the selection is not restored. This is useful in particular when you are using livesearch with a GtkTreeModel in a GtkTreeView with GtkSelectionMode set to GTK_SELECTION_SINGLE.

Since 2.2.10

The "filter" property

  "filter"                   GtkTreeModelFilter*   : Read / Write

The GtkTreeModelFilter to filter.

Since 2.2.4

The "text" property

  "text"                     gchar*                : Read / Write

The text used to filter

Default value: ""

Since 2.2.15

The "text-column" property

  "text-column"              gint                  : Read / Write

A G_TYPE_STRING column in the child model of "filter", to be used by the default filtering function of HildonLiveSearch.

Allowed values: >= -1

Default value: -1

Since 2.2.4

The "refilter" signal

gboolean            user_function                      (HildonLiveSearch *livesearch,
                                                        gpointer          user_data)       : Run Last

The "refilter" signal is emitted when the text in the entry changed and a refilter is needed.

If this signal is not stopped, gtk_tree_model_filter_refilter() will be called on the filter model. Otherwise the handler is responsible to refilter it.

Since 2.2.5