Package org.gnome.gtk

Class ListBox

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.ListBox

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

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

GtkListBox is a vertical list.

A GtkListBox only contains GtkListBoxRow children. These rows can by dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.

Using GtkListBox is often an alternative to GtkTreeView, especially when the list contents has a more complicated layout than what is allowed by a GtkCellRenderer, or when the contents is interactive (i.e. has a button in it).

Although a GtkListBox must have only GtkListBoxRow children, you can add any kind of widget to it via prepend(org.gnome.gtk.Widget), append(org.gnome.gtk.Widget) and insert(org.gnome.gtk.Widget, int) and a GtkListBoxRow widget will automatically be inserted between the list and the widget.

GtkListBoxRows can be marked as activatable or selectable. If a row is activatable, Gtk.ListBox::row-activated will be emitted for it when the user tries to activate it. If it is selectable, the row will be marked as selected when the user tries to select it.

GtkListBox as GtkBuildable
The GtkListBox implementation of the GtkBuildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See setPlaceholder(org.gnome.gtk.Widget) for info.

Shortcuts and Gestures
The following signals have default keybindings:

• Gtk.ListBox::move-cursor
• Gtk.ListBox::select-all
• Gtk.ListBox::toggle-cursor-row
• Gtk.ListBox::unselect-all

CSS nodes

list[.separators][.rich-list][.navigation-sidebar][.boxed-list]
 ╰── row[.activatable]
 

GtkListBox uses a single CSS node named list. It may carry the .separators style class, when the Gtk.ListBox:show-separators property is set. Each GtkListBoxRow uses a single CSS node named row. The row nodes get the .activatable style class added when appropriate.

It may also carry the .boxed-list style class. In this case, the list will be automatically surrounded by a frame and have separators.

The main list node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.

Accessibility
GtkListBox uses the AccessibleRole.LIST role and GtkListBoxRow uses the AccessibleRole.LIST_ITEM role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListBox.ActivateCursorRowCallback	Functional interface declaration of the ActivateCursorRowCallback callback.
static class	ListBox.Builder<B extends ListBox.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	ListBox.MoveCursorCallback	Functional interface declaration of the MoveCursorCallback callback.
static interface	ListBox.RowActivatedCallback	Functional interface declaration of the RowActivatedCallback callback.
static interface	ListBox.RowSelectedCallback	Functional interface declaration of the RowSelectedCallback callback.
static interface	ListBox.SelectAllCallback	Functional interface declaration of the SelectAllCallback callback.
static interface	ListBox.SelectedRowsChangedCallback	Functional interface declaration of the SelectedRowsChangedCallback callback.
static interface	ListBox.ToggleCursorRowCallback	Functional interface declaration of the ToggleCursorRowCallback callback.
static interface	ListBox.UnselectAllCallback	Functional interface declaration of the UnselectAllCallback callback.

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.WidgetClass, Widget.WidgetImpl

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.AccessibleImpl, Accessible.AccessibleInterface

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

