gtk4/auto/

builder_list_item_factory.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, BuilderScope, ListItemFactory};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`BuilderListItemFactory`][crate::BuilderListItemFactory] is a [`ListItemFactory`][crate::ListItemFactory] that creates
    /// widgets by instantiating [`Builder`][crate::Builder] UI templates.
    ///
    /// The templates must extend the class that the parent widget expects.
    /// For example, a factory provided to [`factory`][struct@crate::ListView#factory] must have
    /// a template that extends [`ListItem`][crate::ListItem].
    ///
    /// Templates typically use [`Expression`][crate::Expression]s to obtain data from the items
    /// in the model.
    ///
    /// Example:
    /// ```xml
    ///   <interface>
    ///     <template class="GtkListItem">
    ///       <property name="child">
    ///         <object class="GtkLabel">
    ///           <property name="xalign">0</property>
    ///           <binding name="label">
    ///             <lookup name="name" type="SettingsKey">
    ///               <lookup name="item">GtkListItem</lookup>
    ///             </lookup>
    ///           </binding>
    ///         </object>
    ///       </property>
    ///     </template>
    ///   </interface>
    /// ```
    ///
    /// ## Properties
    ///
    ///
    /// #### `bytes`
    ///  `GBytes` containing the UI definition.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `resource`
    ///  Path of the resource containing the UI definition.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `scope`
    ///  [`BuilderScope`][crate::BuilderScope] to use when instantiating listitems
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`ListItemFactoryExt`][trait@crate::prelude::ListItemFactoryExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkBuilderListItemFactory")]
    pub struct BuilderListItemFactory(Object<ffi::GtkBuilderListItemFactory, ffi::GtkBuilderListItemFactoryClass>) @extends ListItemFactory;

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

impl BuilderListItemFactory {
    /// Creates a new [`BuilderListItemFactory`][crate::BuilderListItemFactory] that instantiates widgets
    /// using @bytes as the data to pass to [`Builder`][crate::Builder].
    /// ## `scope`
    /// A scope to use when instantiating
    /// ## `bytes`
    /// the `GBytes` containing the ui file to instantiate
    ///
    /// # Returns
    ///
    /// a new [`BuilderListItemFactory`][crate::BuilderListItemFactory]
    #[doc(alias = "gtk_builder_list_item_factory_new_from_bytes")]
    #[doc(alias = "new_from_bytes")]
    pub fn from_bytes(
        scope: Option<&impl IsA<BuilderScope>>,
        bytes: &glib::Bytes,
    ) -> BuilderListItemFactory {
        assert_initialized_main_thread!();
        unsafe {
            ListItemFactory::from_glib_full(ffi::gtk_builder_list_item_factory_new_from_bytes(
                scope.map(|p| p.as_ref()).to_glib_none().0,
                bytes.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Creates a new [`BuilderListItemFactory`][crate::BuilderListItemFactory] that instantiates widgets
    /// using data read from the given @resource_path to pass to [`Builder`][crate::Builder].
    /// ## `scope`
    /// A scope to use when instantiating
    /// ## `resource_path`
    /// valid path to a resource that contains the data
    ///
    /// # Returns
    ///
    /// a new [`BuilderListItemFactory`][crate::BuilderListItemFactory]
    #[doc(alias = "gtk_builder_list_item_factory_new_from_resource")]
    #[doc(alias = "new_from_resource")]
    pub fn from_resource(
        scope: Option<&impl IsA<BuilderScope>>,
        resource_path: &str,
    ) -> BuilderListItemFactory {
        assert_initialized_main_thread!();
        unsafe {
            ListItemFactory::from_glib_full(ffi::gtk_builder_list_item_factory_new_from_resource(
                scope.map(|p| p.as_ref()).to_glib_none().0,
                resource_path.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Gets the data used as the [`Builder`][crate::Builder] UI template for constructing
    /// listitems.
    ///
    /// # Returns
    ///
    /// The [`Builder`][crate::Builder] data
    #[doc(alias = "gtk_builder_list_item_factory_get_bytes")]
    #[doc(alias = "get_bytes")]
    pub fn bytes(&self) -> glib::Bytes {
        unsafe {
            from_glib_none(ffi::gtk_builder_list_item_factory_get_bytes(
                self.to_glib_none().0,
            ))
        }
    }

    /// If the data references a resource, gets the path of that resource.
    ///
    /// # Returns
    ///
    /// The path to the resource
    #[doc(alias = "gtk_builder_list_item_factory_get_resource")]
    #[doc(alias = "get_resource")]
    pub fn resource(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gtk_builder_list_item_factory_get_resource(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the scope used when constructing listitems.
    ///
    /// # Returns
    ///
    /// The scope used when constructing listitems
    #[doc(alias = "gtk_builder_list_item_factory_get_scope")]
    #[doc(alias = "get_scope")]
    pub fn scope(&self) -> Option<BuilderScope> {
        unsafe {
            from_glib_none(ffi::gtk_builder_list_item_factory_get_scope(
                self.to_glib_none().0,
            ))
        }
    }
}