gtk.filter

Module for [Filter] class

class Filter FilterGidBuilder FilterGidBuilderImpl

Types 3

A [gtk.filter.Filter] object describes the filtering to be performed by a [gtk.filter_list_model.FilterListModel].

The model will use the filter to determine if it should include items or not by calling [gtk.filter.Filter.match] for each item and only keeping the ones that the function returns true for.

Filters may change what items they match through their lifetime. In that case, they will emit the [gtk.filter.Filter.changed] signal to notify that previous filter results are no longer valid and that items should be checked again via [gtk.filter.Filter.match].

GTK provides various pre-made filter implementations for common filtering operations. These filters often include properties that can be linked to various widgets to easily allow searches.

However, in particular for large lists or complex search methods, it is also possible to subclass [gtk.filter.Filter] and provide one's own filter.

Methods

GType _getGType()

GType _gType() @property

Filter self()Returns `this`, for use in `with` statements.

FilterGidBuilder builder()Get builder for [gtk.filter.Filter] Returns: New builder object

void changed(gtk.types.FilterChange change)Notifies all users of the filter that it has changed.

gtk.types.FilterMatch getStrictness()Gets the known strictness of filters.

bool match(gobject.object.ObjectWrap item)Checks if the given item is matched by the filter or not.

gulong connectChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.types.FilterChange)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.filter.Filter)))
   &&  Parameters!T.length <  3)

Connect to `Changed` signal.

Constructors

this(void * ptr, Flag!"Take" take)

classFilterGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

classFilterGidBuilder : FilterGidBuilderImpl!FilterGidBuilder

Fluent builder for [gtk.filter.Filter]

Methods

Filter build()