Package org.gnome.gtk

Class Box

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

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Orientable, Proxy

Direct Known Subclasses:

ShortcutsGroup, ShortcutsSection

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

Arranges child widgets into a single row or column.

Whether it is a row or column depends on the value of its Gtk.Orientable:orientation property. Within the other dimension, all children are allocated the same size. The Gtk.Widget:halign and Gtk.Widget:valign properties can be used on the children to influence their allocation.

Use repeated calls to append(org.gnome.gtk.Widget) to pack widgets into a GtkBox from start to end. Use remove(org.gnome.gtk.Widget) to remove widgets from the GtkBox. insertChildAfter(org.gnome.gtk.Widget, org.gnome.gtk.Widget) can be used to add a child at a particular position.

Use setHomogeneous(boolean) to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use setSpacing(int) to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children.

Use reorderChildAfter(org.gnome.gtk.Widget, org.gnome.gtk.Widget) to move a child to a different place in the box.

CSS nodes
GtkBox uses a single CSS node with name box.

Accessibility
Until GTK 4.10, GtkBox used the Gtk.AccessibleRole.group role.

Starting from GTK 4.12, GtkBox uses the Gtk.AccessibleRole.generic role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Box.BoxClass
static class	Box.Builder<B extends Box.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

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
Box()	Creates a new Box.
Box(MemorySegment address)	Create a Box proxy instance for the provided memory address.
Box(Orientation orientation, int spacing)	Creates a new box.

Method Summary

Modifier and Type	Method	Description
void	append(Widget child)	Adds a child at the end.
protected Box	asParent()	Returns this instance as if it were its parent type.
static Box.Builder<? extends Box.Builder>	builder()	A Box.Builder object constructs a Box with the specified properties.
int	getBaselineChild()	Gets the value set by setBaselineChild(int).
BaselinePosition	getBaselinePosition()	Gets the value set by setBaselinePosition(org.gnome.gtk.BaselinePosition).
boolean	getHomogeneous()	Returns whether the box is homogeneous.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	getSpacing()	Gets the value set by setSpacing(int).
static @Nullable Type	getType()	Get the GType of the Box class
void	insertChildAfter(Widget child, @Nullable Widget sibling)	Inserts a child at a specific position.
void	prepend(Widget child)	Adds a child at the beginning.
void	remove(Widget child)	Removes a child widget from the box.
void	reorderChildAfter(Widget child, @Nullable Widget sibling)	Moves a child to a different position.
void	setBaselineChild(int child)	Sets the baseline child of a box.
void	setBaselinePosition(BaselinePosition position)	Sets the baseline position of a box.
void	setHomogeneous(boolean homogeneous)	Sets whether or not all children are given equal space in the box.
void	setSpacing(int spacing)	Sets the number of pixels to place between children.

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

getBuildableId

Methods inherited from interface org.gnome.gtk.Orientable

getOrientation, setOrientation

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

Box

public Box(MemorySegment address)

Create a Box proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Box

public Box(Orientation orientation,
 int spacing)

Creates a new box.

Parameters:

orientation - the box’s orientation

spacing - the number of pixels to place between children

Box

public Box()

Creates a new Box.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Box class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Box 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 a child at the end.

Parameters:

child - the widget to append

getBaselineChild

public int getBaselineChild()

Gets the value set by setBaselineChild(int).

Returns:

the baseline child

Since:

4.12

getBaselinePosition

public BaselinePosition getBaselinePosition()

Gets the value set by setBaselinePosition(org.gnome.gtk.BaselinePosition).

Returns:

the baseline position

getHomogeneous

public boolean getHomogeneous()

Returns whether the box is homogeneous.

In a homogeneous box all children are the same size.

Returns:

true if the box is homogeneous

getSpacing

public int getSpacing()

Gets the value set by setSpacing(int).

Returns:

spacing between children

insertChildAfter

public void insertChildAfter(Widget child,
 @Nullable Widget sibling)

Inserts a child at a specific position.

The child is added after sibling in the list of this Box children.

If sibling is NULL, the child is placed at the beginning.

Parameters:

child - the widget to insert

sibling - the sibling after which to insert child

prepend

public void prepend(Widget child)

Adds a child at the beginning.

Parameters:

child - the widget to prepend

remove

public void remove(Widget child)

Removes a child widget from the box.

The child must have been added before with append(org.gnome.gtk.Widget), prepend(org.gnome.gtk.Widget), or insertChildAfter(org.gnome.gtk.Widget, org.gnome.gtk.Widget).

Parameters:

child - the child to remove

reorderChildAfter

public void reorderChildAfter(Widget child,
 @Nullable Widget sibling)

Moves a child to a different position.

The child is moved to the position after sibling in the list of this Box children.

If sibling is NULL, the child is placed at the beginning.

Parameters:

child - the widget to move, must be a child of this Box

sibling - the sibling to move child after

setBaselineChild

public void setBaselineChild(int child)

Sets the baseline child of a box.

This affects only vertical boxes.

Parameters:

child - a child position, or -1

Since:

4.12

setBaselinePosition

public void setBaselinePosition(BaselinePosition position)

Sets the baseline position of a box.

This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then position is used to allocate the baseline with respect to the extra space available.

Parameters:

position - the baseline position

setHomogeneous

public void setHomogeneous(boolean homogeneous)

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

Parameters:

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

setSpacing

public void setSpacing(int spacing)

Sets the number of pixels to place between children.

Parameters:

spacing - the number of pixels to put between children

builder

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

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

Returns:

the builder object