Package org.gnome.gtk

Class FlowBox

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.FlowBox

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Orientable, Proxy

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

Puts child widgets in a reflowing grid.

For instance, with the horizontal orientation, the widgets will be arranged from left to right, starting a new row under the previous row when necessary. Reducing the width in this case will require more rows, so a larger height will be requested.

Likewise, with the vertical orientation, the widgets will be arranged from top to bottom, starting a new column to the right when necessary. Reducing the height will require more columns, so a larger width will be requested.

The size request of a GtkFlowBox alone may not be what you expect; if you need to be able to shrink it along both axes and dynamically reflow its children, you may have to wrap it in a GtkScrolledWindow to enable that.

The children of a GtkFlowBox can be dynamically sorted and filtered.

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

Also see ListBox.

Shortcuts and Gestures
The following signals have default keybindings:

• Gtk.FlowBox::move-cursor
• Gtk.FlowBox::select-all
• Gtk.FlowBox::toggle-cursor-child
• Gtk.FlowBox::unselect-all

CSS nodes

 flowbox
 ├── flowboxchild
 │   ╰── <child>
 ├── flowboxchild
 │   ╰── <child>
 ┊
 ╰── [rubberband]
 

GtkFlowBox uses a single CSS node with name flowbox. GtkFlowBoxChild uses a single CSS node with name flowboxchild. For rubberband selection, a subnode with name rubberband is used.

Accessibility
GtkFlowBox uses the Gtk.AccessibleRole.grid role, and GtkFlowBoxChild uses the Gtk.AccessibleRole.grid_cell role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FlowBox.ActivateCursorChildCallback	Functional interface declaration of the ActivateCursorChildCallback callback.
static class	FlowBox.Builder<B extends FlowBox.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	FlowBox.ChildActivatedCallback	Functional interface declaration of the ChildActivatedCallback callback.
static interface	FlowBox.MoveCursorCallback	Functional interface declaration of the MoveCursorCallback callback.
static interface	FlowBox.SelectAllCallback	Functional interface declaration of the SelectAllCallback callback.
static interface	FlowBox.SelectedChildrenChangedCallback	Functional interface declaration of the SelectedChildrenChangedCallback callback.
static interface	FlowBox.ToggleCursorChildCallback	Functional interface declaration of the ToggleCursorChildCallback callback.
static interface	FlowBox.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.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.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

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

