Package: gtk

Class gtk:filter

Superclasses

gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

Direct Slots

None

Details

The gtk:filter object describes the filtering to be performed by a gtk:filter-list-model object. The model will use the filter to determine if it should include items or not by calling the gtk:filter-match function 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 "changed" signal to notify that previous filter results are no longer valid and that items should be checked again via the gtk:filter-match function.

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 the gtk:filter class and provide one's own filter.

Signal Details

The "changed" signal
lambda (filter change)    :run-last      
filter
The gtk:filter object.
change
The gtk:filter-change value.
The signal is emitted whenever the filter changed. Users of the filter should then check items again via the gtk:filter-match function. The gtk:filter-list-model object handles this signal automatically. Depending on the change parameter, not all items need to be changed, but only some. Refer to the gtk:filter-change documentation for details.
 

Inherited Slot Access Functions

See also

2024-10-20