GI.Gtk.Objects.Revealer

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

The style of transition can be controlled with revealerSetTransitionType.

These animations respect the Settings:gtkEnableAnimations 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 Revealer:revealChild property is set to False.

Accessibility

GtkRevealer uses the AccessibleRoleGroup role.

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

Exported types

newtype Revealer

Memory-managed wrapper type.

Constructors

Revealer (ManagedPtr Revealer)

Instances

Eq Revealer

Defined in GI.Gtk.Objects.Revealer

Methods

(==) :: Revealer -> Revealer -> Bool

(/=) :: Revealer -> Revealer -> Bool

GObject Revealer

Defined in GI.Gtk.Objects.Revealer

ManagedPtrNewtype Revealer

Defined in GI.Gtk.Objects.Revealer

Methods

toManagedPtr :: Revealer -> ManagedPtr Revealer

TypedObject Revealer

Defined in GI.Gtk.Objects.Revealer

Methods

glibType :: IO GType

HasParentTypes Revealer

Defined in GI.Gtk.Objects.Revealer

IsGValue (Maybe Revealer)

Convert Revealer to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.Revealer

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Revealer -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Revealer)

type ParentTypes Revealer

Defined in GI.Gtk.Objects.Revealer

type ParentTypes Revealer = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Revealer o) => IsRevealer o

Type class for types which can be safely cast to Revealer, for instance with toRevealer.

Instances

(GObject o, IsDescendantOf Revealer o) => IsRevealer o

Defined in GI.Gtk.Objects.Revealer

toRevealer :: (MonadIO m, IsRevealer o) => o -> m Revealer

Cast to Revealer, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildRevealed, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRevealChild, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getTransitionDuration, getTransitionType, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setRevealChild, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setTransitionDuration, setTransitionType, setValign, setVexpand, setVexpandSet, setVisible.

getChild

revealerGetChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> m (Maybe Widget)

Returns: the child widget of revealer

Gets the child widget of revealer.

getChildRevealed

revealerGetChildRevealed

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> m Bool

Returns: True if the child is fully revealed

Returns whether the child is fully revealed.

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

getRevealChild

revealerGetRevealChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> m Bool

Returns: True if the child is revealed.

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

getTransitionDuration

revealerGetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> m Word32

Returns: the transition duration

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

getTransitionType

revealerGetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> m RevealerTransitionType

Returns: the current transition type of revealer

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

new

revealerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Revealer

Returns: a newly created GtkRevealer

Creates a new GtkRevealer.

setChild

revealerSetChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a, IsWidget b)

=> a

revealer: a GtkRevealer

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of revealer.

setRevealChild

revealerSetRevealChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> Bool

revealChild: True to reveal the child

-> m ()

Tells the GtkRevealer to reveal or conceal its child.

The transition will be animated with the current transition type of revealer.

setTransitionDuration

revealerSetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> Word32

duration: the new duration, in milliseconds

-> m ()

Sets the duration that transitions will take.

setTransitionType

revealerSetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a GtkRevealer

-> RevealerTransitionType

transition: the new transition type

-> m ()

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

Available types include various kinds of fades and slides.

Properties

child

The child widget.

clearRevealerChild :: (MonadIO m, IsRevealer o) => o -> m ()

Set the value of the “child” property to Nothing. When overloading is enabled, this is equivalent to

clear #child

constructRevealerChild :: (IsRevealer o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “child” property. This is rarely needed directly, but it is used by new.

getRevealerChild :: (MonadIO m, IsRevealer o) => o -> m (Maybe Widget)

Get the value of the “child” property. When overloading is enabled, this is equivalent to

get revealer #child

setRevealerChild :: (MonadIO m, IsRevealer o, IsWidget a) => o -> a -> m ()

Set the value of the “child” property. When overloading is enabled, this is equivalent to

set revealer [ #child := value ]

childRevealed

Whether the child is revealed and the animation target reached.

getRevealerChildRevealed :: (MonadIO m, IsRevealer o) => o -> m Bool

Get the value of the “child-revealed” property. When overloading is enabled, this is equivalent to

get revealer #childRevealed

revealChild

Whether the revealer should reveal the child.

constructRevealerRevealChild :: (IsRevealer o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “reveal-child” property. This is rarely needed directly, but it is used by new.

getRevealerRevealChild :: (MonadIO m, IsRevealer o) => o -> m Bool

Get the value of the “reveal-child” property. When overloading is enabled, this is equivalent to

get revealer #revealChild

setRevealerRevealChild :: (MonadIO m, IsRevealer o) => o -> Bool -> m ()

Set the value of the “reveal-child” property. When overloading is enabled, this is equivalent to

set revealer [ #revealChild := value ]

transitionDuration

The animation duration, in milliseconds.

constructRevealerTransitionDuration :: (IsRevealer o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “transition-duration” property. This is rarely needed directly, but it is used by new.

getRevealerTransitionDuration :: (MonadIO m, IsRevealer o) => o -> m Word32

Get the value of the “transition-duration” property. When overloading is enabled, this is equivalent to

get revealer #transitionDuration

setRevealerTransitionDuration :: (MonadIO m, IsRevealer o) => o -> Word32 -> m ()

Set the value of the “transition-duration” property. When overloading is enabled, this is equivalent to

set revealer [ #transitionDuration := value ]

transitionType

The type of animation used to transition.

constructRevealerTransitionType :: (IsRevealer o, MonadIO m) => RevealerTransitionType -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “transition-type” property. This is rarely needed directly, but it is used by new.

getRevealerTransitionType :: (MonadIO m, IsRevealer o) => o -> m RevealerTransitionType

Get the value of the “transition-type” property. When overloading is enabled, this is equivalent to

get revealer #transitionType

setRevealerTransitionType :: (MonadIO m, IsRevealer o) => o -> RevealerTransitionType -> m ()

Set the value of the “transition-type” property. When overloading is enabled, this is equivalent to

set revealer [ #transitionType := value ]