Struct gtk4::SortListModel

pub struct SortListModel { /* private fields */ }

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

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 MultiSorter 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 set_incremental() for details.

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

SortListModel allows sorting the items into sections. It implements SectionModel and when 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 will then be used to sort items inside their sections.

Properties

incremental

If the model should sort items incrementally.

Readable | Writeable

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

model

The model being sorted.

Readable | Writeable

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

pending

Estimate of unsorted items remaining.

Readable

section-sorter

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

Readable | Writeable

sorter

The sorter for this model.

Readable | Writeable

Implements

[trait@glib::ObjectExt], gio::prelude::ListModelExt, SectionModelExt

Implementations

impl SortListModel

pub fn new( model: Option<impl IsA<ListModel>>, sorter: Option<impl IsA<Sorter>> ) -> SortListModel

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

model

the model to sort

sorter

the Sorter to sort @model with,

Returns

a new SortListModel

pub fn builder() -> SortListModelBuilder

Creates a new builder-pattern struct instance to construct SortListModel objects.

This method returns an instance of SortListModelBuilder which can be used to create SortListModel objects.

pub fn is_incremental(&self) -> bool

Returns whether incremental sorting is enabled.

See set_incremental().

Returns

true if incremental sorting is enabled

pub fn model(&self) -> Option<ListModel>

Gets the model currently sorted or None if none.

Returns

The model that gets sorted

pub fn pending(&self) -> u32

Estimates progress of an ongoing sorting operation.

The estimate is the number of items that would still need to be sorted to finish the sorting operation if this was a linear algorithm. So this number is not related to how many items are already correctly sorted.

If you want to estimate the progress, you can use code like this: ⚠️ The following code is in c ⚠️

pending = gtk_sort_list_model_get_pending (self);
model = gtk_sort_list_model_get_model (self);
progress = 1.0 - pending / (double) MAX (1, g_list_model_get_n_items (model));

If no sort operation is ongoing - in particular when incremental is false - this function returns 0.

Returns

a progress estimate of remaining items to sort

pub fn section_sorter(&self) -> Option<Sorter>

Available on crate feature v4_12 only.

Gets the section sorter that is used to sort items of @self into sections.

Returns

the sorter of #self

pub fn sorter(&self) -> Option<Sorter>

Gets the sorter that is used to sort @self.

Returns

the sorter of #self

pub fn set_incremental(&self, incremental: bool)

Sets the sort model to do an incremental sort.

When incremental sorting is enabled, the SortListModel will not do a complete sort immediately, but will instead queue an idle handler that incrementally sorts the items towards their correct position. This of course means that items do not instantly appear in the right place. It also means that the total sorting time is a lot slower.

When your filter blocks the UI while sorting, you might consider turning this on. Depending on your model and sorters, this may become interesting around 10,000 to 100,000 items.

By default, incremental sorting is disabled.

See pending() for progress information about an ongoing incremental sorting operation.

incremental

true to sort incrementally

pub fn set_model(&self, model: Option<&impl IsA<ListModel>>)

Sets the model to be sorted.

The @model’s item type must conform to the item type of @self.

model

The model to be sorted

pub fn set_section_sorter(&self, sorter: Option<&impl IsA<Sorter>>)

Available on crate feature v4_12 only.

Sets a new section sorter on @self.

sorter

the Sorter to sort @model with

pub fn set_sorter(&self, sorter: Option<&impl IsA<Sorter>>)

Sets a new sorter on @self.

sorter

the Sorter to sort @model with

pub fn connect_incremental_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_pending_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_section_sorter_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_12 only.

pub fn connect_sorter_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for SortListModel

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SortListModel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SortListModel

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SortListModel

type ParamSpec = ParamSpecObject

type SetValue = SortListModel

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SortListModel>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SortListModel

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SortListModel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for SortListModel

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for SortListModel

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SortListModel

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SortListModel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SortListModel

impl IsA<ListModel> for SortListModel

impl IsA<SectionModel> for SortListModel