gtk4/org.gtkkn.bindings.gtk/SortListModel

SortListModel

open class SortListModel(pointer: <Error class: unknown class><<Error class: unknown class>>) : SectionModel

A GListModel that sorts the elements of an underlying model according to a GtkSorter.

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 GtkMultiSorter and appending the previous sorter to it.

The model can be set up to do incremental sorting, so that sorting long lists doesn't block the UI. See method@Gtk.SortListModel.set_incremental for details.

GtkSortListModel 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 GtkSortListModel, it is strongly recommended that you write your own sorting list model.

GtkSortListModel allows sorting the items into sections. It implements GtkSectionModel and when property@Gtk.SortListModel: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 property@Gtk.SortListModel:sorter will then be used to sort items inside their sections.

Skipped during bindings generation

method item-type: Property has no getter nor setter
method n-items: Property has no getter nor setter

Constructors

SortListModel

constructor(model: <Error class: unknown class>? = null, sorter: Sorter? = null)

Creates a new sort list model that uses the @sorter to sort @model.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioListModelPointer

open override val gioListModelPointer: <Error class: unknown class><<Error class: unknown class>>

gtkSectionModelPointer

open override val gtkSectionModelPointer: <Error class: unknown class><<Error class: unknown class>>

gtkSortListModelPointer

val gtkSortListModelPointer: <Error class: unknown class><<Error class: unknown class>>

incremental

open var incremental: Boolean

If the model should sort items incrementally.

model

open var model: <Error class: unknown class>?

The model being sorted.

pending

open val pending: <Error class: unknown class>

Estimate of unsorted items remaining.

sectionSorter

open var sectionSorter: Sorter?

The section sorter for this model, if one is set.

sorter

open var sorter: Sorter?

The sorter for this model.

Functions

connectSectionsChanged

open fun connectSectionsChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted when the start-of-section state of some of the items in @model changes.

sectionsChanged

open fun sectionsChanged(position: <Error class: unknown class>, nItems: <Error class: unknown class>)

This function emits the signal@Gtk.SectionModel::sections-changed signal to notify about changes to sections.