gtk4/auto/

column_view_row.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;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`ColumnViewRow`][crate::ColumnViewRow] is used by [`ColumnView`][crate::ColumnView] to allow configuring
    /// how rows are displayed.
    ///
    /// It is not used to set the widgets displayed in the individual cells. For that
    /// see `GtkColumnViewColumn::set_factory()` and [`ColumnViewCell`][crate::ColumnViewCell].
    ///
    /// ## Properties
    ///
    ///
    /// #### `accessible-description`
    ///  The accessible description to set on the row.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `accessible-label`
    ///  The accessible label to set on the row.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `activatable`
    ///  If the row can be activated by the user.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focusable`
    ///  If the row can be focused with the keyboard.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `item`
    ///  The item for this row.
    ///
    /// Readable
    ///
    ///
    /// #### `position`
    ///  Position of the row.
    ///
    /// Readable
    ///
    ///
    /// #### `selectable`
    ///  If the row can be selected by the user.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `selected`
    ///  If the item in the row is currently selected.
    ///
    /// Readable
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkColumnViewRow")]
    pub struct ColumnViewRow(Object<ffi::GtkColumnViewRow, ffi::GtkColumnViewRowClass>);

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

impl ColumnViewRow {
    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`ColumnViewRow`] objects.
    ///
    /// This method returns an instance of [`ColumnViewRowBuilder`](crate::builders::ColumnViewRowBuilder) which can be used to create [`ColumnViewRow`] objects.
    pub fn builder() -> ColumnViewRowBuilder {
        ColumnViewRowBuilder::new()
    }

    /// Gets the accessible description of @self.
    ///
    /// # Returns
    ///
    /// the accessible description
    #[doc(alias = "gtk_column_view_row_get_accessible_description")]
    #[doc(alias = "get_accessible_description")]
    #[doc(alias = "accessible-description")]
    pub fn accessible_description(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_column_view_row_get_accessible_description(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the accessible label of @self.
    ///
    /// # Returns
    ///
    /// the accessible label
    #[doc(alias = "gtk_column_view_row_get_accessible_label")]
    #[doc(alias = "get_accessible_label")]
    #[doc(alias = "accessible-label")]
    pub fn accessible_label(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_column_view_row_get_accessible_label(
                self.to_glib_none().0,
            ))
        }
    }

    /// Checks if the row has been set to be activatable via
    /// gtk_column_view_row_set_activatable().
    ///
    /// # Returns
    ///
    /// [`true`] if the row is activatable
    #[doc(alias = "gtk_column_view_row_get_activatable")]
    #[doc(alias = "get_activatable")]
    #[doc(alias = "activatable")]
    pub fn is_activatable(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_column_view_row_get_activatable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Checks if a row item has been set to be focusable via
    /// gtk_column_view_row_set_focusable().
    ///
    /// # Returns
    ///
    /// [`true`] if the row is focusable
    #[doc(alias = "gtk_column_view_row_get_focusable")]
    #[doc(alias = "get_focusable")]
    #[doc(alias = "focusable")]
    pub fn is_focusable(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_column_view_row_get_focusable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the model item that associated with @self.
    ///
    /// If @self is unbound, this function returns [`None`].
    ///
    /// # Returns
    ///
    /// The item displayed
    #[doc(alias = "gtk_column_view_row_get_item")]
    #[doc(alias = "get_item")]
    pub fn item(&self) -> Option<glib::Object> {
        unsafe { from_glib_none(ffi::gtk_column_view_row_get_item(self.to_glib_none().0)) }
    }

    /// Gets the position in the model that @self currently displays.
    ///
    /// If @self is unbound, `GTK_INVALID_LIST_POSITION` is returned.
    ///
    /// # Returns
    ///
    /// The position of this row
    #[doc(alias = "gtk_column_view_row_get_position")]
    #[doc(alias = "get_position")]
    pub fn position(&self) -> u32 {
        unsafe { ffi::gtk_column_view_row_get_position(self.to_glib_none().0) }
    }

    /// Checks if the row has been set to be selectable via
    /// gtk_column_view_row_set_selectable().
    ///
    /// Do not confuse this function with [`is_selected()`][Self::is_selected()].
    ///
    /// # Returns
    ///
    /// [`true`] if the row is selectable
    #[doc(alias = "gtk_column_view_row_get_selectable")]
    #[doc(alias = "get_selectable")]
    #[doc(alias = "selectable")]
    pub fn is_selectable(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_column_view_row_get_selectable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Checks if the item is selected that this row corresponds to.
    ///
    /// The selected state is maintained by the list widget and its model
    /// and cannot be set otherwise.
    ///
    /// # Returns
    ///
    /// [`true`] if the item is selected.
    #[doc(alias = "gtk_column_view_row_get_selected")]
    #[doc(alias = "get_selected")]
    #[doc(alias = "selected")]
    pub fn is_selected(&self) -> bool {
        unsafe { from_glib(ffi::gtk_column_view_row_get_selected(self.to_glib_none().0)) }
    }

    /// Sets the accessible description for the row,
    /// which may be used by e.g. screen readers.
    /// ## `description`
    /// the description
    #[doc(alias = "gtk_column_view_row_set_accessible_description")]
    #[doc(alias = "accessible-description")]
    pub fn set_accessible_description(&self, description: &str) {
        unsafe {
            ffi::gtk_column_view_row_set_accessible_description(
                self.to_glib_none().0,
                description.to_glib_none().0,
            );
        }
    }

    /// Sets the accessible label for the row,
    /// which may be used by e.g. screen readers.
    /// ## `label`
    /// the label
    #[doc(alias = "gtk_column_view_row_set_accessible_label")]
    #[doc(alias = "accessible-label")]
    pub fn set_accessible_label(&self, label: &str) {
        unsafe {
            ffi::gtk_column_view_row_set_accessible_label(
                self.to_glib_none().0,
                label.to_glib_none().0,
            );
        }
    }

    /// Sets @self to be activatable.
    ///
    /// If a row is activatable, double-clicking on the row, using
    /// the Return key or calling gtk_widget_activate() will activate
    /// the row. Activating instructs the containing columnview to
    /// emit the [`activate`][struct@crate::ColumnView#activate] signal.
    ///
    /// By default, row are activatable.
    /// ## `activatable`
    /// if the row should be activatable
    #[doc(alias = "gtk_column_view_row_set_activatable")]
    #[doc(alias = "activatable")]
    pub fn set_activatable(&self, activatable: bool) {
        unsafe {
            ffi::gtk_column_view_row_set_activatable(
                self.to_glib_none().0,
                activatable.into_glib(),
            );
        }
    }

    /// Sets @self to be focusable.
    ///
    /// If a row is focusable, it can be focused using the keyboard.
    /// This works similar to [`WidgetExt::set_focusable()`][crate::prelude::WidgetExt::set_focusable()].
    ///
    /// Note that if row are not focusable, the contents of cells can still be focused if
    /// they are focusable.
    ///
    /// By default, rows are focusable.
    /// ## `focusable`
    /// if the row should be focusable
    #[doc(alias = "gtk_column_view_row_set_focusable")]
    #[doc(alias = "focusable")]
    pub fn set_focusable(&self, focusable: bool) {
        unsafe {
            ffi::gtk_column_view_row_set_focusable(self.to_glib_none().0, focusable.into_glib());
        }
    }

    /// Sets @self to be selectable.
    ///
    /// If a row is selectable, clicking on the row or using the keyboard
    /// will try to select or unselect the row. Whether this succeeds is up to
    /// the model to determine, as it is managing the selected state.
    ///
    /// Note that this means that making a row non-selectable has no
    /// influence on the selected state at all. A non-selectable row
    /// may still be selected.
    ///
    /// By default, rows are selectable.
    /// ## `selectable`
    /// if the row should be selectable
    #[doc(alias = "gtk_column_view_row_set_selectable")]
    #[doc(alias = "selectable")]
    pub fn set_selectable(&self, selectable: bool) {
        unsafe {
            ffi::gtk_column_view_row_set_selectable(self.to_glib_none().0, selectable.into_glib());
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "accessible-description")]
    pub fn connect_accessible_description_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_accessible_description_trampoline<
            F: Fn(&ColumnViewRow) + 'static,
        >(
            this: *mut ffi::GtkColumnViewRow,
            _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::accessible-description\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accessible_description_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "accessible-label")]
    pub fn connect_accessible_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_accessible_label_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::accessible-label\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accessible_label_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "activatable")]
    pub fn connect_activatable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_activatable_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::activatable\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_activatable_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "focusable")]
    pub fn connect_focusable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_focusable_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::focusable\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_focusable_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "item")]
    pub fn connect_item_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_item_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::item\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_item_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "position")]
    pub fn connect_position_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_position_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::position\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_position_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "selectable")]
    pub fn connect_selectable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_selectable_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::selectable\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_selectable_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "selected")]
    pub fn connect_selected_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_selected_trampoline<F: Fn(&ColumnViewRow) + 'static>(
            this: *mut ffi::GtkColumnViewRow,
            _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::selected\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_selected_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ColumnViewRow`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ColumnViewRowBuilder {
    builder: glib::object::ObjectBuilder<'static, ColumnViewRow>,
}

impl ColumnViewRowBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The accessible description to set on the row.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn accessible_description(self, accessible_description: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("accessible-description", accessible_description.into()),
        }
    }

    /// The accessible label to set on the row.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn accessible_label(self, accessible_label: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("accessible-label", accessible_label.into()),
        }
    }

    /// If the row can be activated by the user.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn activatable(self, activatable: bool) -> Self {
        Self {
            builder: self.builder.property("activatable", activatable),
        }
    }

    /// If the row can be focused with the keyboard.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn focusable(self, focusable: bool) -> Self {
        Self {
            builder: self.builder.property("focusable", focusable),
        }
    }

    /// If the row can be selected by the user.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn selectable(self, selectable: bool) -> Self {
        Self {
            builder: self.builder.property("selectable", selectable),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`ColumnViewRow`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> ColumnViewRow {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}