Package org.gnome.gtk

Class Overlay

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

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

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

Places “overlay” widgets on top of a single main child.

The position of each overlay widget is determined by its Gtk.Widget:halign and Gtk.Widget:valign properties. E.g. a widget with both alignments set to Align.START will be placed at the top left corner of the GtkOverlay container, whereas an overlay with halign set to Align.CENTER and valign set to Align.END will be placed a the bottom edge of the GtkOverlay, horizontally centered. The position can be adjusted by setting the margin properties of the child to non-zero values.

More complicated placement of overlays is possible by connecting to the Gtk.Overlay::get-child-position signal.

An overlay’s minimum and natural sizes are those of its main child. The sizes of overlay children are not considered when measuring these preferred sizes.

GtkOverlay as GtkBuildable
The GtkOverlay implementation of the GtkBuildable interface supports placing a child as an overlay by specifying “overlay” as the “type” attribute of a <child> element.

CSS nodes
GtkOverlay has a single CSS node with the name “overlay”. Overlay children whose alignments cause them to be positioned at an edge get the style classes “.left”, “.right”, “.top”, and/or “.bottom” according to their position.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Overlay.Builder<B extends Overlay.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Overlay.GetChildPositionCallback	Functional interface declaration of the GetChildPositionCallback 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addOverlay(Widget widget)	Adds widget to overlay.
protected Overlay	asParent()	Returns this instance as if it were its parent type.
static Overlay.Builder<? extends Overlay.Builder>	builder()	A Overlay.Builder object constructs a Overlay with the specified properties.
boolean	emitGetChildPosition(@Nullable Widget widget, @Nullable Rectangle allocation)	Emits the "get-child-position" signal.
@Nullable Widget	getChild()	Gets the child widget of overlay.
boolean	getClipOverlay(Widget widget)	Gets whether widget should be clipped within the parent.
boolean	getMeasureOverlay(Widget widget)	Gets whether widget's size is included in the measurement of overlay.
static @Nullable Type	getType()	Get the GType of the Overlay class
SignalConnection<Overlay.GetChildPositionCallback>	onGetChildPosition(Overlay.GetChildPositionCallback handler)	Emitted to determine the position and size of any overlay child widgets.
void	removeOverlay(Widget widget)	Removes an overlay that was added with gtk_overlay_add_overlay().
void	setChild(@Nullable Widget child)	Sets the child widget of overlay.
void	setClipOverlay(Widget widget, boolean clipOverlay)	Sets whether widget should be clipped within the parent.
void	setMeasureOverlay(Widget widget, boolean measure)	Sets whether widget is included in the measured size of overlay.

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.javagi.base.Proxy

handle

Constructor Details

Overlay

public Overlay(MemorySegment address)

Create a Overlay proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Overlay

public Overlay()

Creates a new Overlay.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Overlay class

Returns:

the GType

asParent

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

addOverlay

public void addOverlay(Widget widget)

Adds widget to overlay.

The widget will be stacked on top of the main widget added with setChild(org.gnome.gtk.Widget).

The position at which widget is placed is determined from its Gtk.Widget:halign and Gtk.Widget:valign properties.

Parameters:

widget - a GtkWidget to be added to the container

getChild

public @Nullable Widget getChild()

Gets the child widget of overlay.

Returns:

the child widget of this Overlay

getClipOverlay

public boolean getClipOverlay(Widget widget)

Gets whether widget should be clipped within the parent.

Parameters:

widget - an overlay child of GtkOverlay

Returns:

whether the widget is clipped within the parent.

getMeasureOverlay

public boolean getMeasureOverlay(Widget widget)

Gets whether widget's size is included in the measurement of overlay.

Parameters:

widget - an overlay child of GtkOverlay

Returns:

whether the widget is measured

removeOverlay

public void removeOverlay(Widget widget)

Removes an overlay that was added with gtk_overlay_add_overlay().

Parameters:

widget - a GtkWidget to be removed

setChild

public void setChild(@Nullable Widget child)

Sets the child widget of overlay.

Parameters:

child - the child widget

setClipOverlay

public void setClipOverlay(Widget widget,
 boolean clipOverlay)

Sets whether widget should be clipped within the parent.

Parameters:

widget - an overlay child of GtkOverlay

clipOverlay - whether the child should be clipped

setMeasureOverlay

public void setMeasureOverlay(Widget widget,
 boolean measure)

Sets whether widget is included in the measured size of overlay.

The overlay will request the size of the largest child that has this property set to true. Children who are not included may be drawn outside of overlay's allocation if they are too large.

Parameters:

widget - an overlay child of GtkOverlay

measure - whether the child should be measured

onGetChildPosition

public SignalConnection<Overlay.GetChildPositionCallback> onGetChildPosition(Overlay.GetChildPositionCallback handler)

Emitted to determine the position and size of any overlay child widgets.

A handler for this signal should fill allocation with the desired position and size for widget, relative to the 'main' child of overlay.

The default handler for this signal uses the widget's halign and valign properties to determine the position and gives the widget its natural size (except that an alignment of Align.FILL will cause the overlay to be full-width/height). If the main child is a GtkScrolledWindow, the overlays are placed relative to its contents.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Overlay.GetChildPositionCallback.run(org.gnome.gtk.Widget, org.gnome.gdk.Rectangle)

emitGetChildPosition

public boolean emitGetChildPosition(@Nullable Widget widget,
 @Nullable Rectangle allocation)

Emits the "get-child-position" signal. See onGetChildPosition(org.gnome.gtk.Overlay.GetChildPositionCallback).

builder

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

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

Returns:

the builder object