gi-gtk4-4.0.12: Gtk 4.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.ListItemFactory

Contents

- Exported types
- Methods

Description

Creates widgets for the items taken from a `GListModel`.

This is one of the core concepts of handling list widgets such as `ListView` or `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 `ListItem` documentation for further details.

Various implementations of `GtkListItemFactory` exist to allow you different ways to provide those widgets. The most common implementations are `BuilderListItemFactory` which takes a `GtkBuilder` .ui file and then creates widgets and manages everything automatically from the information in that file and `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 `listViewSetFactory`. Reusing factories across different views is allowed, but very uncommon.

Synopsis

- newtype ListItemFactory = ListItemFactory (ManagedPtr ListItemFactory)
- class (GObject o, IsDescendantOf ListItemFactory o) => IsListItemFactory o
- toListItemFactory :: (MonadIO m, IsListItemFactory o) => o -> m ListItemFactory

# Exported types

newtype ListItemFactory Source #

Memory-managed wrapper type.

Constructors

ListItemFactory (ManagedPtr ListItemFactory) |

#### Instances

Instances details

Eq ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory Methods (==) :: ListItemFactory -> ListItemFactory -> Bool Source # (/=) :: ListItemFactory -> ListItemFactory -> Bool Source #
GObject ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory
ManagedPtrNewtype ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory Methods toManagedPtr :: ListItemFactory -> ManagedPtr ListItemFactory Source #
TypedObject ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory Methods glibType :: IO GType Source #
HasParentTypes ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory
IsGValue (Maybe ListItemFactory) Source # | Convert `ListItemFactory` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ListItemFactory Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe ListItemFactory -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe ListItemFactory) Source #
type ParentTypes ListItemFactory Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory type ParentTypes ListItemFactory = '[Object]

class (GObject o, IsDescendantOf ListItemFactory o) => IsListItemFactory o Source #

Type class for types which can be safely cast to `ListItemFactory`, for instance with `toListItemFactory`.

#### Instances

Instances details

(GObject o, IsDescendantOf ListItemFactory o) => IsListItemFactory o Source # |
Instance details Defined in GI.Gtk.Objects.ListItemFactory

toListItemFactory :: (MonadIO m, IsListItemFactory o) => o -> m ListItemFactory Source #

Cast to `ListItemFactory`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

#### Getters

getData, getProperty, getQdata.

#### Setters

setData, setDataFull, setProperty.