Class

GtkFilterListModel

Description [src]

final class Gtk.FilterListModel : GObject.Object {
  /* No available fields */
}

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 searching, so that filtering long lists doesn’t block the UI. See gtk_filter_list_model_set_incremental() for details.

Hierarchy

hierarchy this GtkFilterListModel implements_0 GListModel this--implements_0 ancestor_0 GObject ancestor_0--this

Ancestors

Implements

Constructors

gtk_filter_list_model_new

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

Instance methods

gtk_filter_list_model_get_filter

Gets the GtkFilter currently set on self.

gtk_filter_list_model_get_incremental

Returns whether incremental filtering is enabled.

gtk_filter_list_model_get_model

Gets the model currently filtered or NULL if none.

gtk_filter_list_model_get_pending

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

gtk_filter_list_model_set_filter

Sets the filter used to filter items.

gtk_filter_list_model_set_incremental

Sets the filter model to do an incremental sort.

gtk_filter_list_model_set_model

Sets the model to be filtered.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GListModel (5)
g_list_model_get_item

Get the item at position.

Available since: 2.44

g_list_model_get_item_type

Gets the type of the items in list.

Available since: 2.44

g_list_model_get_n_items

Gets the number of items in list.

Available since: 2.44

g_list_model_get_object

Get the item at position.

Available since: 2.44

g_list_model_items_changed

Emits the GListModel::items-changed signal on list.

Available since: 2.44

Properties

Gtk.FilterListModel:filter

The filter for this model.

Gtk.FilterListModel:incremental

If the model should filter items incrementally.

Gtk.FilterListModel:model

The model being filtered.

Gtk.FilterListModel:pending

Number of items not yet filtered.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Signals inherited from GListModel (1)
Gio.ListModel::items-changed

This signal is emitted whenever items were added to or removed from list. At position, removed items were removed and added items were added in their place.

Available since: 2.44

Class structure

struct GtkFilterListModelClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class
GObjectClass
  No description available.