Orientable.Orientable$Impl, Orientable.OrientableIface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	append(Widget child)	Adds child to the end of self.
protected FlowBox	asParent()	Returns this instance as if it were its parent type.
void	bindModel(@Nullable ListModel model, @Nullable FlowBoxCreateWidgetFunc createWidgetFunc)	Binds model to box.
static FlowBox.Builder<? extends FlowBox.Builder>	builder()	A FlowBox.Builder object constructs a FlowBox with the specified properties.
void	emitActivateCursorChild()	Emits the "activate-cursor-child" signal.
void	emitChildActivated(@Nullable FlowBoxChild child)	Emits the "child-activated" signal.
boolean	emitMoveCursor(MovementStep step, int count, boolean extend, boolean modify)	Emits the "move-cursor" signal.
void	emitSelectAll()	Emits the "select-all" signal.
void	emitSelectedChildrenChanged()	Emits the "selected-children-changed" signal.
void	emitToggleCursorChild()	Emits the "toggle-cursor-child" signal.
void	emitUnselectAll()	Emits the "unselect-all" signal.
boolean	getActivateOnSingleClick()	Returns whether children activate on single clicks.
@Nullable FlowBoxChild	getChildAtIndex(int idx)	Gets the nth child in the box.
@Nullable FlowBoxChild	getChildAtPos(int x, int y)	Gets the child in the (x, y) position.
int	getColumnSpacing()	Gets the horizontal spacing.
boolean	getHomogeneous()	Returns whether the box is homogeneous.
int	getMaxChildrenPerLine()	Gets the maximum number of children per line.
int	getMinChildrenPerLine()	Gets the minimum number of children per line.
int	getRowSpacing()	Gets the vertical spacing.
List<FlowBoxChild>	getSelectedChildren()	Creates a list of all selected children.
SelectionMode	getSelectionMode()	Gets the selection mode of box.
static @Nullable Type	getType()	Get the GType of the FlowBox class
void	insert(Widget widget, int position)	Inserts the widget into this FlowBox at position.
void	invalidateFilter()	Updates the filtering for all children.
void	invalidateSort()	Updates the sorting for all children.
SignalConnection<FlowBox.ActivateCursorChildCallback>	onActivateCursorChild(FlowBox.ActivateCursorChildCallback handler)	Emitted when the user activates the box.
SignalConnection<FlowBox.ChildActivatedCallback>	onChildActivated(FlowBox.ChildActivatedCallback handler)	Emitted when a child has been activated by the user.
SignalConnection<FlowBox.MoveCursorCallback>	onMoveCursor(FlowBox.MoveCursorCallback handler)	Emitted when the user initiates a cursor movement.
SignalConnection<FlowBox.SelectAllCallback>	onSelectAll(FlowBox.SelectAllCallback handler)	Emitted to select all children of the box, if the selection mode permits it.
SignalConnection<FlowBox.SelectedChildrenChangedCallback>	onSelectedChildrenChanged(FlowBox.SelectedChildrenChangedCallback handler)	Emitted when the set of selected children changes.
SignalConnection<FlowBox.ToggleCursorChildCallback>	onToggleCursorChild(FlowBox.ToggleCursorChildCallback handler)	Emitted to toggle the selection of the child that has the focus.
SignalConnection<FlowBox.UnselectAllCallback>	onUnselectAll(FlowBox.UnselectAllCallback handler)	Emitted to unselect all children of the box, if the selection mode permits it.
void	prepend(Widget child)	Adds child to the start of self.
void	remove(Widget widget)	Removes a child from box.
void	removeAll()	Removes all children from box.
void	selectAll()	Select all children of box, if the selection mode allows it.
void	selectChild(FlowBoxChild child)	Selects a single child of box, if the selection mode allows it.
void	selectedForeach(@Nullable FlowBoxForeachFunc func)	Calls a function for each selected child.
void	setActivateOnSingleClick(boolean single)	If single is true, children will be activated when you click on them, otherwise you need to double-click.
void	setColumnSpacing(int spacing)	Sets the horizontal space to add between children.
void	setFilterFunc(@Nullable FlowBoxFilterFunc filterFunc)	By setting a filter function on the this FlowBox one can decide dynamically which of the children to show.
void	setHadjustment(Adjustment adjustment)	Hooks up an adjustment to focus handling in box.
void	setHomogeneous(boolean homogeneous)	Sets whether or not all children of this FlowBox are given equal space in the box.
void	setMaxChildrenPerLine(int nChildren)	Sets the maximum number of children to request and allocate space for in box’s orientation.
void	setMinChildrenPerLine(int nChildren)	Sets the minimum number of children to line up in box’s orientation before flowing.
void	setRowSpacing(int spacing)	Sets the vertical space to add between children.
void	setSelectionMode(SelectionMode mode)	Sets how selection works in box.
void	setSortFunc(@Nullable FlowBoxSortFunc sortFunc)	By setting a sort function on the box, one can dynamically reorder the children of the box, based on the contents of the children.
void	setVadjustment(Adjustment adjustment)	Hooks up an adjustment to focus handling in box.
void	unselectAll()	Unselect all children of box, if the selection mode allows it.
void	unselectChild(FlowBoxChild child)	Unselects a single child of box, 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, getLimitEvents, 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, 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.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Orientable

getOrientation, setOrientation

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

FlowBox

public FlowBox(MemorySegment address)

Create a FlowBox proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FlowBox

public FlowBox()

Creates a new FlowBox.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FlowBox class

Returns:

the GType

asParent

protected FlowBox 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)

Adds child to the end of self.

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

See also: insert(org.gnome.gtk.Widget, int).

Parameters:

child - the GtkWidget to add

Since:

4.6

bindModel

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

Binds model to box.

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

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

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

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

Parameters:

model - the GListModel to be bound to this FlowBox

createWidgetFunc - a function that creates widgets for items

getActivateOnSingleClick

public boolean getActivateOnSingleClick()

