Package: gtk

Class gtk:sort-list-model

Superclasses

gio:list-model, gtk:section-model, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

incremental
The incremental property of type :boolean (Read / Write)
Whether the model should sort items incrementally.
Default value: false
item-type
The item-type property of type g:type-t (Read)
The type of items. Since 4.8
model
The model property of type g:list-model (Read / Write)
The model being sorted.
n-items
The n-items property of type :uint (Read / Write)
The number of items.
Default value: 0
pending
The pending property of type :uint (Read / Write)
Estimate of unsorted items remaining.
Default value: 0
section-sorter
The section-sorter property of type gtk:sorter (Read / Write)
The section sorter for this model, if one is set.
sorter
The sorter property of type gtk:sorter (Read / Write)
The sorter for this model.

Details

The gtk:sort-list-model object is a g:list-model object that sorts the elements of an underlying model according to a gtk:sorter object.

The model is a stable sort. If two items compare equal according to the sorter, the one that appears first in the original model will also appear first after sorting. Note that if you change the sorter, the previous order will have no influence on the new order. If you want that, consider using a gtk:multi-sorter object and appending the previous sorter to it.

The model can be set up to do incremental sorting, so that sorting long lists does not block the UI. See the gtk:sort-list-model-incremental function for details.

The gtk:sort-list-model object is a generic model and because of that it cannot take advantage of any external knowledge when sorting. If you run into performance issues with the gtk:sort-list-model object, it is strongly recommended that you write your own sorting list model.

The gtk:sort-list-model object allows sorting the items into sections. It implements the gtk:section-model interface and when the section-sorter is set, it will sort all items with that sorter and items comparing equal with it will be put into the same section. The sorter property will then be used to sort items inside their sections.
 

Returned by

Slot Access Functions

Inherited Slot Access Functions

See also

2024-12-15