Class AspectFrame

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

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

@Generated("org.javagi.JavaGI")
public class AspectFrame
extends Widget
implements Accessible, Buildable, ConstraintTarget

Preserves the aspect ratio of its child.

The frame can respect the aspect ratio of the child widget, or use its own aspect ratio.

CSS nodes

GtkAspectFrame uses a CSS node with name aspectframe.

Accessibility

Until GTK 4.10, GtkAspectFrame used the Gtk.AccessibleRole.group role.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class 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 InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
AspectFrame()	Create a new AspectFrame.
AspectFrame(float xalign, float yalign, float ratio, boolean obeyChild)	Create a new GtkAspectFrame.
AspectFrame(MemorySegment address)	Create a AspectFrame instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected AspectFrame	asParent()	Return this instance as if it were its parent type.
static AspectFrame.Builder<? extends AspectFrame.Builder>	builder()	A AspectFrame.Builder object constructs a AspectFrame with the specified properties.
@Nullable Widget	getChild()	Gets the child widget of self.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getObeyChild()	Returns whether the child's size request should override the set aspect ratio of the GtkAspectFrame.
float	getRatio()	Returns the desired aspect ratio of the child.
static @Nullable Type	getType()	Get the GType of the AspectFrame class.
float	getXalign()	Returns the horizontal alignment of the child within the allocation of the GtkAspectFrame.
float	getYalign()	Returns the vertical alignment of the child within the allocation of the GtkAspectFrame.
void	setChild(@Nullable Widget child)	Sets the child widget of self.
void	setObeyChild(boolean obeyChild)	Sets whether the aspect ratio of the child's size request should override the set aspect ratio of the GtkAspectFrame.
void	setRatio(float ratio)	Sets the desired aspect ratio of the child.
void	setXalign(float xalign)	Sets the horizontal alignment of the child within the allocation of the GtkAspectFrame.
void	setYalign(float yalign)	Sets the vertical alignment of the child within the allocation of the GtkAspectFrame.

Methods inherited from class 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 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

Methods inherited from interface Accessible

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

Methods inherited from interface Buildable

getBuildableId

Methods inherited from interface Proxy

handle

Constructor Details

AspectFrame

public AspectFrame(MemorySegment address)

Create a AspectFrame instance for the provided memory address.

Parameters:

address - the memory address of the native object

AspectFrame

public AspectFrame(float xalign,
 float yalign,
 float ratio,
 boolean obeyChild)

Create a new GtkAspectFrame.

Parameters:

xalign - Horizontal alignment of the child within the parent. Ranges from 0.0 (left aligned) to 1.0 (right aligned)

yalign - Vertical alignment of the child within the parent. Ranges from 0.0 (top aligned) to 1.0 (bottom aligned)

ratio - The desired aspect ratio.

obeyChild - If true, ratio is ignored, and the aspect ratio is taken from the requistion of the child.

AspectFrame

public AspectFrame()

Create a new AspectFrame.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AspectFrame class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected AspectFrame 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 Widget

Returns:

the instance as if it were its parent type

getChild

public @Nullable Widget getChild()

Gets the child widget of self.

Returns:

the child widget of this AspectFrame

getObeyChild

public boolean getObeyChild()

Returns whether the child's size request should override the set aspect ratio of the GtkAspectFrame.

Returns:

whether to obey the child's size request

getRatio

public float getRatio()

Returns the desired aspect ratio of the child.

Returns:

the desired aspect ratio

getXalign

public float getXalign()

Returns the horizontal alignment of the child within the allocation of the GtkAspectFrame.

Returns:

the horizontal alignment

getYalign

public float getYalign()

Returns the vertical alignment of the child within the allocation of the GtkAspectFrame.

Returns:

the vertical alignment

setChild

public void setChild(@Nullable Widget child)

Sets the child widget of self.

Parameters:

child - the child widget

setObeyChild

public void setObeyChild(boolean obeyChild)

Sets whether the aspect ratio of the child's size request should override the set aspect ratio of the GtkAspectFrame.

Parameters:

obeyChild - If true, ratio is ignored, and the aspect ratio is taken from the requisition of the child.

setRatio

public void setRatio(float ratio)

Sets the desired aspect ratio of the child.

Parameters:

ratio - aspect ratio of the child

setXalign

public void setXalign(float xalign)

Sets the horizontal alignment of the child within the allocation of the GtkAspectFrame.

Parameters:

xalign - horizontal alignment, from 0.0 (left aligned) to 1.0 (right aligned)

setYalign

public void setYalign(float yalign)

Sets the vertical alignment of the child within the allocation of the GtkAspectFrame.

Parameters:

yalign - horizontal alignment, from 0.0 (top aligned) to 1.0 (bottom aligned)

builder

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

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

Returns:

the builder object