Class SignalListItemFactory

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ListItemFactory

org.gnome.gtk.SignalListItemFactory

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class SignalListItemFactory
extends ListItemFactory

Emits signals to manage listitems.

Signals are emitted for every listitem in the same order:

1. Gtk.SignalListItemFactory::setup is emitted to set up permanent things on the listitem. This usually means constructing the widgets used in the row and adding them to the listitem.

2. Gtk.SignalListItemFactory::bind is emitted to bind the item passed via Gtk.ListItem:item to the widgets that have been created in step 1 or to add item-specific widgets. Signals are connected to listen to changes - both to changes in the item to update the widgets or to changes in the widgets to update the item. After this signal has been called, the listitem may be shown in a list widget.

3. Gtk.SignalListItemFactory::unbind is emitted to undo everything done in step 2. Usually this means disconnecting signal handlers. Once this signal has been called, the listitem will no longer be used in a list widget.

4. Gtk.SignalListItemFactory::bind and Gtk.SignalListItemFactory::unbind may be emitted multiple times again to bind the listitem for use with new items. By reusing listitems, potentially costly setup can be avoided. However, it means code needs to make sure to properly clean up the listitem in step 3 so that no information from the previous use leaks into the next one.

5. Gtk.SignalListItemFactory::teardown is emitted to allow undoing the effects of Gtk.SignalListItemFactory::setup. After this signal was emitted on a listitem, the listitem will be destroyed and not be used again.

Note that during the signal emissions, changing properties on the listitems passed will not trigger notify signals as the listitem's notifications are frozen. See GObject#freezeNotify for details.

For tracking changes in other properties in the listitem, the ::notify signal is recommended. The signal can be connected in the Gtk.SignalListItemFactory::setup signal and removed again during Gtk.SignalListItemFactory::teardown.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignalListItemFactory.BindCallback	Functional interface declaration of the BindCallback callback.
static class	SignalListItemFactory.Builder<B extends SignalListItemFactory.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	SignalListItemFactory.SetupCallback	Functional interface declaration of the SetupCallback callback.
static class	SignalListItemFactory.SignalListItemFactoryClass
static interface	SignalListItemFactory.TeardownCallback	Functional interface declaration of the TeardownCallback callback.
static interface	SignalListItemFactory.UnbindCallback	Functional interface declaration of the UnbindCallback callback.

Nested classes/interfaces inherited from class ListItemFactory

ListItemFactory.ListItemFactoryClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
SignalListItemFactory()	Create a new SignalListItemFactory.
SignalListItemFactory(MemorySegment address)	Create a SignalListItemFactory instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected SignalListItemFactory	asParent()	Return this instance as if it were its parent type.
static SignalListItemFactory.Builder<? extends SignalListItemFactory.Builder>	builder()	A SignalListItemFactory.Builder object constructs a SignalListItemFactory with the specified properties.
void	emitBind(@Nullable GObject object)	Emits the "bind" signal.
void	emitSetup(@Nullable GObject object)	Emits the "setup" signal.
void	emitTeardown(@Nullable GObject object)	Emits the "teardown" signal.
void	emitUnbind(@Nullable GObject object)	Emits the "unbind" signal.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the SignalListItemFactory class.
SignalConnection<SignalListItemFactory.BindCallback>	onBind(SignalListItemFactory.BindCallback handler)	Emitted when an object has been bound to an item.
SignalConnection<SignalListItemFactory.SetupCallback>	onSetup(SignalListItemFactory.SetupCallback handler)	Emitted when a newly created listitem needs to be prepared for use.
SignalConnection<SignalListItemFactory.TeardownCallback>	onTeardown(SignalListItemFactory.TeardownCallback handler)	Emitted when an object is about to be destroyed.
SignalConnection<SignalListItemFactory.UnbindCallback>	onUnbind(SignalListItemFactory.UnbindCallback handler)	Emitted when an object has been unbound from its item.

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

SignalListItemFactory

public SignalListItemFactory(MemorySegment address)

Create a SignalListItemFactory instance for the provided memory address.

Parameters:

address - the memory address of the native object

SignalListItemFactory

public SignalListItemFactory()

Create a new SignalListItemFactory.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SignalListItemFactory class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected SignalListItemFactory asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class ListItemFactory

Returns:

the instance as if it were its parent type

onBind

public SignalConnection<SignalListItemFactory.BindCallback> onBind(SignalListItemFactory.BindCallback handler)

Emitted when an object has been bound to an item.

The handler for this signal must set to populate the listitem with widgets.

After this signal was emitted, the object might be shown in a ListView or other widget.

The Gtk.SignalListItemFactory::unbind signal is the opposite of this signal and can be used to undo everything done in this signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SignalListItemFactory.BindCallback.run(GObject)

emitBind

public void emitBind(@Nullable GObject object)

Emits the "bind" signal. See onBind(SignalListItemFactory.BindCallback).

onSetup

public SignalConnection<SignalListItemFactory.SetupCallback> onSetup(SignalListItemFactory.SetupCallback handler)

Emitted when a newly created listitem needs to be prepared for use.

It is the first signal emitted for every listitem.

The handler for this signal must call ListItem.setChild(Widget) to populate the listitem with widgets.

The Gtk.SignalListItemFactory::teardown signal is the opposite of this signal and can be used to undo everything done in this signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SignalListItemFactory.SetupCallback.run(GObject)

emitSetup

public void emitSetup(@Nullable GObject object)

Emits the "setup" signal. See onSetup(SignalListItemFactory.SetupCallback).

onTeardown

public SignalConnection<SignalListItemFactory.TeardownCallback> onTeardown(SignalListItemFactory.TeardownCallback handler)

Emitted when an object is about to be destroyed.

It is the last signal ever emitted for this object.

This signal is the opposite of the Gtk.SignalListItemFactory::setup signal and should be used to undo everything done in that signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SignalListItemFactory.TeardownCallback.run(GObject)

emitTeardown

public void emitTeardown(@Nullable GObject object)

Emits the "teardown" signal. See onTeardown(SignalListItemFactory.TeardownCallback).

onUnbind

public SignalConnection<SignalListItemFactory.UnbindCallback> onUnbind(SignalListItemFactory.UnbindCallback handler)

Emitted when an object has been unbound from its item.

This happens for example when a listitem was removed from use in a list widget and its Gtk.ListItem:item is about to be unset.

This signal is the opposite of the Gtk.SignalListItemFactory::bind signal and should be used to undo everything done in that signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SignalListItemFactory.UnbindCallback.run(GObject)

emitUnbind

public void emitUnbind(@Nullable GObject object)

Emits the "unbind" signal. See onUnbind(SignalListItemFactory.UnbindCallback).

builder

public static SignalListItemFactory.Builder<? extends SignalListItemFactory.Builder> builder()

A SignalListItemFactory.Builder object constructs a SignalListItemFactory with the specified properties. Use the various set...() methods to set properties, and finish construction with SignalListItemFactory.Builder.build().

Returns:

the builder object