GtkFilterListModelFilterFunc ()

gboolean
(*GtkFilterListModelFilterFunc) (gpointer item,
                                 gpointer user_data);

User function that is called to determine if the item of the original model should be visible. If it should be visible, this function must return TRUE. If the model should filter out the item , FALSE must be returned.

gtk_filter_list_model_new ()

GtkFilterListModel *
gtk_filter_list_model_new (GListModel *model,
                           GtkFilterListModelFilterFunc filter_func,
                           gpointer user_data,
                           GDestroyNotify user_destroy);

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

gtk_filter_list_model_new_for_type ()

GtkFilterListModel *
gtk_filter_list_model_new_for_type (GType item_type);

Creates a new empty filter list model set up to return items of type item_type . It is up to the application to set a proper filter function and model to ensure the item type is matched.

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 function 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_func ()

void
gtk_filter_list_model_set_filter_func (GtkFilterListModel *self,
                                       GtkFilterListModelFilterFunc filter_func,
                                       gpointer user_data,
                                       GDestroyNotify user_destroy);

Sets the function used to filter items. The function will be called for every item and if it returns TRUE the item is considered visible.

gtk_filter_list_model_has_filter ()

gboolean
gtk_filter_list_model_has_filter (GtkFilterListModel *self);

Checks if a filter function is currently set on self

gtk_filter_list_model_refilter ()

void
gtk_filter_list_model_refilter (GtkFilterListModel *self);

Causes self to refilter all items in the model.

Calling this function is necessary when data used by the filter function has changed.

GtkFilterListModel

typedef struct _GtkFilterListModel GtkFilterListModel;

The “has-filter” property

  “has-filter”               gboolean

If a filter is set for this model

Owner: GtkFilterListModel

Flags: Read

Default value: FALSE

The “item-type” property

  “item-type”                GType *

The GType for elements of this object

Owner: GtkFilterListModel

Flags: Read / Write / Construct Only

Allowed values: GObject

The “model” property

  “model”                    GListModel *

The model being filtered

Owner: GtkFilterListModel

Flags: Read / Write / Construct Only