GI.Gtk.Objects.Revealer

The GtkRevealer widget is a container which animates the transition of its child from invisible to visible.

The style of transition can be controlled with revealerSetTransitionType.

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

CSS nodes

GtkRevealer has a single CSS node with name revealer.

The GtkRevealer widget was added in GTK+ 3.10.

Exported types

newtype Revealer

Memory-managed wrapper type.

Constructors

Revealer (ManagedPtr Revealer)

Instances

GObject Revealer

Defined in GI.Gtk.Objects.Revealer

Methods

gobjectType :: Revealer -> IO GType

IsImplementorIface Revealer

Defined in GI.Gtk.Objects.Revealer

IsObject Revealer

Defined in GI.Gtk.Objects.Revealer

IsBuildable Revealer

Defined in GI.Gtk.Objects.Revealer

IsBin Revealer

Defined in GI.Gtk.Objects.Revealer

IsContainer Revealer

Defined in GI.Gtk.Objects.Revealer

IsWidget Revealer

Defined in GI.Gtk.Objects.Revealer

IsRevealer Revealer

Defined in GI.Gtk.Objects.Revealer

class GObject o => IsRevealer o

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

Instances

(GObject a, (UnknownAncestorError Revealer a :: Constraint)) => IsRevealer a

Defined in GI.Gtk.Objects.Revealer

IsRevealer Revealer

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.

noRevealer :: Maybe Revealer

A convenience alias for Nothing :: Maybe Revealer.

Methods

getChildRevealed

revealerGetChildRevealed

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> m Bool

Returns: True if the child is fully revealed

Returns whether the child is fully revealed, in other words whether the transition to the revealed state is completed.

Since: 3.10

getRevealChild

revealerGetRevealChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> m Bool

Returns: True if the child is revealed.

Returns whether the child is currently revealed. See revealerSetRevealChild.

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.

Since: 3.10

getTransitionDuration

revealerGetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> m Word32

Returns: the transition duration

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

Since: 3.10

getTransitionType

revealerGetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> m RevealerTransitionType

Returns: the current transition type of revealer

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

Since: 3.10

new

revealerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Revealer

Returns: a newly created Revealer

Creates a new Revealer.

Since: 3.10

setRevealChild

revealerSetRevealChild

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> Bool

revealChild: True to reveal the child

-> m ()

Tells the Revealer to reveal or conceal its child.

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

Since: 3.10

setTransitionDuration

revealerSetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

-> Word32

duration: the new duration, in milliseconds

-> m ()

Sets the duration that transitions will take.

Since: 3.10

setTransitionType

revealerSetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsRevealer a)

=> a

revealer: a Revealer

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

Since: 3.10

Properties

childRevealed

No description available in the introspection data.

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

No description available in the introspection data.

constructRevealerRevealChild :: IsRevealer o => Bool -> IO (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

No description available in the introspection data.

constructRevealerTransitionDuration :: IsRevealer o => Word32 -> IO (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

No description available in the introspection data.

constructRevealerTransitionType :: IsRevealer o => RevealerTransitionType -> IO (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 ]