Gtk.FilterListModel¶

class — extends GObject.Object, Gio.ListModel, SectionModel

A list model that filters the elements of another model.

It hides some elements from the underlying model according to criteria given by a GtkFilter.

The model can be set up to do incremental filtering, so that filtering long lists doesn't block the UI. See FilterListModel.set_incremental for details.

GtkFilterListModel passes through sections from the underlying model.

Constructors¶

new¶

@classmethod
def new(cls, model: Gio.ListModel | None = ..., filter: Filter | None = ...) -> FilterListModel

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

Parameters:

model — the model to sort
filter — filter

Methods¶

get_filter¶

def get_filter(self) -> Filter | None

Gets the GtkFilter currently set on self.

get_incremental¶

def get_incremental(self) -> bool

Returns whether incremental filtering is enabled.

See FilterListModel.set_incremental.

get_model¶

def get_model(self) -> Gio.ListModel | None

Gets the model currently filtered or None if none.

get_pending¶

def get_pending(self) -> int

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 FilterListModel.incremental is False - this function returns 0.

get_watch_items¶

def get_watch_items(self) -> bool

Returns whether watching items is enabled.

See FilterListModel.set_watch_items.

set_filter¶

def set_filter(self, filter: Filter | None = ...) -> None

Sets the filter used to filter items.

Parameters:

filter — filter to use

set_incremental¶

def set_incremental(self, incremental: bool) -> None

Sets the filter model to do an incremental sort.

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 FilterListModel.get_pending for progress information about an ongoing incremental filtering operation.

Parameters:

incremental — True to enable incremental filtering

set_model¶

def set_model(self, model: Gio.ListModel | None = ...) -> None

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.

Parameters:

model — The model to be filtered

set_watch_items¶

def set_watch_items(self, watch_items: bool) -> None

Sets the filter model to monitor properties of its items.

This allows implementations of Filter that support expression watching to react to property changes. This property has no effect if the current filter doesn't support watching items.

By default, watching items is disabled.

Parameters:

watch_items — True to watch items for property changes

Properties¶

filter¶

filter: Filter  # read/write

The filter for this model.

incremental¶

incremental: bool  # read/write

If the model should filter items incrementally.

item_type¶

item_type: type | GObject.Type  # read-only

The type of items. See Gio.ListModel.get_item_type.

model¶

model: Gio.ListModel  # read/write

The model being filtered.

n_items¶

n_items: int  # read-only

The number of items. See Gio.ListModel.get_n_items.

pending¶

pending: int  # read-only

Number of items not yet filtered.

watch_items¶

watch_items: bool  # read/write

Monitor the list items for changes. It may impact performance.