Returns whether children activate on single clicks.

Returns:

true if children are activated on single click, false otherwise

getChildAtIndex

public @Nullable FlowBoxChild getChildAtIndex(int idx)

Gets the nth child in the box.

Parameters:

idx - the position of the child

Returns:

the child widget, which will always be a GtkFlowBoxChild or null in case no child widget with the given index exists.

getChildAtPos

public @Nullable FlowBoxChild getChildAtPos(int x,
 int y)

Gets the child in the (x, y) position.

Both x and y are assumed to be relative to the origin of box.

Parameters:

x - the x coordinate of the child

y - the y coordinate of the child

Returns:

the child widget, which will always be a GtkFlowBoxChild or null in case no child widget exists for the given x and y coordinates.

getColumnSpacing

public int getColumnSpacing()

Gets the horizontal spacing.

Returns:

the horizontal spacing

getHomogeneous

public boolean getHomogeneous()

Returns whether the box is homogeneous.

Returns:

true if the box is homogeneous.

getMaxChildrenPerLine

public int getMaxChildrenPerLine()

Gets the maximum number of children per line.

Returns:

the maximum number of children per line

getMinChildrenPerLine

public int getMinChildrenPerLine()

Gets the minimum number of children per line.

Returns:

the minimum number of children per line

getRowSpacing

public int getRowSpacing()

Gets the vertical spacing.

Returns:

the vertical spacing

getSelectedChildren

public List<FlowBoxChild> getSelectedChildren()

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 box.

Returns:

the GtkSelectionMode

insert

public void insert(Widget widget,
 int position)

Inserts the widget into this FlowBox 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 children in the box, then the widget will be appended to the end.

Parameters:

widget - the GtkWidget to add

position - the position to insert child in

invalidateFilter

public void invalidateFilter()

Updates the filtering for all children.

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

invalidateSort

public void invalidateSort()

Updates the sorting for all children.

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

prepend

public void prepend(Widget child)

Adds child to the start of self.

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

See also: insert(org.gnome.gtk.Widget, int).

Parameters:

child - the GtkWidget to add

Since:

4.6

remove

public void remove(Widget widget)

Removes a child from box.

Parameters:

widget - the child widget to remove

removeAll

public void removeAll()

Removes all children from box.

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

Since:

4.12

selectAll

public void selectAll()

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

selectChild

public void selectChild(FlowBoxChild child)

Selects a single child of box, if the selection mode allows it.

Parameters:

child - a child of this FlowBox

selectedForeach

public void selectedForeach(@Nullable FlowBoxForeachFunc 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, children will be activated when you click on them, otherwise you need to double-click.

Parameters:

single - true to emit child-activated on a single click

setColumnSpacing

public void setColumnSpacing(int spacing)

Sets the horizontal space to add between children.

Parameters:

spacing - the spacing to use

setFilterFunc

public void setFilterFunc(@Nullable FlowBoxFilterFunc filterFunc)

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

For instance, to implement a search function that only shows the children matching the search terms.

The filterFunc will be called for each child after the call, and it will continue to be called each time a child changes (via FlowBoxChild.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.FlowBoxCreateWidgetFunc)).

Parameters:

filterFunc - callback that lets you filter which children to show

setHadjustment

public void setHadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in box.

The adjustment is also used for autoscrolling during rubberband selection. See ScrolledWindow.getHadjustment() for a typical way of obtaining the adjustment, and setVadjustment(org.gnome.gtk.Adjustment) for setting the vertical adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Parameters:

adjustment - an adjustment which should be adjusted when the focus is moved among the descendents of container

setHomogeneous

public void setHomogeneous(boolean homogeneous)

Sets whether or not all children of this FlowBox are given equal space in the box.

Parameters:

homogeneous - true to create equal allotments, false for variable allotments

setMaxChildrenPerLine

public void setMaxChildrenPerLine(int nChildren)

Sets the maximum number of children to request and allocate space for in box’s orientation.

Setting the maximum number of children per line limits the overall natural size request to be no more than nChildren children long in the given orientation.

Parameters:

nChildren - the maximum number of children per line

setMinChildrenPerLine

