FilterListModel

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_filter_list_model_get_type ()" ) ]
public sealed class FilterListModel : Object, ListModel, SectionModel

`GtkFilterListModel` is a list model that filters the elements of the underlying model according to a `GtkFilter`.

It hides some elements from the other 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 [ method@Gtk.FilterListModel.set_incremental] for details.

`GtkFilterListModel` passes through sections from the underlying model.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Filter filter { get; set; }
The filter for this model.
public bool incremental { get; set; }
If the model should filter items incrementally.
public Type item_type { get; }
The type of items.
public ListModel model { get; set; }
The model being filtered.
public uint n_items { get; }
The number of items.
public uint pending { get; }
Number of items not yet filtered.

Creation methods:

public FilterListModel (owned ListModel? model, owned Filter? filter)
Creates a new `GtkFilterListModel` that will filter model using the given filter.

Methods:

public unowned Filter? get_filter ()
Gets the `GtkFilter` currently set on this .
public bool get_incremental ()
Returns whether incremental filtering is enabled.
public unowned ListModel? get_model ()
Gets the model currently filtered or null if none.
public uint get_pending ()
Returns the number of items that have not been filtered yet.
public void set_filter (Filter? filter)
Sets the filter used to filter items.
public void set_incremental (bool incremental)
Sets the filter model to do an incremental sort.
public void set_model (ListModel? model)
Sets the model to be filtered.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface GLib.ListModel

items_changed

All known members inherited from interface Gtk.SectionModel

get_section

sections_changed