Struct gtk4::ColumnViewSorter

#[repr(transparent)]
pub struct ColumnViewSorter { /* private fields */ }

Available on crate feature v4_10 only.

ColumnViewSorter is a sorter implementation that is geared towards the needs of ColumnView.

The sorter returned by ColumnView::sorter() is a ColumnViewSorter.

In column views, sorting can be configured by associating sorters with columns, and users can invert sort order by clicking on column headers. The API of ColumnViewSorter is designed to allow saving and restoring this configuration.

If you are only interested in the primary sort column (i.e. the column where a sort indicator is shown in the header), then you can just look at property::ColumnViewSorter::primary-sort-column and property::ColumnViewSorter::primary-sort-order.

If you want to store the full sort configuration, including secondary sort columns that are used for tie breaking, then you can use nth_sort_column(). To get notified about changes, use signal::Sorter::changed.

To restore a saved sort configuration on a ColumnView, use code like:

sorter = gtk_column_view_get_sorter (view);
for (i = gtk_column_view_sorter_get_n_sort_columns (sorter) - 1; i >= 0; i--)
  {
    column = gtk_column_view_sorter_get_nth_sort_column (sorter, i, &order);
    gtk_column_view_sort_by_column (view, column, order);
  }

Implements

SorterExt, glib::ObjectExt

Implementations

impl ColumnViewSorter

pub fn n_sort_columns(&self) -> u32

Returns the number of columns by which the sorter sorts.

If the sorter of the primary sort column does not determine a total order, then the secondary sorters are consulted to break the ties.

Use the signal::Sorter::changed signal to get notified when the number of sort columns changes.

Returns

the number of sort columns

pub fn nth_sort_column(
    &self,
    position: u32
) -> (Option<ColumnViewColumn>, SortType)

Gets the @position’th sort column and its associated sort order.

Use the signal::Sorter::changed signal to get notified when sort columns change.

position

the position of the sort column to retrieve (0 for the primary sort column)

Returns

the @positions sort column

sort_order

return location for the sort order

pub fn primary_sort_column(&self) -> Option<ColumnViewColumn>

Returns the primary sort column.

The primary sort column is the one that displays the triangle in a column view header.

Returns

the primary sort column

pub fn primary_sort_order(&self) -> SortType

Returns the primary sort order.

The primary sort order determines whether the triangle displayed in the column view header of the primary sort column points upwards or downwards.

If there is no primary sort column, then this function returns GTK_SORT_ASCENDING.

Returns

the primary sort order

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

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

Trait Implementations

impl Clone for ColumnViewSorter

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 ColumnViewSorter

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

Formats the value using the given formatter.

impl Display for ColumnViewSorter

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

Formats the value using the given formatter.

impl Hash for ColumnViewSorter

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 ColumnViewSorter

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ColumnViewSorter

type Parent = Sorter

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

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 ColumnViewSorter

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 ColumnViewSorter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ColumnViewSorter

impl IsA<Sorter> for ColumnViewSorter