Buildable.BuildableIface, Buildable.BuildableImpl

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

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	append(Widget child)	Append a widget to the list.
protected ListBox	asParent()	Returns this instance as if it were its parent type.
void	bindModel(@Nullable ListModel model, @Nullable ListBoxCreateWidgetFunc createWidgetFunc)	Binds model to this ListBox.
static ListBox.Builder<? extends ListBox.Builder>	builder()	A ListBox.Builder object constructs a ListBox with the specified properties.
void	dragHighlightRow(ListBoxRow row)	Add a drag highlight to a row.
void	dragUnhighlightRow()	If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.
void	emitActivateCursorRow()	Emits the "activate-cursor-row" signal.
void	emitMoveCursor(MovementStep step, int count, boolean extend, boolean modify)	Emits the "move-cursor" signal.
void	emitRowActivated(ListBoxRow row)	Emits the "row-activated" signal.
void	emitRowSelected(@Nullable ListBoxRow row)	Emits the "row-selected" signal.
void	emitSelectAll()	Emits the "select-all" signal.
void	emitSelectedRowsChanged()	Emits the "selected-rows-changed" signal.
void	emitToggleCursorRow()	Emits the "toggle-cursor-row" signal.
void	emitUnselectAll()	Emits the "unselect-all" signal.
boolean	getActivateOnSingleClick()	Returns whether rows activate on single clicks.
Adjustment	getAdjustment()	Gets the adjustment (if any) that the widget uses to for vertical scrolling.
ListBoxRow	getRowAtIndex(int index)	Gets the n-th child in the list (not counting headers).
ListBoxRow	getRowAtY(int y)	Gets the row at the y position.
ListBoxRow	getSelectedRow()	Gets the selected row, or null if no rows are selected.
List<ListBoxRow>	getSelectedRows()	Creates a list of all selected children.
SelectionMode	getSelectionMode()	Gets the selection mode of the listbox.
boolean	getShowSeparators()	Returns whether the list box should show separators between rows.
static Type	getType()	Get the GType of the ListBox class
void	insert(Widget child, int position)	Insert the child into the this ListBox at position.
void	invalidateFilter()	Update the filtering for all rows.
void	invalidateHeaders()	Update the separators for all rows.
void	invalidateSort()	Update the sorting for all rows.
SignalConnection<ListBox.ActivateCursorRowCallback>	onActivateCursorRow(ListBox.ActivateCursorRowCallback handler)	Emitted when the cursor row is activated.
SignalConnection<ListBox.MoveCursorCallback>	onMoveCursor(ListBox.MoveCursorCallback handler)	Emitted when the user initiates a cursor movement.
SignalConnection<ListBox.RowActivatedCallback>	onRowActivated(ListBox.RowActivatedCallback handler)	Emitted when a row has been activated by the user.
SignalConnection<ListBox.RowSelectedCallback>	onRowSelected(ListBox.RowSelectedCallback handler)	Emitted when a new row is selected, or (with a null row) when the selection is cleared.
SignalConnection<ListBox.SelectAllCallback>	onSelectAll(ListBox.SelectAllCallback handler)	Emitted to select all children of the box, if the selection mode permits it.
SignalConnection<ListBox.SelectedRowsChangedCallback>	onSelectedRowsChanged(ListBox.SelectedRowsChangedCallback handler)	Emitted when the set of selected rows changes.
SignalConnection<ListBox.ToggleCursorRowCallback>	onToggleCursorRow(ListBox.ToggleCursorRowCallback handler)	Emitted when the cursor row is toggled.
SignalConnection<ListBox.UnselectAllCallback>	onUnselectAll(ListBox.UnselectAllCallback handler)	Emitted to unselect all children of the box, if the selection mode permits it.
void	prepend(Widget child)	Prepend a widget to the list.
void	remove(Widget child)	Removes a child from this ListBox.
void	removeAll()	Removes all rows from this ListBox.
void	selectAll()	Select all children of this ListBox, if the selection mode allows it.
void	selectedForeach(ListBoxForeachFunc func)	Calls a function for each selected child.
void	selectRow(@Nullable ListBoxRow row)	Make row the currently selected row.
void	setActivateOnSingleClick(boolean single)	If single is true, rows will be activated when you click on them, otherwise you need to double-click.
void	setAdjustment(@Nullable Adjustment adjustment)	Sets the adjustment (if any) that the widget uses to for vertical scrolling.
void	setFilterFunc(@Nullable ListBoxFilterFunc filterFunc)	By setting a filter function on the this ListBox one can decide dynamically which of the rows to show.
void	setHeaderFunc(@Nullable ListBoxUpdateHeaderFunc updateHeader)	Sets a header function.
void	setPlaceholder(@Nullable Widget placeholder)	Sets the placeholder widget that is shown in the list when it doesn't display any visible children.
void	setSelectionMode(SelectionMode mode)	Sets how selection works in the listbox.
void	setShowSeparators(boolean showSeparators)	Sets whether the list box should show separators between rows.
void	setSortFunc(@Nullable ListBoxSortFunc sortFunc)	Sets a sort function.
void	unselectAll()	Unselect all children of this ListBox, if the selection mode allows it.
void	unselectRow(ListBoxRow row)	Unselects a single row of this ListBox, if the selection mode allows it.

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, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMemoryLayout, 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, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.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, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

