gtk4/auto/

column_view_cell.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, ListItem, Widget};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`ColumnViewCell`][crate::ColumnViewCell] is used by [`ColumnViewColumn`][crate::ColumnViewColumn] to represent items
    /// in a cell in [`ColumnView`][crate::ColumnView].
    ///
    /// The [`ColumnViewCell`][crate::ColumnViewCell]s are managed by the columnview widget (with its factory)
    /// and cannot be created by applications, but they need to be populated
    /// by application code. This is done by calling [`set_child()`][Self::set_child()].
    ///
    /// [`ColumnViewCell`][crate::ColumnViewCell]s exist in 2 stages:
    ///
    /// 1. The unbound stage where the listitem is not currently connected to
    ///    an item in the list. In that case, the [`item`][struct@crate::ColumnViewCell#item]
    ///    property is set to [`None`].
    ///
    /// 2. The bound stage where the listitem references an item from the list.
    ///    The [`item`][struct@crate::ColumnViewCell#item] property is not [`None`].
    ///
    /// ## Properties
    ///
    ///
    /// #### `child`
    ///  Widget used for display.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focusable`
    ///  If the item can be focused with the keyboard.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `item`
    ///  Displayed item.
    ///
    /// Readable
    ///
    ///
    /// #### `position`
    ///  Position of the item.
    ///
    /// Readable
    ///
    ///
    /// #### `selected`
    ///  If the item is currently selected.
    ///
    /// Readable
    /// <details><summary><h4>ListItem</h4></summary>
    ///
    ///
    /// #### `accessible-description`
    ///  The accessible description to set on the list item.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `accessible-label`
    ///  The accessible label to set on the list item.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `activatable`
    ///  If the item can be activated by the user.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `child`
    ///  Widget used for display.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `focusable`
    ///  If the item can be focused with the keyboard.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `item`
    ///  Displayed item.
    ///
    /// Readable
    ///
    ///
    /// #### `position`
    ///  Position of the item.
    ///
    /// Readable
    ///
    ///
    /// #### `selectable`
    ///  If the item can be selected by the user.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `selected`
    ///  If the item is currently selected.
    ///
    /// Readable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ListItemExt`][trait@crate::prelude::ListItemExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkColumnViewCell")]
    pub struct ColumnViewCell(Object<ffi::GtkColumnViewCell, ffi::GtkColumnViewCellClass>) @extends ListItem;

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

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

    /// Gets the child previously set via gtk_column_view_cell_set_child() or
    /// [`None`] if none was set.
    ///
    /// # Returns
    ///
    /// The child
    #[doc(alias = "gtk_column_view_cell_get_child")]
    #[doc(alias = "get_child")]
    pub fn child(&self) -> Option<Widget> {
        unsafe { from_glib_none(ffi::gtk_column_view_cell_get_child(self.to_glib_none().0)) }
    }

    /// Checks if a list item has been set to be focusable via
    /// gtk_column_view_cell_set_focusable().
    ///
    /// # Returns
    ///
    /// [`true`] if the item is focusable
    #[cfg(not(feature = "v4_12"))]
    #[cfg_attr(docsrs, doc(cfg(not(feature = "v4_12"))))]
    #[doc(alias = "gtk_column_view_cell_get_focusable")]
    #[doc(alias = "get_focusable")]
    #[doc(alias = "focusable")]
    pub fn is_focusable(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_column_view_cell_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_cell_get_item")]
    #[doc(alias = "get_item")]
    pub fn item(&self) -> Option<glib::Object> {
        unsafe { from_glib_none(ffi::gtk_column_view_cell_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 item
    #[doc(alias = "gtk_column_view_cell_get_position")]
    #[doc(alias = "get_position")]
    pub fn position(&self) -> u32 {
        unsafe { ffi::gtk_column_view_cell_get_position(self.to_glib_none().0) }
    }

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

    /// Sets the child to be used for this listitem.
    ///
    /// This function is typically called by applications when
    /// setting up a listitem so that the widget can be reused when
    /// binding it multiple times.
    /// ## `child`
    /// The list item's child or [`None`] to unset
    #[doc(alias = "gtk_column_view_cell_set_child")]
    #[doc(alias = "child")]
    pub fn set_child(&self, child: Option<&impl IsA<Widget>>) {
        unsafe {
            ffi::gtk_column_view_cell_set_child(
                self.to_glib_none().0,
                child.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets @self to be focusable.
    ///
    /// If an item is focusable, it can be focused using the keyboard.
    /// This works similar to [`WidgetExt::set_focusable()`][crate::prelude::WidgetExt::set_focusable()].
    ///
    /// Note that if items are not focusable, the keyboard cannot be used to activate
    /// them and selecting only works if one of the listitem's children is focusable.
    ///
    /// By default, list items are focusable.
    /// ## `focusable`
    /// if the item should be focusable
    #[cfg(not(feature = "v4_12"))]
    #[cfg_attr(docsrs, doc(cfg(not(feature = "v4_12"))))]
    #[doc(alias = "gtk_column_view_cell_set_focusable")]
    #[doc(alias = "focusable")]
    pub fn set_focusable(&self, focusable: bool) {
        unsafe {
            ffi::gtk_column_view_cell_set_focusable(self.to_glib_none().0, focusable.into_glib());
        }
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ColumnViewCell`] 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 ColumnViewCellBuilder {
    builder: glib::object::ObjectBuilder<'static, ColumnViewCell>,
}

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

    /// Widget used for display.
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    pub fn child(self, child: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("child", child.clone().upcast()),
        }
    }

    /// If the item 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),
        }
    }

    /// The accessible description to set on the list item.
    #[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 list item.
    #[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 item can be activated by the user.
    pub fn activatable(self, activatable: bool) -> Self {
        Self {
            builder: self.builder.property("activatable", activatable),
        }
    }

    /// If the item can be selected by the user.
    pub fn selectable(self, selectable: bool) -> Self {
        Self {
            builder: self.builder.property("selectable", selectable),
        }
    }

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