Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Clutter.Interfaces.Animatable

Contents

Exported types
Methods

Description

Animatable is an opaque structure whose members cannot be directly accessed

Since: 1.0

Synopsis

newtype Animatable = Animatable (ManagedPtr Animatable)
class (GObject o, IsDescendantOf Animatable o) => IsAnimatable o
toAnimatable :: (MonadIO m, IsAnimatable o) => o -> m Animatable
animatableAnimateProperty :: (HasCallStack, MonadIO m, IsAnimatable a, IsAnimation b) => a -> b -> Text -> GValue -> GValue -> Double -> GValue -> m Bool
animatableFindProperty :: (HasCallStack, MonadIO m, IsAnimatable a) => a -> Text -> m GParamSpec
animatableGetInitialState :: (HasCallStack, MonadIO m, IsAnimatable a) => a -> Text -> GValue -> m ()
animatableInterpolateValue :: (HasCallStack, MonadIO m, IsAnimatable a, IsInterval b) => a -> Text -> b -> Double -> m (Bool, GValue)
animatableSetFinalState :: (HasCallStack, MonadIO m, IsAnimatable a) => a -> Text -> GValue -> m ()

Exported types

newtype Animatable Source #

Memory-managed wrapper type.

Constructors

Animatable (ManagedPtr Animatable)

Instances

Instances details

Eq Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable Methods (==) :: Animatable -> Animatable -> Bool # (/=) :: Animatable -> Animatable -> Bool #
GObject Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable
ManagedPtrNewtype Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable Methods toManagedPtr :: Animatable -> ManagedPtr Animatable
TypedObject Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable Methods glibType :: IO GType
HasParentTypes Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable
IsGValue (Maybe Animatable) Source #	Convert `Animatable` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Clutter.Interfaces.Animatable Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Animatable -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Animatable)
type ParentTypes Animatable Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable type ParentTypes Animatable = '[Object]

class (GObject o, IsDescendantOf Animatable o) => IsAnimatable o Source #

Type class for types which can be safely cast to Animatable, for instance with toAnimatable.

Instances

Instances details

(GObject o, IsDescendantOf Animatable o) => IsAnimatable o Source #
Instance details Defined in GI.Clutter.Interfaces.Animatable

toAnimatable :: (MonadIO m, IsAnimatable o) => o -> m Animatable Source #

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

Expand

animateProperty

animatableAnimateProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnimatable a, IsAnimation b)
=> a	`animatable`: a `Animatable`
-> b	`animation`: a `Animation`
-> Text	`propertyName`: the name of the animated property
-> GValue	`initialValue`: the initial value of the animation interval
-> GValue	`finalValue`: the final value of the animation interval
-> Double	`progress`: the progress factor
-> GValue	`value`: return location for the animation value
-> m Bool	Returns: `True` if the value has been validated and can be applied to the `Animatable`, and `False` otherwise

Deprecated: (Since version 1.8)Use animatableInterpolateValue instead

Calls the animate_property() virtual function for animatable.

The initialValue and finalValue Values must contain the same type; value must have been initialized to the same type of initialValue and finalValue.

All implementation of the Animatable interface must implement this function.

Since: 1.0

findProperty

animatableFindProperty Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnimatable a)
=> a	`animatable`: a `Animatable`
-> Text	`propertyName`: the name of the animatable property to find
-> m GParamSpec	Returns: The `ParamSpec` for the given property or `Nothing`

Finds the ParamSpec for propertyName

Since: 1.4

getInitialState

animatableGetInitialState Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnimatable a)
=> a	`animatable`: a `Animatable`
-> Text	`propertyName`: the name of the animatable property to retrieve
-> GValue	`value`: a `Value` initialized to the type of the property to retrieve
-> m ()

Retrieves the current state of propertyName and sets value with it

Since: 1.4

interpolateValue

animatableInterpolateValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnimatable a, IsInterval b)
=> a	`animatable`: a `Animatable`
-> Text	`propertyName`: the name of the property to interpolate
-> b	`interval`: a `Interval` with the animation range
-> Double	`progress`: the progress to use to interpolate between the initial and final values of the `interval`
-> m (Bool, GValue)	Returns: `True` if the interpolation was successful, and `False` otherwise

Asks a Animatable implementation to interpolate a a named property between the initial and final values of a Interval, using progress as the interpolation value, and store the result inside value.

This function should be used for every property animation involving Animatables.

This function replaces animatableAnimateProperty.

Since: 1.8

setFinalState

animatableSetFinalState Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnimatable a)
=> a	`animatable`: a `Animatable`
-> Text	`propertyName`: the name of the animatable property to set
-> GValue	`value`: the value of the animatable property to set
-> m ()

Sets the current state of propertyName to value

Since: 1.4

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

animateProperty

findProperty

getInitialState

interpolateValue

setFinalState