Struct gtk4::Sorter

pub struct Sorter { /* private fields */ }

Sorter is an object to describe sorting criteria.

Its primary user is SortListModel

The model will use a sorter to determine the order in which its items should appear by calling Gtk::Sorter::compare() for pairs of items.

Sorters may change their sorting behavior through their lifetime. In that case, they will emit the changed signal to notify that the sort order is no longer valid and should be updated by calling gtk_sorter_compare() again.

GTK provides various pre-made sorter implementations for common sorting operations. ColumnView has built-in support for sorting lists via the sorter property, where the user can change the sorting by clicking on list headers.

Of course, in particular for large lists, it is also possible to subclass Sorter and provide one’s own sorter.

Signals

changed

Emitted whenever the sorter changed.

Users of the sorter should then update the sort order again via gtk_sorter_compare().

SortListModel handles this signal automatically.

Depending on the @change parameter, it may be possible to update the sort order without a full resorting. Refer to the SorterChange documentation for details.

Implements

SorterExt, [trait@glib::ObjectExt]

Implementations

impl Sorter

pub const NONE: Option<&'static Sorter> = None

Trait Implementations

impl Clone for Sorter

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 Sorter

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

Formats the value using the given formatter.

impl HasParamSpec for Sorter

type ParamSpec = ParamSpecObject

type SetValue = Sorter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Sorter

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<T: SorterImpl> IsSubclassable<T> for Sorter

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Sorter

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 Sorter

type Parent = Object

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

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 Sorter

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 Sorter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Sorter

impl IsA<Sorter> for ColumnViewSorter

Available on crate feature v4_10 only.

impl IsA<Sorter> for CustomSorter

impl IsA<Sorter> for MultiSorter

impl IsA<Sorter> for NumericSorter

impl IsA<Sorter> for StringSorter

impl IsA<Sorter> for TreeListRowSorter