ListBox

public ListBox(MemorySegment address)

Create a ListBox proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ListBox

public ListBox()

Creates a new GtkListBox container.

Method Details

getType

public static Type getType()

Get the GType of the ListBox class

Returns:

the GType

asParent

protected ListBox 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

append

public void append(Widget child)

Append a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

Parameters:

child - the GtkWidget to add

bindModel

public void bindModel(@Nullable
 @Nullable ListModel model,
 @Nullable
 @Nullable ListBoxCreateWidgetFunc createWidgetFunc)

Binds model to this ListBox.

If this ListBox was already bound to a model, that previous binding is destroyed.

The contents of this ListBox are cleared and then filled with widgets that represent items from model. this ListBox is updated whenever model changes. If model is null, this ListBox is left empty.

It is undefined to add or remove widgets directly (for example, with insert(org.gnome.gtk.Widget, int)) while this ListBox is bound to a model.

Note that using a model is incompatible with the filtering and sorting functionality in GtkListBox. When using a model, filtering and sorting should be implemented by the model.

Parameters:

model - the GListModel to be bound to this ListBox

createWidgetFunc - a function that creates widgets for items or null in case you also passed null as model

dragHighlightRow

public void dragHighlightRow(ListBoxRow row)

Add a drag highlight to a row.

This is a helper function for implementing DnD onto a GtkListBox. The passed in row will be highlighted by setting the StateFlags.DROP_ACTIVE state and any previously highlighted row will be unhighlighted.

The row will also be unhighlighted when the widget gets a drag leave event.

Parameters:

row - a GtkListBoxRow

dragUnhighlightRow

public void dragUnhighlightRow()

If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.

getActivateOnSingleClick

public boolean getActivateOnSingleClick()

Returns whether rows activate on single clicks.

Returns:

true if rows are activated on single click, false otherwise

getAdjustment

public Adjustment getAdjustment()

Gets the adjustment (if any) that the widget uses to for vertical scrolling.

Returns:

the adjustment

getRowAtIndex

public ListBoxRow getRowAtIndex(int index)

Gets the n-th child in the list (not counting headers).

If index is negative or larger than the number of items in the list, null is returned.

Parameters:

index - the index of the row

Returns:

the child GtkWidget

getRowAtY

public ListBoxRow getRowAtY(int y)

Gets the row at the y position.

Parameters:

y - position

Returns:

the row

getSelectedRow

public ListBoxRow getSelectedRow()

Gets the selected row, or null if no rows are selected.

Note that the box may allow multiple selection, in which case you should use selectedForeach(org.gnome.gtk.ListBoxForeachFunc) to find all selected rows.

Returns:

the selected row

getSelectedRows

public List<ListBoxRow> getSelectedRows()

Creates a list of all selected children.

Returns:

A GList containing the GtkWidget for each selected child. Free with g_list_free() when done.

getSelectionMode

public SelectionMode getSelectionMode()

Gets the selection mode of the listbox.

Returns:

a GtkSelectionMode

getShowSeparators

public boolean getShowSeparators()

Returns whether the list box should show separators between rows.

Returns:

true if the list box shows separators

insert

public void insert(Widget child,
 int position)

Insert the child into the this ListBox at position.

If a sort function is set, the widget will actually be inserted at the calculated position.

If position is -1, or larger than the total number of items in the this ListBox, then the child will be appended to the end.

Parameters:

child - the GtkWidget to add

position - the position to insert child in

invalidateFilter

public void invalidateFilter()

Update the filtering for all rows.

Call this when result of the filter function on the this ListBox is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed.

invalidateHeaders

public void invalidateHeaders()

Update the separators for all rows.

Call this when result of the header function on the this ListBox is changed due to an external factor.

invalidateSort

public void invalidateSort()

Update the sorting for all rows.

Call this when result of the sort function on the this ListBox is changed due to an external factor.

prepend

