1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
// 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
glib::wrapper! {
/// A [`ListItemFactory`][crate::ListItemFactory] creates widgets for the items taken from a `GListModel`.
///
/// This is one of the core concepts of handling list widgets such
/// as [`ListView`][crate::ListView] or [`GridView`][crate::GridView].
///
/// The [`ListItemFactory`][crate::ListItemFactory] is tasked with creating widgets for items
/// taken from the model when the views need them and updating them as
/// the items displayed by the view change.
///
/// A view is usually only able to display anything after both a factory
/// and a model have been set on the view. So it is important that you do
/// not skip this step when setting up your first view.
///
/// Because views do not display the whole list at once but only a few
/// items, they only need to maintain a few widgets at a time. They will
/// instruct the [`ListItemFactory`][crate::ListItemFactory] to create these widgets and bind them
/// to the items that are currently displayed.
///
/// As the list model changes or the user scrolls to the list, the items will
/// change and the view will instruct the factory to bind the widgets to those
/// new items.
///
/// The actual widgets used for displaying those widgets is provided by you.
///
/// When the factory needs widgets created, it will create a [`ListItem`][crate::ListItem]
/// and hand it to your code to set up a widget for. This list item will provide
/// various properties with information about what item to display and provide
/// you with some opportunities to configure its behavior. See the
/// [`ListItem`][crate::ListItem] documentation for further details.
///
/// Various implementations of [`ListItemFactory`][crate::ListItemFactory] exist to allow you different
/// ways to provide those widgets. The most common implementations are
/// [`BuilderListItemFactory`][crate::BuilderListItemFactory] which takes a [`Builder`][crate::Builder] .ui file
/// and then creates widgets and manages everything automatically from the
/// information in that file and [`SignalListItemFactory`][crate::SignalListItemFactory] which allows
/// you to connect to signals with your own code and retain full control over
/// how the widgets are setup and managed.
///
/// A [`ListItemFactory`][crate::ListItemFactory] is supposed to be final - that means its behavior should
/// not change and the first widget created from it should behave the same way as
/// the last widget created from it.
/// If you intend to do changes to the behavior, it is recommended that you create
/// a new [`ListItemFactory`][crate::ListItemFactory] which will allow the views to recreate its widgets.
///
/// Once you have chosen your factory and created it, you need to set it
/// on the view widget you want to use it with, such as via
/// [`ListView::set_factory()`][crate::ListView::set_factory()]. Reusing factories across different
/// views is allowed, but very uncommon.
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkListItemFactory")]
pub struct ListItemFactory(Object<ffi::GtkListItemFactory, ffi::GtkListItemFactoryClass>);
match fn {
type_ => || ffi::gtk_list_item_factory_get_type(),
}
}
impl ListItemFactory {
pub const NONE: Option<&'static ListItemFactory> = None;
}