Struct StringSorter

pub struct StringSorter { /* private fields */ }

StringSorter is a Sorter that compares strings.

It does the comparison in a linguistically correct way using the current locale by normalizing Unicode strings and possibly case-folding them before performing the comparison.

To obtain the strings to compare, this sorter evaluates a Expression.

Properties

collation

The collation method to use for sorting.

The GTK_COLLATION_NONE value is useful when the expression already returns collation keys, or strings that need to be compared byte-by-byte.

The default value, GTK_COLLATION_UNICODE, compares strings according to the Unicode collation algorithm.

Readable | Writeable

expression

The expression to evaluate on item to get a string to compare with.

Readable | Writeable

ignore-case

If sorting is case sensitive.

Readable | Writeable

Implements

SorterExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl StringSorter

pub fn new(expression: Option<impl AsRef<Expression>>) -> StringSorter

Creates a new string sorter that compares items using the given @expression.

Unless an expression is set on it, this sorter will always compare items as invalid.

expression

The expression to evaluate

Returns

a new StringSorter

pub fn builder() -> StringSorterBuilder

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

This method returns an instance of StringSorterBuilder which can be used to create StringSorter objects.

pub fn collation(&self) -> Collation

Available on crate feature v4_10 only.

Gets which collation method the sorter uses.

Returns

The collation method

pub fn expression(&self) -> Option<Expression>

Gets the expression that is evaluated to obtain strings from items.

Returns

a Expression

pub fn ignores_case(&self) -> bool

Gets whether the sorter ignores case differences.

Returns

true if @self is ignoring case differences

pub fn set_collation(&self, collation: Collation)

Available on crate feature v4_10 only.

Sets the collation method to use for sorting.

collation

the collation method

pub fn set_expression(&self, expression: Option<impl AsRef<Expression>>)

Sets the expression that is evaluated to obtain strings from items.

The expression must have the type G_TYPE_STRING.

expression

a Expression

pub fn set_ignore_case(&self, ignore_case: bool)

Sets whether the sorter will ignore case differences.

ignore_case

true to ignore case differences

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

Available on crate feature v4_10 only.

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

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

Trait Implementations

impl Clone for StringSorter

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for StringSorter

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

Formats the value using the given formatter.

impl Default for StringSorter

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for StringSorter

type ParamSpec = ParamSpecObject

type SetValue = StringSorter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StringSorter

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

where H: Hasher,

Hashes the memory address of this object.

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 StringSorter

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for StringSorter

type Parent = Sorter

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for StringSorter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StringSorter

impl IsA<Sorter> for StringSorter