gtk4/auto/

column_view_sorter.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, ColumnViewColumn, SortType, Sorter};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`ColumnViewSorter`][crate::ColumnViewSorter] is a sorter implementation that
    /// is geared towards the needs of [`ColumnView`][crate::ColumnView].
    ///
    /// The sorter returned by [`ColumnView::sorter()`][crate::ColumnView::sorter()] is
    /// a [`ColumnViewSorter`][crate::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`][crate::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 [`primary-sort-column`][struct@crate::ColumnViewSorter#primary-sort-column]
    /// and [`primary-sort-order`][struct@crate::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()`][Self::nth_sort_column()].
    /// To get notified about changes, use [`changed`][struct@crate::Sorter#changed].
    ///
    /// To restore a saved sort configuration on a [`ColumnView`][crate::ColumnView],
    /// use code like:
    ///
    /// ```text
    /// 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);
    ///   }
    /// ```
    ///
    /// ## Properties
    ///
    ///
    /// #### `primary-sort-column`
    ///  The primary sort column.
    ///
    /// The primary sort column is the one that displays the triangle
    /// in a column view header.
    ///
    /// Readable
    ///
    ///
    /// #### `primary-sort-order`
    ///  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.
    ///
    /// Readable
    ///
    /// # Implements
    ///
    /// [`SorterExt`][trait@crate::prelude::SorterExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkColumnViewSorter")]
    pub struct ColumnViewSorter(Object<ffi::GtkColumnViewSorter, ffi::GtkColumnViewSorterClass>) @extends Sorter;

    match fn {
        type_ => || ffi::gtk_column_view_sorter_get_type(),
    }
}

impl ColumnViewSorter {
    /// 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 [`changed`][struct@crate::Sorter#changed] signal to get notified
    /// when the number of sort columns changes.
    ///
    /// # Returns
    ///
    /// the number of sort columns
    #[doc(alias = "gtk_column_view_sorter_get_n_sort_columns")]
    #[doc(alias = "get_n_sort_columns")]
    pub fn n_sort_columns(&self) -> u32 {
        unsafe { ffi::gtk_column_view_sorter_get_n_sort_columns(self.to_glib_none().0) }
    }

    /// Gets the @position'th sort column and its associated sort order.
    ///
    /// Use the [`changed`][struct@crate::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
    #[doc(alias = "gtk_column_view_sorter_get_nth_sort_column")]
    #[doc(alias = "get_nth_sort_column")]
    pub fn nth_sort_column(&self, position: u32) -> (Option<ColumnViewColumn>, SortType) {
        unsafe {
            let mut sort_order = std::mem::MaybeUninit::uninit();
            let ret = from_glib_none(ffi::gtk_column_view_sorter_get_nth_sort_column(
                self.to_glib_none().0,
                position,
                sort_order.as_mut_ptr(),
            ));
            (ret, from_glib(sort_order.assume_init()))
        }
    }

    /// 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
    #[doc(alias = "gtk_column_view_sorter_get_primary_sort_column")]
    #[doc(alias = "get_primary_sort_column")]
    #[doc(alias = "primary-sort-column")]
    pub fn primary_sort_column(&self) -> Option<ColumnViewColumn> {
        unsafe {
            from_glib_none(ffi::gtk_column_view_sorter_get_primary_sort_column(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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
    #[doc(alias = "gtk_column_view_sorter_get_primary_sort_order")]
    #[doc(alias = "get_primary_sort_order")]
    #[doc(alias = "primary-sort-order")]
    pub fn primary_sort_order(&self) -> SortType {
        unsafe {
            from_glib(ffi::gtk_column_view_sorter_get_primary_sort_order(
                self.to_glib_none().0,
            ))
        }
    }

    #[cfg(feature = "v4_10")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
    #[doc(alias = "primary-sort-column")]
    pub fn connect_primary_sort_column_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_primary_sort_column_trampoline<
            F: Fn(&ColumnViewSorter) + 'static,
        >(
            this: *mut ffi::GtkColumnViewSorter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::primary-sort-column\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_primary_sort_column_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_10")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_10")))]
    #[doc(alias = "primary-sort-order")]
    pub fn connect_primary_sort_order_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_primary_sort_order_trampoline<
            F: Fn(&ColumnViewSorter) + 'static,
        >(
            this: *mut ffi::GtkColumnViewSorter,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::primary-sort-order\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_primary_sort_order_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}