gtk_filter_list_model_new ()

GtkFilterListModel *
gtk_filter_list_model_new (GListModel *model,
                           GtkFilter *filter);

Creates a new GtkFilterListModel that will filter model using the given filter .

gtk_filter_list_model_set_model ()

void
gtk_filter_list_model_set_model (GtkFilterListModel *self,
                                 GListModel *model);

Sets the model to be filtered.

Note that GTK makes no effort to ensure that model conforms to the item type of self . It assumes that the caller knows what they are doing and have set up an appropriate filter to ensure that item types match.

gtk_filter_list_model_get_model ()

GListModel *
gtk_filter_list_model_get_model (GtkFilterListModel *self);

Gets the model currently filtered or NULL if none.

gtk_filter_list_model_set_filter ()

void
gtk_filter_list_model_set_filter (GtkFilterListModel *self,
                                  GtkFilter *filter);

Sets the filter used to filter items.

gtk_filter_list_model_get_filter ()

GtkFilter *
gtk_filter_list_model_get_filter (GtkFilterListModel *self);

Gets the GtkFilter currently set on self .

gtk_filter_list_model_set_incremental ()

void
gtk_filter_list_model_set_incremental (GtkFilterListModel *self,
                                       gboolean incremental);

When incremental filtering is enabled, the GtkFilterListModel will not run filters immediately, but will instead queue an idle handler that incrementally filters the items and adds them to the list. This of course means that items are not instantly added to the list, but only appear incrementally.

When your filter blocks the UI while filtering, you might consider turning this on. Depending on your model and filters, this may become interesting around 10,000 to 100,000 items.

By default, incremental filtering is disabled.

See gtk_filter_list_model_get_pending() for progress information about an ongoing incremental filtering operation.

gtk_filter_list_model_get_incremental ()

gboolean
gtk_filter_list_model_get_incremental (GtkFilterListModel *self);

Returns whether incremental filtering was enabled via gtk_filter_list_model_set_incremental().

gtk_filter_list_model_get_pending ()

guint
gtk_filter_list_model_get_pending (GtkFilterListModel *self);

Returns the number of items that have not been filtered yet.

You can use this value to check if self is busy filtering by comparing the return value to 0 or you can compute the percentage of the filter remaining by dividing the return value by the total number of items in the underlying model:

pending = gtk_filter_list_model_get_pending (self);
model = gtk_filter_list_model_get_model (self);
percentage = pending / (double) g_list_model_get_n_items (model);

If no filter operation is ongoing - in particular when “incremental” is FALSE - this function returns 0.

GtkFilterListModel

typedef struct _GtkFilterListModel GtkFilterListModel;

The “filter” property

  “filter”                   GtkFilter *

The filter for this model

Owner: GtkFilterListModel

Flags: Read / Write

The “incremental” property

  “incremental”              gboolean

If the model should filter items incrementally

Owner: GtkFilterListModel

Flags: Read / Write

Default value: FALSE

The “model” property

  “model”                    GListModel *

The model being filtered

Owner: GtkFilterListModel

Flags: Read / Write

The “pending” property

  “pending”                  guint

Number of items not yet filtered

Owner: GtkFilterListModel

Flags: Read

Default value: 0