public void setMinChildrenPerLine(int nChildren)

Sets the minimum number of children to line up in box’s orientation before flowing.

Parameters:

nChildren - the minimum number of children per line

setRowSpacing

public void setRowSpacing(int spacing)

Sets the vertical space to add between children.

Parameters:

spacing - the spacing to use

setSelectionMode

public void setSelectionMode(SelectionMode mode)

Sets how selection works in box.

Parameters:

mode - the new selection mode

setSortFunc

public void setSortFunc(@Nullable FlowBoxSortFunc sortFunc)

By setting a sort function on the box, one can dynamically reorder the children of the box, based on the contents of the children.

The sortFunc will be called for each child after the call, and will continue to be called each time a child changes (via FlowBoxChild.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.FlowBoxCreateWidgetFunc)).

Parameters:

sortFunc - the sort function

setVadjustment

public void setVadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in box.

The adjustment is also used for autoscrolling during rubberband selection. See ScrolledWindow.getVadjustment() for a typical way of obtaining the adjustment, and setHadjustment(org.gnome.gtk.Adjustment) for setting the horizontal adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Parameters:

adjustment - an adjustment which should be adjusted when the focus is moved among the descendents of container

unselectAll

public void unselectAll()

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

unselectChild

public void unselectChild(FlowBoxChild child)

Unselects a single child of box, if the selection mode allows it.

Parameters:

child - a child of this FlowBox

onActivateCursorChild

public SignalConnection<FlowBox.ActivateCursorChildCallback> onActivateCursorChild(FlowBox.ActivateCursorChildCallback handler)

Emitted when the user activates the box.

This is a keybinding signal.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• FlowBox.ActivateCursorChildCallback.run()

emitActivateCursorChild

public void emitActivateCursorChild()

Emits the "activate-cursor-child" signal. See onActivateCursorChild(org.gnome.gtk.FlowBox.ActivateCursorChildCallback).

onChildActivated

public SignalConnection<FlowBox.ChildActivatedCallback> onChildActivated(FlowBox.ChildActivatedCallback handler)

Emitted when a child 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:

• FlowBox.ChildActivatedCallback.run(org.gnome.gtk.FlowBoxChild)

emitChildActivated

public void emitChildActivated(@Nullable FlowBoxChild child)

Emits the "child-activated" signal. See onChildActivated(org.gnome.gtk.FlowBox.ChildActivatedCallback).

onMoveCursor

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

Emitted when the user initiates a cursor movement.

This is a keybinding signal. Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

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:

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

emitMoveCursor

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

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

onSelectAll

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

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

This is a keybinding signal.

The default bindings 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:

• FlowBox.SelectAllCallback.run()

emitSelectAll

public void emitSelectAll()

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

onSelectedChildrenChanged

public SignalConnection<FlowBox.SelectedChildrenChangedCallback> onSelectedChildrenChanged(FlowBox.SelectedChildrenChangedCallback handler)

Emitted when the set of selected children changes.

Use selectedForeach(org.gnome.gtk.FlowBoxForeachFunc) or getSelectedChildren() to obtain the selected children.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• FlowBox.SelectedChildrenChangedCallback.run()

emitSelectedChildrenChanged

public void emitSelectedChildrenChanged()

Emits the "selected-children-changed" signal. See onSelectedChildrenChanged(org.gnome.gtk.FlowBox.SelectedChildrenChangedCallback).

onToggleCursorChild

public SignalConnection<FlowBox.ToggleCursorChildCallback> onToggleCursorChild(FlowBox.ToggleCursorChildCallback handler)

Emitted to toggle the selection of the child that has the focus.

This is a keybinding signal.

The default binding for this signal is Ctrl-Space.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• FlowBox.ToggleCursorChildCallback.run()

emitToggleCursorChild

public void emitToggleCursorChild()

Emits the "toggle-cursor-child" signal. See onToggleCursorChild(org.gnome.gtk.FlowBox.ToggleCursorChildCallback).

onUnselectAll

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

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

This is a keybinding signal.

The default bindings 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:

• FlowBox.UnselectAllCallback.run()

emitUnselectAll

public void emitUnselectAll()

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

builder

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

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

Returns:

the builder object