public void prepend(Widget child)

Prepend a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

Parameters:

child - the GtkWidget to add

remove

public void remove(Widget child)

Removes a child from this ListBox.

Parameters:

child - the child to remove

removeAll

public void removeAll()

Removes all rows from this ListBox.

This function does nothing if this ListBox is backed by a model.

selectAll

public void selectAll()

Select all children of this ListBox, if the selection mode allows it.

selectRow

public void selectRow(@Nullable
 @Nullable ListBoxRow row)

Make row the currently selected row.

Parameters:

row - The row to select

selectedForeach

public void selectedForeach(ListBoxForeachFunc func)

Calls a function for each selected child.

Note that the selection cannot be modified from within this function.

Parameters:

func - the function to call for each selected child

setActivateOnSingleClick

public void setActivateOnSingleClick(boolean single)

If single is true, rows will be activated when you click on them, otherwise you need to double-click.

Parameters:

single - a boolean

setAdjustment

public void setAdjustment(@Nullable
 @Nullable Adjustment adjustment)

Sets the adjustment (if any) that the widget uses to for vertical scrolling.

For instance, this is used to get the page size for PageUp/Down key handling.

In the normal case when the this ListBox is packed inside a GtkScrolledWindow the adjustment from that will be picked up automatically, so there is no need to manually do that.

Parameters:

adjustment - the adjustment

setFilterFunc

public void setFilterFunc(@Nullable
 @Nullable ListBoxFilterFunc filterFunc)

By setting a filter function on the this ListBox one can decide dynamically which of the rows to show.

For instance, to implement a search function on a list that filters the original list to only show the matching rows.

The filterFunc will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRow.changed()) or when invalidateFilter() is called.

Note that using a filter function is incompatible with using a model (see bindModel(org.gnome.gio.ListModel, org.gnome.gtk.ListBoxCreateWidgetFunc)).

Parameters:

filterFunc - callback that lets you filter which rows to show

setHeaderFunc

public void setHeaderFunc(@Nullable
 @Nullable ListBoxUpdateHeaderFunc updateHeader)

Sets a header function.

By setting a header function on the this ListBox one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list.

For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind.

The updateHeader can look at the current header widget using ListBoxRow.getHeader() and either update the state of the widget as needed, or set a new one using ListBoxRow.setHeader(org.gnome.gtk.Widget). If no header is needed, set the header to null.

Note that you may get many calls updateHeader to this for a particular row when e.g. changing things that don’t affect the header. In this case it is important for performance to not blindly replace an existing header with an identical one.

The updateHeader function will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRow.changed()) and when the row before changes (either by ListBoxRow.changed() on the previous row, or when the previous row becomes a different row). It is also called for all rows when invalidateHeaders() is called.

Parameters:

updateHeader - callback that lets you add row headers

setPlaceholder

public void setPlaceholder(@Nullable
 @Nullable Widget placeholder)

Sets the placeholder widget that is shown in the list when it doesn't display any visible children.

Parameters:

placeholder - a GtkWidget

setSelectionMode

public void setSelectionMode(SelectionMode mode)

Sets how selection works in the listbox.

Parameters:

mode - The GtkSelectionMode

setShowSeparators

public void setShowSeparators(boolean showSeparators)

Sets whether the list box should show separators between rows.

Parameters:

showSeparators - true to show separators

setSortFunc

public void setSortFunc(@Nullable
 @Nullable ListBoxSortFunc sortFunc)

Sets a sort function.

By setting a sort function on the this ListBox one can dynamically reorder the rows of the list, based on the contents of the rows.

The sortFunc will be called for each row after the call, and will continue to be called each time a row changes (via ListBoxRow.changed()) and when invalidateSort() is called.

Note that using a sort function is incompatible with using a model (see bindModel(org.gnome.gio.ListModel, org.gnome.gtk.ListBoxCreateWidgetFunc)).

Parameters:

sortFunc - the sort function

unselectAll

public void unselectAll()

Unselect all children of this ListBox, if the selection mode allows it.

unselectRow

public void unselectRow(ListBoxRow row)

