Package ch.bailu.gtk.gtk

Class MapListModel

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gtk.MapListModel

All Implemented Interfaces:

PointerInterface

public class MapListModel
extends Object

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

`GtkMapListModel` uses a [callback@Gtk.MapListModelMapFunc].

Example: Create a list of `GtkEventControllers`
```c
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 (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.

https://docs.gtk.org/gtk4/class.MapListModel.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MapListModel.OnDestroyNotify
static interface	MapListModel.OnMapListModelMapFunc

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
MapListModel(ListModel model, MapListModel.OnMapListModelMapFunc map_func, Pointer user_data, MapListModel.OnDestroyNotify user_destroy)	Creates a new `GtkMapListModel` for the given arguments.
MapListModel(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
ListModel	asListModel()	Implements interface ListModel.
static ClassHandler	getClassHandler()
static int	getInstanceSize()
ListModel	getModel()	Gets the model that is currently being mapped or %NULL if none.
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
boolean	hasMap()	Checks if a map function is currently set on @self.
void	setMapFunc(MapListModel.OnMapListModelMapFunc map_func, Pointer user_data, MapListModel.OnDestroyNotify user_destroy)	Sets the function used to map items.
void	setModel(ListModel model)	Sets the model to be mapped.

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Constructor Details

MapListModel

public MapListModel(PointerContainer pointer)

MapListModel

public MapListModel(@Nullable
 ListModel model,
 MapListModel.OnMapListModelMapFunc map_func,
 @Nullable
 Pointer user_data,
 MapListModel.OnDestroyNotify user_destroy)

Creates a new `GtkMapListModel` for the given arguments.

Parameters:

model - The model to map

map_func - map function

user_data - user data passed to @map_func

user_destroy - destroy notifier for @user_data

Method Details

getClassHandler

public static ClassHandler getClassHandler()

getModel

public ListModel getModel()

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

Returns:

The model that gets mapped

hasMap

public boolean hasMap()

Checks if a map function is currently set on @self.

Returns:

%TRUE if a map function is set

setMapFunc

public void setMapFunc(MapListModel.OnMapListModelMapFunc map_func,
 @Nullable
 Pointer user_data,
 MapListModel.OnDestroyNotify user_destroy)

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 @map_func 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.

Parameters:

map_func - map function

user_data - user data passed to @map_func

user_destroy - destroy notifier for @user_data

setModel

public void setModel(@Nullable
 ListModel model)

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.

Parameters:

model - The model to be mapped

asListModel

public ListModel asListModel()

Implements interface ListModel. Call this to get access to interface functions.

Returns:

ListModel

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()