OssoABookFilterModel

typedef struct _OssoABookFilterModel OssoABookFilterModel;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

osso_abook_filter_model_new ()

OssoABookFilterModel* osso_abook_filter_model_new       (OssoABookListStore *child_model);

Creates a new OssoABookFilterModel object filtering the contents of child_model.

osso_abook_filter_model_set_visible_func ()

void                osso_abook_filter_model_set_visible_func
                                                        (OssoABookFilterModel *model,
                                                         GtkTreeModelFilterVisibleFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);

Sets a custom function to determine whether items in the model are visibile or not

osso_abook_filter_model_set_group ()

void                osso_abook_filter_model_set_group   (OssoABookFilterModel *model,
                                                         OssoABookGroup *group);

Sets model to filter on group, only letting through EContact - OssoABookPresence combinations that satisfy group. (And the text set by osso_abook_filter_model_set_text(), if any)

osso_abook_filter_model_get_group ()

OssoABookGroup*     osso_abook_filter_model_get_group   (OssoABookFilterModel *model);

Retrieves the OssoABookGroup that is being filtered on.

osso_abook_filter_model_set_text ()

void                osso_abook_filter_model_set_text    (OssoABookFilterModel *model,
                                                         const char *text);

Sets model to filter on text, only letting through EContacts whose names contain text. (And the group set by osso_abook_filter_model_set_group(), if any)

text is split up into bits, using space as delimiter. The order in which the bits appear in the searched text is not of importance. Case and accents are ignored. This means that for example "Elvis Presley" matches "Presley Elvis", and that "Björk" matches "bjork".

osso_abook_filter_model_set_prefix ()

void                osso_abook_filter_model_set_prefix  (OssoABookFilterModel *model,
                                                         const char *prefix);

works like osso_abook_filter_model_set_text with the difference that this version matches prefixes only

osso_abook_filter_model_get_text ()

const char*         osso_abook_filter_model_get_text    (OssoABookFilterModel *model);

Retrieves the text that is being filtered on.

osso_abook_filter_model_get_prefix ()

gboolean            osso_abook_filter_model_get_prefix  (OssoABookFilterModel *model);

Determines wether the filter text applies to full-text or prefix only

osso_abook_filter_model_freeze_refilter ()

void                osso_abook_filter_model_freeze_refilter
                                                        (OssoABookFilterModel *model);

Freezes the filter. This means that any calls to osso_abook_filter_model_set_group() or osso_abook_filter_model_set_text() will not have any effect until osso_abook_filter_model_thaw_refilter() is called.

Use this function if you need to change the group and the text at the same time. The rows will then be refiltered only once.

osso_abook_filter_model_thaw_refilter ()

void                osso_abook_filter_model_thaw_refilter
                                                        (OssoABookFilterModel *model);

Thaws the filter. See osso_abook_filter_model_freeze_refilter() for details.

osso_abook_filter_model_get_markup ()

PangoAttrList*      osso_abook_filter_model_get_markup  (OssoABookFilterModel *model,
                                                         const char *text);

Generates a PangoAttrList containing markup information to highlight any found bits of the filter text in text.

osso_abook_filter_model_is_row_visible ()

gboolean            osso_abook_filter_model_is_row_visible
                                                        (OssoABookFilterModel *model,
                                                         GtkTreeIter *iter);

Determines whether the row indicated by iter is visible, i.e. satisfies the filter requirements.

The "base-model" property

  "base-model"               OssoABookListStore*   : Read / Write / Construct Only

The contained OssoABookListStore.

The "group" property

  "group"                    OssoABookGroup*       : Read / Write

The group to be filtered on.

The "prefix" property

  "prefix"                   gboolean              : Read / Write

Wether or not only prefixes are matched.

Default value: FALSE

The "text" property

  "text"                     gchar*                : Read / Write

The text to be filtered on.

Default value: NULL