Package org.gnome.gtk

Class ListBoxRow

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.ListBoxRow

All Implemented Interfaces:

Accessible, Actionable, Buildable, ConstraintTarget, Proxy

Direct Known Subclasses:

PreferencesRow

@Generated("io.github.jwharm.JavaGI")
public class ListBoxRow
extends Widget
implements Accessible, Actionable, Buildable, ConstraintTarget

The kind of widget that can be added to a GtkListBox.

ListBox will automatically wrap its children in a GtkListboxRow when necessary.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBoxRow.ActivateCallback	Functional interface declaration of the ActivateCallback callback.
static class	ListBoxRow.Builder<B extends ListBoxRow.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ListBoxRow.ListBoxRowClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Actionable

Actionable.Actionable$Impl, Actionable.ActionableInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
ListBoxRow()	Creates a new ListBoxRow.
ListBoxRow(MemorySegment address)	Create a ListBoxRow proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected void	activate()
protected ListBoxRow	asParent()	Returns this instance as if it were its parent type.
static ListBoxRow.Builder<? extends ListBoxRow.Builder>	builder()	A ListBoxRow.Builder object constructs a ListBoxRow with the specified properties.
void	changed()	Marks this ListBoxRow as changed, causing any state that depends on this to be updated.
void	emitActivate()	Emits the "activate" signal.
boolean	getActivatable()	Gets whether the row is activatable.
@Nullable Widget	getChild()	Gets the child widget of row.
@Nullable Widget	getHeader()	Returns the current header of the row.
int	getIndex()	Gets the current index of the this ListBoxRow in its GtkListBox container.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getSelectable()	Gets whether the row can be selected.
static @Nullable Type	getType()	Get the GType of the ListBoxRow class
boolean	isSelected()	Returns whether the child is currently selected in its GtkListBox container.
SignalConnection<ListBoxRow.ActivateCallback>	onActivate(ListBoxRow.ActivateCallback handler)	This is a keybinding signal, which will cause this row to be activated.
void	setActivatable(boolean activatable)	Set whether the row is activatable.
void	setChild(@Nullable Widget child)	Sets the child widget of self.
void	setHeader(@Nullable Widget header)	Sets the current header of the row.
void	setSelectable(boolean selectable)	Set whether the row can be selected.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.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 org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Actionable

getActionName, getActionTargetValue, setActionName, setActionTarget, setActionTargetValue, setDetailedActionName

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ListBoxRow

public ListBoxRow(MemorySegment address)

Create a ListBoxRow proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ListBoxRow

public ListBoxRow()

Creates a new ListBoxRow.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ListBoxRow class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ListBoxRow asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Widget

changed

public void changed()

Marks this ListBoxRow as changed, causing any state that depends on this to be updated.

This affects sorting, filtering and headers.

Note that calls to this method must be in sync with the data used for the row functions. For instance, if the list is mirroring some external data set, and two rows changed in the external data set then when you call gtk_list_box_row_changed() on the first row the sort function must only read the new data for the first of the two changed rows, otherwise the resorting of the rows will be wrong.

This generally means that if you don’t fully control the data model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call ListBox.invalidateSort() on any model change, but that is more expensive.

getActivatable

public boolean getActivatable()

Gets whether the row is activatable.

Returns:

true if the row is activatable

getChild

public @Nullable Widget getChild()

Gets the child widget of row.

Returns:

the child widget of this ListBoxRow

getHeader

public @Nullable Widget getHeader()

Returns the current header of the row.

This can be used in a Gtk.ListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it.

Returns:

the current header

getIndex

public int getIndex()

Gets the current index of the this ListBoxRow in its GtkListBox container.

Returns:

the index of the row, or -1 if the this ListBoxRow is not in a listbox

getSelectable

public boolean getSelectable()

Gets whether the row can be selected.

Returns:

true if the row is selectable

isSelected

public boolean isSelected()

Returns whether the child is currently selected in its GtkListBox container.

Returns:

true if this ListBoxRow is selected

setActivatable

public void setActivatable(boolean activatable)

Set whether the row is activatable.

Parameters:

activatable - true to mark the row as activatable

setChild

public void setChild(@Nullable Widget child)

Sets the child widget of self.

Parameters:

child - the child widget

setHeader

public void setHeader(@Nullable Widget header)

Sets the current header of the row.

This is only allowed to be called from a Gtk.ListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox.

Parameters:

header - the header

setSelectable

public void setSelectable(boolean selectable)

Set whether the row can be selected.

Parameters:

selectable - true to mark the row as selectable

activate

protected void activate()

onActivate

public SignalConnection<ListBoxRow.ActivateCallback> onActivate(ListBoxRow.ActivateCallback handler)

This is a keybinding signal, which will cause this row to be activated.

If you want to be notified when the user activates a row (by key or not), use the Gtk.ListBox::row-activated signal on the row’s parent GtkListBox.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBoxRow.ActivateCallback.run()

emitActivate

public void emitActivate()

Emits the "activate" signal. See onActivate(org.gnome.gtk.ListBoxRow.ActivateCallback).

builder

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

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

Returns:

the builder object