Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Revealer

Contents

Exported types
Methods
Properties

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

newtype Revealer = Revealer (ManagedPtr Revealer)
class GObject o => IsRevealer o
toRevealer :: (MonadIO m, IsRevealer o) => o -> m Revealer
noRevealer :: Maybe Revealer
revealerGetChildRevealed :: (HasCallStack, MonadIO m, IsRevealer a) => a -> m Bool
revealerGetRevealChild :: (HasCallStack, MonadIO m, IsRevealer a) => a -> m Bool
revealerGetTransitionDuration :: (HasCallStack, MonadIO m, IsRevealer a) => a -> m Word32
revealerGetTransitionType :: (HasCallStack, MonadIO m, IsRevealer a) => a -> m RevealerTransitionType
revealerNew :: (HasCallStack, MonadIO m) => m Revealer
revealerSetRevealChild :: (HasCallStack, MonadIO m, IsRevealer a) => a -> Bool -> m ()
revealerSetTransitionDuration :: (HasCallStack, MonadIO m, IsRevealer a) => a -> Word32 -> m ()
revealerSetTransitionType :: (HasCallStack, MonadIO m, IsRevealer a) => a -> RevealerTransitionType -> m ()
getRevealerChildRevealed :: (MonadIO m, IsRevealer o) => o -> m Bool
constructRevealerRevealChild :: IsRevealer o => Bool -> IO (GValueConstruct o)
getRevealerRevealChild :: (MonadIO m, IsRevealer o) => o -> m Bool
setRevealerRevealChild :: (MonadIO m, IsRevealer o) => o -> Bool -> m ()
constructRevealerTransitionDuration :: IsRevealer o => Word32 -> IO (GValueConstruct o)
getRevealerTransitionDuration :: (MonadIO m, IsRevealer o) => o -> m Word32
setRevealerTransitionDuration :: (MonadIO m, IsRevealer o) => o -> Word32 -> m ()
constructRevealerTransitionType :: IsRevealer o => RevealerTransitionType -> IO (GValueConstruct o)
getRevealerTransitionType :: (MonadIO m, IsRevealer o) => o -> m RevealerTransitionType
setRevealerTransitionType :: (MonadIO m, IsRevealer o) => o -> RevealerTransitionType -> m ()

Exported types

newtype Revealer Source #

Memory-managed wrapper type.

Constructors

Revealer (ManagedPtr Revealer)

Instances

GObject Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer Methods gobjectType :: Revealer -> IO GType #
IsImplementorIface Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsObject Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsBuildable Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsBin Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsContainer Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsWidget Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsRevealer Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer

class GObject o => IsRevealer o Source #

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

Instances

(GObject a, (UnknownAncestorError Revealer a :: Constraint)) => IsRevealer a Source #
Instance details Defined in GI.Gtk.Objects.Revealer
IsRevealer Revealer Source #
Instance details Defined in GI.Gtk.Objects.Revealer

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

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

noRevealer :: Maybe Revealer Source #

A convenience alias for Nothing :: Maybe Revealer.

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

No description available in the introspection data.

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

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

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

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

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

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

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

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

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

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

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

set revealer [ #transitionType := value ]