gtk4/auto/

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

glib::wrapper! {
    /// [`ListItem`][crate::ListItem] is used by list widgets to represent items in a
    /// [`gio::ListModel`][crate::gio::ListModel].
    ///
    /// [`ListItem`][crate::ListItem] objects are managed by the list widget (with its factory)
    /// and cannot be created by applications, but they need to be populated
    /// by application code. This is done by calling [`ListItemExt::set_child()`][crate::prelude::ListItemExt::set_child()].
    ///
    /// [`ListItem`][crate::ListItem] objects 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::ListItem#item]
    ///    property is set to [`None`].
    ///
    /// 2. The bound stage where the listitem references an item from the list.
    ///    The [`item`][struct@crate::ListItem#item] property is not [`None`].
    ///
    /// ## Properties
    ///
    ///
    /// #### `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
    ///
    /// # Implements
    ///
    /// [`ListItemExt`][trait@crate::prelude::ListItemExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkListItem")]
    pub struct ListItem(Object<ffi::GtkListItem, ffi::GtkListItemClass>);

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

impl ListItem {
    pub const NONE: Option<&'static ListItem> = None;
}

/// Trait containing all [`struct@ListItem`] methods.
///
/// # Implementors
///
/// [`ColumnViewCell`][struct@crate::ColumnViewCell], [`ListItem`][struct@crate::ListItem]
pub trait ListItemExt: IsA<ListItem> + 'static {
    /// Gets the accessible description of @self.
    ///
    /// # Returns
    ///
    /// the accessible description
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_list_item_get_accessible_description")]
    #[doc(alias = "get_accessible_description")]
    #[doc(alias = "accessible-description")]
    fn accessible_description(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gtk_list_item_get_accessible_description(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

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

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

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

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

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

    /// Checks if the item is displayed as selected.
    ///
    /// 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_list_item_get_selected")]
    #[doc(alias = "get_selected")]
    #[doc(alias = "selected")]
    fn is_selected(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_list_item_get_selected(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the accessible description for the list item,
    /// which may be used by e.g. screen readers.
    /// ## `description`
    /// the description
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_list_item_set_accessible_description")]
    #[doc(alias = "accessible-description")]
    fn set_accessible_description(&self, description: &str) {
        unsafe {
            ffi::gtk_list_item_set_accessible_description(
                self.as_ref().to_glib_none().0,
                description.to_glib_none().0,
            );
        }
    }

    /// Sets the accessible label for the list item,
    /// which may be used by e.g. screen readers.
    /// ## `label`
    /// the label
    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_list_item_set_accessible_label")]
    #[doc(alias = "accessible-label")]
    fn set_accessible_label(&self, label: &str) {
        unsafe {
            ffi::gtk_list_item_set_accessible_label(
                self.as_ref().to_glib_none().0,
                label.to_glib_none().0,
            );
        }
    }

    /// Sets @self to be activatable.
    ///
    /// If an item is activatable, double-clicking on the item, using
    /// the Return key or calling gtk_widget_activate() will activate
    /// the item. Activating instructs the containing view to handle
    /// activation. [`ListView`][crate::ListView] for example will be emitting the
    /// [`activate`][struct@crate::ListView#activate] signal.
    ///
    /// By default, list items are activatable.
    /// ## `activatable`
    /// if the item should be activatable
    #[doc(alias = "gtk_list_item_set_activatable")]
    #[doc(alias = "activatable")]
    fn set_activatable(&self, activatable: bool) {
        unsafe {
            ffi::gtk_list_item_set_activatable(
                self.as_ref().to_glib_none().0,
                activatable.into_glib(),
            );
        }
    }

    /// 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_list_item_set_child")]
    #[doc(alias = "child")]
    fn set_child(&self, child: Option<&impl IsA<Widget>>) {
        unsafe {
            ffi::gtk_list_item_set_child(
                self.as_ref().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(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "gtk_list_item_set_focusable")]
    #[doc(alias = "focusable")]
    fn set_focusable(&self, focusable: bool) {
        unsafe {
            ffi::gtk_list_item_set_focusable(self.as_ref().to_glib_none().0, focusable.into_glib());
        }
    }

    /// Sets @self to be selectable.
    ///
    /// If an item is selectable, clicking on the item or using the keyboard
    /// will try to select or unselect the item. If this succeeds is up to
    /// the model to determine, as it is managing the selected state.
    ///
    /// Note that this means that making an item non-selectable has no
    /// influence on the selected state at all. A non-selectable item
    /// may still be selected.
    ///
    /// By default, list items are selectable. When rebinding them to
    /// a new item, they will also be reset to be selectable by GTK.
    /// ## `selectable`
    /// if the item should be selectable
    #[doc(alias = "gtk_list_item_set_selectable")]
    #[doc(alias = "selectable")]
    fn set_selectable(&self, selectable: bool) {
        unsafe {
            ffi::gtk_list_item_set_selectable(
                self.as_ref().to_glib_none().0,
                selectable.into_glib(),
            );
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "accessible-description")]
    fn connect_accessible_description_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_accessible_description_trampoline<
            P: IsA<ListItem>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::accessible-description".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accessible_description_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "accessible-label")]
    fn connect_accessible_label_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_accessible_label_trampoline<
            P: IsA<ListItem>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::accessible-label".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_accessible_label_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "activatable")]
    fn connect_activatable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_activatable_trampoline<
            P: IsA<ListItem>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::activatable".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_activatable_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "child")]
    fn connect_child_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_child_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::child".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_child_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[cfg(feature = "v4_12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
    #[doc(alias = "focusable")]
    fn connect_focusable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_focusable_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::focusable".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_focusable_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "item")]
    fn connect_item_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_item_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::item".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_item_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "position")]
    fn connect_position_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_position_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::position".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_position_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "selectable")]
    fn connect_selectable_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_selectable_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::selectable".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_selectable_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "selected")]
    fn connect_selected_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_selected_trampoline<P: IsA<ListItem>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkListItem,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(ListItem::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::selected".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_selected_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<ListItem>> ListItemExt for O {}