ListItemFactoryRef
public struct ListItemFactoryRef : ListItemFactoryProtocol, GWeakCapturing
A GtkListItemFactory
creates widgets for the items taken from a GListModel
.
This is one of the core concepts of handling list widgets such
as [classGtk.ListView
] or [classGtk.GridView
].
The GtkListItemFactory
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 GtkListItemFactory
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 GtkListItem
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
[classGtk.ListItem
] documentation for further details.
Various implementations of GtkListItemFactory
exist to allow you different
ways to provide those widgets. The most common implementations are
[classGtk.BuilderListItemFactory
] which takes a GtkBuilder
.ui file
and then creates widgets and manages everything automatically from the
information in that file and [classGtk.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 GtkListItemFactory
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 GtkListItemFactory
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
[methodGtk.ListView.set_factory
]. Reusing factories across different
views is allowed, but very uncommon.
The ListItemFactoryRef
type acts as a lightweight Swift reference to an underlying GtkListItemFactory
instance.
It exposes methods that can operate on this data type through ListItemFactoryProtocol
conformance.
Use ListItemFactoryRef
only as an unowned
reference to an existing GtkListItemFactory
instance.
-
Untyped pointer to the underlying `GtkListItemFactory` instance.
For type-safe access, use the generated, typed pointer
list_item_factory_ptr
property instead.Declaration
Swift
public let ptr: UnsafeMutableRawPointer!
-
Designated initialiser from the underlying
C
data typeDeclaration
Swift
@inlinable init(_ p: UnsafeMutablePointer<GtkListItemFactory>)
-
Designated initialiser from a constant pointer to the underlying
C
data typeDeclaration
Swift
@inlinable init(_ p: UnsafePointer<GtkListItemFactory>)
-
Conditional initialiser from an optional pointer to the underlying
C
data typeDeclaration
Swift
@inlinable init!(_ maybePointer: UnsafeMutablePointer<GtkListItemFactory>?)
-
Conditional initialiser from an optional, non-mutable pointer to the underlying
C
data typeDeclaration
Swift
@inlinable init!(_ maybePointer: UnsafePointer<GtkListItemFactory>?)
-
Conditional initialiser from an optional
gpointer
Declaration
Swift
@inlinable init!(gpointer g: gpointer?)
-
Conditional initialiser from an optional, non-mutable
gconstpointer
Declaration
Swift
@inlinable init!(gconstpointer g: gconstpointer?)
-
Reference intialiser for a related type that implements
ListItemFactoryProtocol
Declaration
Swift
@inlinable init<T>(_ other: T) where T : ListItemFactoryProtocol
-
This factory is syntactic sugar for setting weak pointers wrapped in
GWeak<T>
Declaration
Swift
@inlinable static func unowned<T>(_ other: T) -> ListItemFactoryRef where T : ListItemFactoryProtocol
-
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
ListItemFactoryProtocol
.Declaration
Swift
@inlinable init<T>(cPointer: UnsafeMutablePointer<T>)
-
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
ListItemFactoryProtocol
.Declaration
Swift
@inlinable init<T>(constPointer: UnsafePointer<T>)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
ListItemFactoryProtocol
.Declaration
Swift
@inlinable init(mutating raw: UnsafeRawPointer)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
ListItemFactoryProtocol
.Declaration
Swift
@inlinable init(raw: UnsafeMutableRawPointer)
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
ListItemFactoryProtocol
.Declaration
Swift
@inlinable init(opaquePointer: OpaquePointer)