Package org.gnome.gtk

Class Revealer

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

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

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

A GtkRevealer animates the transition of its child from invisible to visible.

The style of transition can be controlled with setTransitionType(org.gnome.gtk.RevealerTransitionType).

These animations respect the Gtk.Settings:gtk-enable-animations setting.

CSS nodes
GtkRevealer has a single CSS node with name revealer. When styling GtkRevealer using CSS, remember that it only hides its contents, not itself. That means applied margin, padding and borders will be visible even when the Gtk.Revealer:reveal-child property is set to false.

Accessibility
GtkRevealer uses the AccessibleRole.GROUP role.

The child of GtkRevealer, if set, is always available in the accessibility tree, regardless of the state of the revealer widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Revealer.Builder<B extends Revealer.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.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
Revealer()	Creates a new GtkRevealer.
Revealer(MemorySegment address)	Create a Revealer proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Revealer	asParent()	Returns this instance as if it were its parent type.
static Revealer.Builder<? extends Revealer.Builder>	builder()	A Revealer.Builder object constructs a Revealer with the specified properties.
Widget	getChild()	Gets the child widget of this Revealer.
boolean	getChildRevealed()	Returns whether the child is fully revealed.
boolean	getRevealChild()	Returns whether the child is currently revealed.
int	getTransitionDuration()	Returns the amount of time (in milliseconds) that transitions will take.
RevealerTransitionType	getTransitionType()	Gets the type of animation that will be used for transitions in this Revealer.
static Type	getType()	Get the GType of the Revealer class
void	setChild(@Nullable Widget child)	Sets the child widget of this Revealer.
void	setRevealChild(boolean revealChild)	Tells the GtkRevealer to reveal or conceal its child.
void	setTransitionDuration(int duration)	Sets the duration that transitions will take.
void	setTransitionType(RevealerTransitionType transition)	Sets the type of animation that will be used for transitions in this Revealer.

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, 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

Revealer

public Revealer(MemorySegment address)

Create a Revealer proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Revealer

public Revealer()

Creates a new GtkRevealer.

Method Details

getType

public static Type getType()

Get the GType of the Revealer class

Returns:

the GType

asParent

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

getChild

public Widget getChild()

Gets the child widget of this Revealer.

Returns:

the child widget of this Revealer

getChildRevealed

public boolean getChildRevealed()

Returns whether the child is fully revealed.

In other words, this returns whether the transition to the revealed state is completed.

Returns:

true if the child is fully revealed

getRevealChild

public boolean getRevealChild()

Returns whether the child is currently revealed.

This function returns true as soon as the transition is to the revealed state is started. To learn whether the child is fully revealed (ie the transition is completed), use getChildRevealed().

Returns:

true if the child is revealed.

getTransitionDuration

public int getTransitionDuration()

Returns the amount of time (in milliseconds) that transitions will take.

Returns:

the transition duration

getTransitionType

public RevealerTransitionType getTransitionType()

Gets the type of animation that will be used for transitions in this Revealer.

Returns:

the current transition type of this Revealer

setChild

public void setChild(@Nullable
 @Nullable Widget child)

Sets the child widget of this Revealer.

Parameters:

child - the child widget

setRevealChild

public void setRevealChild(boolean revealChild)

Tells the GtkRevealer to reveal or conceal its child.

The transition will be animated with the current transition type of this Revealer.

Parameters:

revealChild - true to reveal the child

setTransitionDuration

public void setTransitionDuration(int duration)

Sets the duration that transitions will take.

Parameters:

duration - the new duration, in milliseconds

setTransitionType

public void setTransitionType(RevealerTransitionType transition)

Sets the type of animation that will be used for transitions in this Revealer.

Available types include various kinds of fades and slides.

Parameters:

transition - the new transition type

builder

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

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