GI.Gtk.Objects.MapListModel

A GtkMapListModel maps the items in a list model to different items.

GtkMapListModel uses a [callbackgtk.MapListModelMapFunc].

Example: Create a list of GtkEventControllers

c code

static gpointer
map_to_controllers (gpointer widget,
                    gpointer data)
{
  gpointer result = gtk_widget_observe_controllers (widget);
  g_object_unref (widget);
  return result;
}

widgets = gtk_widget_observe_children (widget);

controllers = gtk_map_list_model_new (G_TYPE_LIST_MODEL,
                                      widgets,
                                      map_to_controllers,
                                      NULL, NULL);

model = gtk_flatten_list_model_new (GTK_TYPE_EVENT_CONTROLLER,
                                    controllers);

GtkMapListModel will attempt to discard the mapped objects as soon as they are no longer needed and recreate them if necessary.

Exported types

newtype MapListModel

Memory-managed wrapper type.

Constructors

MapListModel (ManagedPtr MapListModel)

Instances

Eq MapListModel

Defined in GI.Gtk.Objects.MapListModel

Methods

(==) :: MapListModel -> MapListModel -> Bool

(/=) :: MapListModel -> MapListModel -> Bool

GObject MapListModel

Defined in GI.Gtk.Objects.MapListModel

ManagedPtrNewtype MapListModel

Defined in GI.Gtk.Objects.MapListModel

Methods

toManagedPtr :: MapListModel -> ManagedPtr MapListModel

TypedObject MapListModel

Defined in GI.Gtk.Objects.MapListModel

Methods

glibType :: IO GType

HasParentTypes MapListModel

Defined in GI.Gtk.Objects.MapListModel

IsGValue (Maybe MapListModel)

Convert MapListModel to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.MapListModel

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe MapListModel -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe MapListModel)

type ParentTypes MapListModel

Defined in GI.Gtk.Objects.MapListModel

type ParentTypes MapListModel = '[Object, ListModel]

class (GObject o, IsDescendantOf MapListModel o) => IsMapListModel o

Type class for types which can be safely cast to MapListModel, for instance with toMapListModel.

Instances

(GObject o, IsDescendantOf MapListModel o) => IsMapListModel o

Defined in GI.Gtk.Objects.MapListModel

toMapListModel :: (MonadIO m, IsMapListModel o) => o -> m MapListModel

Cast to MapListModel, 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

Methods

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

Getters

getData, getItem, getItemType, getModel, getNItems, getProperty, getQdata.

Setters

setData, setDataFull, setMapFunc, setModel, setProperty.

getModel

mapListModelGetModel

Arguments

:: (HasCallStack, MonadIO m, IsMapListModel a)

=> a

self: a GtkMapListModel

-> m (Maybe ListModel)

Returns: The model that gets mapped

Gets the model that is currently being mapped or Nothing if none.

hasMap

mapListModelHasMap

Arguments

:: (HasCallStack, MonadIO m, IsMapListModel a)

=> a

self: a GtkMapListModel

-> m Bool

Returns: True if a map function is set

Checks if a map function is currently set on self.

new

mapListModelNew

Arguments

:: (HasCallStack, MonadIO m, IsListModel a)

=> Maybe a

model: The model to map

-> Maybe MapListModelMapFunc

mapFunc: map function

-> m MapListModel

Returns: a new GtkMapListModel

Creates a new GtkMapListModel for the given arguments.

setMapFunc

mapListModelSetMapFunc

Arguments

:: (HasCallStack, MonadIO m, IsMapListModel a)

=> a

self: a GtkMapListModel

-> Maybe MapListModelMapFunc

mapFunc: map function

-> m ()

Sets the function used to map items.

The function will be called whenever an item needs to be mapped and must return the item to use for the given input item.

Note that GtkMapListModel may call this function multiple times on the same item, because it may delete items it doesn't need anymore.

GTK makes no effort to ensure that mapFunc conforms to the item type of self. It assumes that the caller knows what they are doing and the map function returns items of the appropriate type.

setModel

mapListModelSetModel

Arguments

:: (HasCallStack, MonadIO m, IsMapListModel a, IsListModel b)

=> a

self: a GtkMapListModel

-> Maybe b

model: The model to be mapped

-> m ()

Sets the model to be mapped.

GTK makes no effort to ensure that model conforms to the item type expected by the map function. It assumes that the caller knows what they are doing and have set up an appropriate map function.

Properties

hasMap

If a map is set for this model

getMapListModelHasMap :: (MonadIO m, IsMapListModel o) => o -> m Bool

Get the value of the “has-map” property. When overloading is enabled, this is equivalent to

get mapListModel #hasMap

model

The model being mapped.

constructMapListModelModel :: (IsMapListModel o, MonadIO m, IsListModel a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

getMapListModelModel :: (MonadIO m, IsMapListModel o) => o -> m (Maybe ListModel)

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get mapListModel #model