GI.Dazzle.Objects.Animation

No description available in the introspection data.

Exported types

newtype Animation

Memory-managed wrapper type.

Constructors

Animation (ManagedPtr Animation)

Instances

Eq Animation

Defined in GI.Dazzle.Objects.Animation

Methods

(==) :: Animation -> Animation -> Bool

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

GObject Animation

Defined in GI.Dazzle.Objects.Animation

ManagedPtrNewtype Animation

Defined in GI.Dazzle.Objects.Animation

Methods

toManagedPtr :: Animation -> ManagedPtr Animation

TypedObject Animation

Defined in GI.Dazzle.Objects.Animation

Methods

glibType :: IO GType

HasParentTypes Animation

Defined in GI.Dazzle.Objects.Animation

IsGValue (Maybe Animation)

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

Defined in GI.Dazzle.Objects.Animation

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Animation

Defined in GI.Dazzle.Objects.Animation

type ParentTypes Animation = '[Object]

class (GObject o, IsDescendantOf Animation o) => IsAnimation o

Type class for types which can be safely cast to Animation, for instance with toAnimation.

Instances

(GObject o, IsDescendantOf Animation o) => IsAnimation o

Defined in GI.Dazzle.Objects.Animation

toAnimation :: (MonadIO m, IsAnimation o) => o -> m Animation

Cast to Animation, 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

addProperty, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, start, stealData, stealQdata, stop, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

addProperty

animationAddProperty

Arguments

:: (HasCallStack, MonadIO m, IsAnimation a)

=> a

animation: A Animation.

-> GParamSpec

pspec: A ParamSpec of target or a Widget's parent.

-> GValue

value: The new value for the property at the end of the animation.

-> m ()

Adds a new property to the set of properties to be animated during the lifetime of the animation.

Side effects: None.

calculateDuration

animationCalculateDuration :: (HasCallStack, MonadIO m, IsMonitor a) => a -> Double -> Double -> m Word32

No description available in the introspection data.

start

animationStart

Arguments

:: (HasCallStack, MonadIO m, IsAnimation a)

=> a

animation: A Animation.

-> m ()

Start the animation. When the animation stops, the internal reference will be dropped and the animation may be finalized.

Side effects: None.

stop

animationStop

Arguments

:: (HasCallStack, MonadIO m, IsAnimation a)

=> Maybe a

animation: A Animation.

-> m ()

Stops a running animation. The internal reference to the animation is dropped and therefore may cause the object to finalize.

As a convenience, this function accepts Nothing for animation but does nothing if that should occur.

Properties

duration

The "duration" property is the total number of milliseconds that the animation should run before being completed.

constructAnimationDuration :: (IsAnimation o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

frameClock

No description available in the introspection data.

constructAnimationFrameClock :: (IsAnimation o, MonadIO m, IsFrameClock a) => a -> m (GValueConstruct o)

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

mode

The "mode" property is the Alpha function that should be used to determine the offset within the animation based on the current offset in the animations duration.

constructAnimationMode :: (IsAnimation o, MonadIO m) => AnimationMode -> m (GValueConstruct o)

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

target

The "target" property is the Object that should have its properties animated.

constructAnimationTarget :: (IsAnimation o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)

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

Signals

tick

type AnimationTickCallback = IO ()

The "tick" signal is emitted on each frame in the animation.

afterAnimationTick :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationTickCallback) -> m SignalHandlerId

Connect a signal handler for the tick signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after animation #tick callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onAnimationTick :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationTickCallback) -> m SignalHandlerId

Connect a signal handler for the tick signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on animation #tick callback