gi-gtk-3.0.17: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.Revealer

Contents

Description

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.

Synopsis

Exported types

Methods

getChildRevealed

revealerGetChildRevealed Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Revealer

Returns: a newly created Revealer

Creates a new Revealer.

Since: 3.10

setRevealChild

revealerSetRevealChild Source #

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 Source #

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 Source #

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

revealChild

transitionDuration

transitionType