Copyright	(c) 2023 Ruslan Gadeev Francisco Vallarino
License	BSD-3-Clause (see the LICENSE file)
Maintainer	fjvallarino@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Monomer.Widgets.Animation.Wipe

Contents

Configuration
Constructors

Description

Wipe animation widget. Wraps a child widget whose content will be animated.

Messages:

Accepts a AnimationMsg, used to control the state of the animation.

Synopsis

data WipeCfg s e
wipeLeft :: WipeCfg s e
wipeRight :: WipeCfg s e
wipeTop :: WipeCfg s e
wipeBottom :: WipeCfg s e
wipeDoorH :: WipeCfg s e
wipeDoorV :: WipeCfg s e
wipeRect :: WipeCfg s e
animWipeIn :: WidgetEvent e => WidgetNode s e -> WidgetNode s e
animWipeIn_ :: WidgetEvent e => [WipeCfg s e] -> WidgetNode s e -> WidgetNode s e
animWipeOut :: WidgetEvent e => WidgetNode s e -> WidgetNode s e
animWipeOut_ :: WidgetEvent e => [WipeCfg s e] -> WidgetNode s e -> WidgetNode s e

Configuration

data WipeCfg s e Source #

Configuration options for wipe:

autoStart: whether the first time the widget is added, animation should run.
duration: how long the animation lasts in ms.
onFinished: event to raise when animation is complete.
onFinishedReq: WidgetRequest to generate when animation is complete.
Individual combinators for direction.

Instances

Instances details

Monoid (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods mempty :: WipeCfg s e # mappend :: WipeCfg s e -> WipeCfg s e -> WipeCfg s e # mconcat :: [WipeCfg s e] -> WipeCfg s e #
Semigroup (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods (<>) :: WipeCfg s e -> WipeCfg s e -> WipeCfg s e # sconcat :: NonEmpty (WipeCfg s e) -> WipeCfg s e # stimes :: Integral b => b -> WipeCfg s e -> WipeCfg s e #
Show (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods showsPrec :: Int -> WipeCfg s e -> ShowS # show :: WipeCfg s e -> String # showList :: [WipeCfg s e] -> ShowS #
Default (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods def :: WipeCfg s e #
Eq e => Eq (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods (==) :: WipeCfg s e -> WipeCfg s e -> Bool # (/=) :: WipeCfg s e -> WipeCfg s e -> Bool #
CmbAutoStart (WipeCfg s e) Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods autoStart :: WipeCfg s e Source # autoStart_ :: Bool -> WipeCfg s e Source #
CmbDuration (WipeCfg s e) Millisecond Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods duration :: Millisecond -> WipeCfg s e Source #
WidgetEvent e => CmbOnFinished (WipeCfg s e) e Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods onFinished :: e -> WipeCfg s e Source #
CmbOnFinishedReq (WipeCfg s e) s e Source #
Instance details Defined in Monomer.Widgets.Animation.Wipe Methods onFinishedReq :: WidgetRequest s e -> WipeCfg s e Source #

wipeLeft :: WipeCfg s e Source #

Wipe from/to left.

wipeRight :: WipeCfg s e Source #

Wipe from/to right.

wipeTop :: WipeCfg s e Source #

Wipe from/to top.

wipeBottom :: WipeCfg s e Source #

Wipe from/to bottom.

wipeDoorH :: WipeCfg s e Source #

Wipe horizontally in a door shape.

wipeDoorV :: WipeCfg s e Source #

Wipe vertically in a door shape.

wipeRect :: WipeCfg s e Source #

Wipe in a rectangle shape.

Constructors

animWipeIn Source #

Arguments

:: WidgetEvent e
=> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget from the left to fully visible.

animWipeIn_ Source #

Arguments

:: WidgetEvent e
=> [WipeCfg s e]	The config options.
-> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget from the provided direction to fully visible (defaults to left). Accepts config.

animWipeOut Source #

Arguments

:: WidgetEvent e
=> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget to the left from visible to not visible.

animWipeOut_ Source #

Arguments

:: WidgetEvent e
=> [WipeCfg s e]	The config options.
-> WidgetNode s e	The child node.
-> WidgetNode s e	The created animation container.

Animates a widget to the provided direction from visible to not visible (defaults to left). Accepts config.