Unselects a single row of this ListBox, if the selection mode allows it.

Parameters:

row - the row to unselect

onActivateCursorRow

public SignalConnection<ListBox.ActivateCursorRowCallback> onActivateCursorRow(ListBox.ActivateCursorRowCallback handler)

Emitted when the cursor row is activated.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.ActivateCursorRowCallback.run()

emitActivateCursorRow

public void emitActivateCursorRow()

Emits the "activate-cursor-row" signal. See onActivateCursorRow(org.gnome.gtk.ListBox.ActivateCursorRowCallback).

onMoveCursor

public SignalConnection<ListBox.MoveCursorCallback> onMoveCursor(ListBox.MoveCursorCallback handler)

Emitted when the user initiates a cursor movement.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual children
• Home, End move to the ends of the box
• PgUp, PgDn move vertically by pages

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.MoveCursorCallback.run(org.gnome.gtk.MovementStep, int, boolean, boolean)

emitMoveCursor

public void emitMoveCursor(MovementStep step,
 int count,
 boolean extend,
 boolean modify)

Emits the "move-cursor" signal. See onMoveCursor(org.gnome.gtk.ListBox.MoveCursorCallback).

onRowActivated

public SignalConnection<ListBox.RowActivatedCallback> onRowActivated(ListBox.RowActivatedCallback handler)

Emitted when a row has been activated by the user.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.RowActivatedCallback.run(org.gnome.gtk.ListBoxRow)

emitRowActivated

public void emitRowActivated(ListBoxRow row)

Emits the "row-activated" signal. See onRowActivated(org.gnome.gtk.ListBox.RowActivatedCallback).

onRowSelected

public SignalConnection<ListBox.RowSelectedCallback> onRowSelected(ListBox.RowSelectedCallback handler)

Emitted when a new row is selected, or (with a null row) when the selection is cleared.

When the box is using SelectionMode.MULTIPLE, this signal will not give you the full picture of selection changes, and you should use the Gtk.ListBox::selected-rows-changed signal instead.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.RowSelectedCallback.run(org.gnome.gtk.ListBoxRow)

emitRowSelected

public void emitRowSelected(@Nullable
 @Nullable ListBoxRow row)

Emits the "row-selected" signal. See onRowSelected(org.gnome.gtk.ListBox.RowSelectedCallback).

onSelectAll

public SignalConnection<ListBox.SelectAllCallback> onSelectAll(ListBox.SelectAllCallback handler)

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-a.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.SelectAllCallback.run()

emitSelectAll

public void emitSelectAll()

Emits the "select-all" signal. See onSelectAll(org.gnome.gtk.ListBox.SelectAllCallback).

onSelectedRowsChanged

public SignalConnection<ListBox.SelectedRowsChangedCallback> onSelectedRowsChanged(ListBox.SelectedRowsChangedCallback handler)

Emitted when the set of selected rows changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.SelectedRowsChangedCallback.run()

emitSelectedRowsChanged

public void emitSelectedRowsChanged()

Emits the "selected-rows-changed" signal. See onSelectedRowsChanged(org.gnome.gtk.ListBox.SelectedRowsChangedCallback).

onToggleCursorRow

public SignalConnection<ListBox.ToggleCursorRowCallback> onToggleCursorRow(ListBox.ToggleCursorRowCallback handler)

Emitted when the cursor row is toggled.

The default bindings for this signal is Ctrl+␣.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.ToggleCursorRowCallback.run()

emitToggleCursorRow

public void emitToggleCursorRow()

Emits the "toggle-cursor-row" signal. See onToggleCursorRow(org.gnome.gtk.ListBox.ToggleCursorRowCallback).

onUnselectAll

public SignalConnection<ListBox.UnselectAllCallback> onUnselectAll(ListBox.UnselectAllCallback handler)

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-Shift-a.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ListBox.UnselectAllCallback.run()

emitUnselectAll

public void emitUnselectAll()

Emits the "unselect-all" signal. See onUnselectAll(org.gnome.gtk.ListBox.UnselectAllCallback).

builder

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

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