gtk4/auto/

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

glib::wrapper! {
    /// [`TreeListModel`][crate::TreeListModel] is a list model that can create child models on demand.
    ///
    /// ## Properties
    ///
    ///
    /// #### `autoexpand`
    ///  If all rows should be expanded by default.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `item-type`
    ///  The type of items. See [`ListModelExtManual::item_type()`][crate::gio::prelude::ListModelExtManual::item_type()].
    ///
    /// Readable
    ///
    ///
    /// #### `model`
    ///  The root model displayed.
    ///
    /// Readable
    ///
    ///
    /// #### `n-items`
    ///  The number of items. See [`ListModelExtManual::n_items()`][crate::gio::prelude::ListModelExtManual::n_items()].
    ///
    /// Readable
    ///
    ///
    /// #### `passthrough`
    ///  Gets whether the model is in passthrough mode.
    ///
    /// If [`false`], the `GListModel` functions for this object return custom
    /// [`TreeListRow`][crate::TreeListRow] objects. If [`true`], the values of the child
    /// models are pass through unmodified.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`]
    #[doc(alias = "GtkTreeListModel")]
    pub struct TreeListModel(Object<ffi::GtkTreeListModel, ffi::GtkTreeListModelClass>) @implements gio::ListModel;

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

impl TreeListModel {
    /// Creates a new empty [`TreeListModel`][crate::TreeListModel] displaying @root
    /// with all rows collapsed.
    /// ## `root`
    /// The `GListModel` to use as root
    /// ## `passthrough`
    /// [`true`] to pass through items from the models
    /// ## `autoexpand`
    /// [`true`] to set the autoexpand property and expand the @root model
    /// ## `create_func`
    /// function to
    ///   call to create the `GListModel` for the children of an item
    ///
    /// # Returns
    ///
    /// a newly created [`TreeListModel`][crate::TreeListModel].
    #[doc(alias = "gtk_tree_list_model_new")]
    pub fn new<P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static>(
        root: impl IsA<gio::ListModel>,
        passthrough: bool,
        autoexpand: bool,
        create_func: P,
    ) -> TreeListModel {
        assert_initialized_main_thread!();
        let create_func_data: Box_<P> = Box_::new(create_func);
        unsafe extern "C" fn create_func_func<
            P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static,
        >(
            item: *mut glib::gobject_ffi::GObject,
            user_data: glib::ffi::gpointer,
        ) -> *mut gio::ffi::GListModel {
            let item = from_glib_borrow(item);
            let callback = &*(user_data as *mut P);
            (*callback)(&item).to_glib_full()
        }
        let create_func = Some(create_func_func::<P> as _);
        unsafe extern "C" fn user_destroy_func<
            P: Fn(&glib::Object) -> Option<gio::ListModel> + 'static,
        >(
            data: glib::ffi::gpointer,
        ) {
            let _callback = Box_::from_raw(data as *mut P);
        }
        let destroy_call5 = Some(user_destroy_func::<P> as _);
        let super_callback0: Box_<P> = create_func_data;
        unsafe {
            from_glib_full(ffi::gtk_tree_list_model_new(
                root.upcast().into_glib_ptr(),
                passthrough.into_glib(),
                autoexpand.into_glib(),
                create_func,
                Box_::into_raw(super_callback0) as *mut _,
                destroy_call5,
            ))
        }
    }

    /// Gets whether the model is set to automatically expand new rows
    /// that get added.
    ///
    /// This can be either rows added by changes to the underlying
    /// models or via [`TreeListRow::set_expanded()`][crate::TreeListRow::set_expanded()].
    ///
    /// # Returns
    ///
    /// [`true`] if the model is set to autoexpand
    #[doc(alias = "gtk_tree_list_model_get_autoexpand")]
    #[doc(alias = "get_autoexpand")]
    #[doc(alias = "autoexpand")]
    pub fn is_autoexpand(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_tree_list_model_get_autoexpand(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the row item corresponding to the child at index @position for
    /// @self's root model.
    ///
    /// If @position is greater than the number of children in the root model,
    /// [`None`] is returned.
    ///
    /// Do not confuse this function with [`row()`][Self::row()].
    /// ## `position`
    /// position of the child to get
    ///
    /// # Returns
    ///
    /// the child in @position
    #[doc(alias = "gtk_tree_list_model_get_child_row")]
    #[doc(alias = "get_child_row")]
    pub fn child_row(&self, position: u32) -> Option<TreeListRow> {
        unsafe {
            from_glib_full(ffi::gtk_tree_list_model_get_child_row(
                self.to_glib_none().0,
                position,
            ))
        }
    }

    /// Gets the root model that @self was created with.
    ///
    /// # Returns
    ///
    /// the root model
    #[doc(alias = "gtk_tree_list_model_get_model")]
    #[doc(alias = "get_model")]
    pub fn model(&self) -> gio::ListModel {
        unsafe { from_glib_none(ffi::gtk_tree_list_model_get_model(self.to_glib_none().0)) }
    }

    /// Gets whether the model is passing through original row items.
    ///
    /// If this function returns [`false`], the `GListModel` functions for @self
    /// return custom [`TreeListRow`][crate::TreeListRow] objects. You need to call
    /// [`TreeListRow::item()`][crate::TreeListRow::item()] on these objects to get the original
    /// item.
    ///
    /// If [`true`], the values of the child models are passed through in their
    /// original state. You then need to call [`row()`][Self::row()]
    /// to get the custom [`TreeListRow`][crate::TreeListRow]s.
    ///
    /// # Returns
    ///
    /// [`true`] if the model is passing through original row items
    #[doc(alias = "gtk_tree_list_model_get_passthrough")]
    #[doc(alias = "get_passthrough")]
    #[doc(alias = "passthrough")]
    pub fn is_passthrough(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_tree_list_model_get_passthrough(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the row object for the given row.
    ///
    /// If @position is greater than the number of items in @self,
    /// [`None`] is returned.
    ///
    /// The row object can be used to expand and collapse rows as
    /// well as to inspect its position in the tree. See its
    /// documentation for details.
    ///
    /// This row object is persistent and will refer to the current
    /// item as long as the row is present in @self, independent of
    /// other rows being added or removed.
    ///
    /// If @self is set to not be passthrough, this function is
    /// equivalent to calling g_list_model_get_item().
    ///
    /// Do not confuse this function with [`child_row()`][Self::child_row()].
    /// ## `position`
    /// the position of the row to fetch
    ///
    /// # Returns
    ///
    /// The row item
    #[doc(alias = "gtk_tree_list_model_get_row")]
    #[doc(alias = "get_row")]
    pub fn row(&self, position: u32) -> Option<TreeListRow> {
        unsafe {
            from_glib_full(ffi::gtk_tree_list_model_get_row(
                self.to_glib_none().0,
                position,
            ))
        }
    }

    /// Sets whether the model should autoexpand.
    ///
    /// If set to [`true`], the model will recursively expand all rows that
    /// get added to the model. This can be either rows added by changes
    /// to the underlying models or via [`TreeListRow::set_expanded()`][crate::TreeListRow::set_expanded()].
    /// ## `autoexpand`
    /// [`true`] to make the model autoexpand its rows
    #[doc(alias = "gtk_tree_list_model_set_autoexpand")]
    #[doc(alias = "autoexpand")]
    pub fn set_autoexpand(&self, autoexpand: bool) {
        unsafe {
            ffi::gtk_tree_list_model_set_autoexpand(self.to_glib_none().0, autoexpand.into_glib());
        }
    }

    #[doc(alias = "autoexpand")]
    pub fn connect_autoexpand_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_autoexpand_trampoline<F: Fn(&TreeListModel) + 'static>(
            this: *mut ffi::GtkTreeListModel,
            _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 _,
                c"notify::autoexpand".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_autoexpand_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "model")]
    pub fn connect_model_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_model_trampoline<F: Fn(&TreeListModel) + 'static>(
            this: *mut ffi::GtkTreeListModel,
            _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 _,
                c"notify::model".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_model_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}