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 |
The Animation
structure contains only private data and should
be accessed using the provided functions.
Since: 1.0
Synopsis
- newtype Animation = Animation (ManagedPtr Animation)
- class (GObject o, IsDescendantOf Animation o) => IsAnimation o
- toAnimation :: (MonadIO m, IsAnimation o) => o -> m Animation
- animationBind :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Text -> GValue -> m Animation
- animationBindInterval :: (HasCallStack, MonadIO m, IsAnimation a, IsInterval b) => a -> Text -> b -> m Animation
- animationCompleted :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m ()
- animationGetAlpha :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m Alpha
- animationGetDuration :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m Word32
- animationGetInterval :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Text -> m Interval
- animationGetLoop :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m Bool
- animationGetMode :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m CULong
- animationGetObject :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m Object
- animationGetTimeline :: (HasCallStack, MonadIO m, IsAnimation a) => a -> m Timeline
- animationHasProperty :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Text -> m Bool
- animationNew :: (HasCallStack, MonadIO m) => m Animation
- animationSetAlpha :: (HasCallStack, MonadIO m, IsAnimation a, IsAlpha b) => a -> b -> m ()
- animationSetDuration :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Word32 -> m ()
- animationSetLoop :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Bool -> m ()
- animationSetMode :: (HasCallStack, MonadIO m, IsAnimation a) => a -> CULong -> m ()
- animationSetObject :: (HasCallStack, MonadIO m, IsAnimation a, IsObject b) => a -> b -> m ()
- animationSetTimeline :: (HasCallStack, MonadIO m, IsAnimation a, IsTimeline b) => a -> Maybe b -> m ()
- animationUnbindProperty :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Text -> m ()
- animationUpdate :: (HasCallStack, MonadIO m, IsAnimation a) => a -> Text -> GValue -> m Animation
- animationUpdateInterval :: (HasCallStack, MonadIO m, IsAnimation a, IsInterval b) => a -> Text -> b -> m ()
- constructAnimationAlpha :: (IsAnimation o, MonadIO m, IsAlpha a) => a -> m (GValueConstruct o)
- getAnimationAlpha :: (MonadIO m, IsAnimation o) => o -> m Alpha
- setAnimationAlpha :: (MonadIO m, IsAnimation o, IsAlpha a) => o -> a -> m ()
- constructAnimationDuration :: (IsAnimation o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getAnimationDuration :: (MonadIO m, IsAnimation o) => o -> m Word32
- setAnimationDuration :: (MonadIO m, IsAnimation o) => o -> Word32 -> m ()
- constructAnimationLoop :: (IsAnimation o, MonadIO m) => Bool -> m (GValueConstruct o)
- getAnimationLoop :: (MonadIO m, IsAnimation o) => o -> m Bool
- setAnimationLoop :: (MonadIO m, IsAnimation o) => o -> Bool -> m ()
- constructAnimationMode :: (IsAnimation o, MonadIO m) => CULong -> m (GValueConstruct o)
- getAnimationMode :: (MonadIO m, IsAnimation o) => o -> m CULong
- setAnimationMode :: (MonadIO m, IsAnimation o) => o -> CULong -> m ()
- constructAnimationObject :: (IsAnimation o, MonadIO m, IsObject a) => a -> m (GValueConstruct o)
- getAnimationObject :: (MonadIO m, IsAnimation o) => o -> m Object
- setAnimationObject :: (MonadIO m, IsAnimation o, IsObject a) => o -> a -> m ()
- clearAnimationTimeline :: (MonadIO m, IsAnimation o) => o -> m ()
- constructAnimationTimeline :: (IsAnimation o, MonadIO m, IsTimeline a) => a -> m (GValueConstruct o)
- getAnimationTimeline :: (MonadIO m, IsAnimation o) => o -> m Timeline
- setAnimationTimeline :: (MonadIO m, IsAnimation o, IsTimeline a) => o -> a -> m ()
- type AnimationCompletedCallback = IO ()
- afterAnimationCompleted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationCompletedCallback) -> m SignalHandlerId
- onAnimationCompleted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationCompletedCallback) -> m SignalHandlerId
- type AnimationStartedCallback = IO ()
- afterAnimationStarted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationStartedCallback) -> m SignalHandlerId
- onAnimationStarted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationStartedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Animation Source # | |
GObject Animation Source # | |
Defined in GI.Clutter.Objects.Animation | |
ManagedPtrNewtype Animation Source # | |
Defined in GI.Clutter.Objects.Animation toManagedPtr :: Animation -> ManagedPtr Animation | |
TypedObject Animation Source # | |
Defined in GI.Clutter.Objects.Animation | |
HasParentTypes Animation Source # | |
Defined in GI.Clutter.Objects.Animation | |
IsGValue (Maybe Animation) Source # | Convert |
Defined in GI.Clutter.Objects.Animation gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Animation -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Animation) | |
type ParentTypes Animation Source # | |
Defined in GI.Clutter.Objects.Animation |
class (GObject o, IsDescendantOf Animation o) => IsAnimation o Source #
Type class for types which can be safely cast to Animation
, for instance with toAnimation
.
Instances
(GObject o, IsDescendantOf Animation o) => IsAnimation o Source # | |
Defined in GI.Clutter.Objects.Animation |
toAnimation :: (MonadIO m, IsAnimation o) => o -> m Animation Source #
Methods
Click to display all available methods, including inherited ones
Methods
bind, bindInterval, bindProperty, bindPropertyFull, completed, forceFloating, freezeNotify, getv, hasProperty, isFloating, notify, notifyByPspec, parseCustomNode, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unbindProperty, unref, update, updateInterval, watchClosure.
Getters
getAlpha, getData, getDuration, getId, getInterval, getLoop, getMode, getObject, getProperty, getQdata, getTimeline.
Setters
setAlpha, setCustomProperty, setData, setDataFull, setDuration, setId, setLoop, setMode, setObject, setProperty, setTimeline.
bind
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Text |
|
-> GValue |
|
-> m Animation | Returns: The animation itself. |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Adds a single property with name propertyName
to the
animation animation
. For more information about animations,
see clutter_actor_animate()
.
This method returns the animation primarily to make chained calls convenient in language bindings.
Since: 1.0
bindInterval
animationBindInterval Source #
:: (HasCallStack, MonadIO m, IsAnimation a, IsInterval b) | |
=> a |
|
-> Text |
|
-> b |
|
-> m Animation | Returns: The animation itself. |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Binds interval
to the propertyName
of the Object
attached to animation
. The Animation
will take
ownership of the passed Interval
. For more information
about animations, see clutter_actor_animate()
.
If you need to update the interval instance use
animationUpdateInterval
instead.
Since: 1.0
completed
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Emits the completed signal on animation
When using this function with a Animation
created
by the clutter_actor_animate()
family of functions, animation
will be unreferenced and it will not be valid anymore,
unless objectRef
was called before calling this function
or unless a reference was taken inside a handler for the
Animation::completed signal
Since: 1.0
getAlpha
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m Alpha | Returns: the alpha object used by the animation |
Deprecated: (Since version 1.10)Use animationGetTimeline
and timelineGetProgressMode
instead.
Retrieves the Alpha
used by animation
.
Since: 1.0
getDuration
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m Word32 | Returns: the duration of the animation |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves the duration of animation
, in milliseconds.
Since: 1.0
getInterval
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Text |
|
-> m Interval | Returns: a |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves the Interval
associated to propertyName
inside animation
.
Since: 1.0
getLoop
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves whether animation
is looping.
Since: 1.0
getMode
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m CULong | Returns: the mode for the animation |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves the animation mode of animation
, as set by
animationSetMode
.
Since: 1.0
getObject
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m Object | Returns: a |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves the Object
attached to animation
.
Since: 1.0
getTimeline
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> m Timeline | Returns: the timeline used by the animation |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Retrieves the Timeline
used by animation
Since: 1.0
hasProperty
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Checks whether animation
is controlling propertyName
.
Since: 1.0
new
:: (HasCallStack, MonadIO m) | |
=> m Animation | Returns: the newly created |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Creates a new Animation
instance. You should set the
Object
to be animated using animationSetObject
,
set the duration with animationSetDuration
and the
easing mode using animationSetMode
.
Use animationBind
or animationBindInterval
to define the properties to be animated. The interval and the
animated properties can be updated at runtime.
The clutter_actor_animate()
and relative family of functions provide
an easy way to animate a Actor
and automatically manage the
lifetime of a Animation
instance, so you should consider using
those functions instead of manually creating an animation.
Since: 1.0
setAlpha
:: (HasCallStack, MonadIO m, IsAnimation a, IsAlpha b) | |
=> a |
|
-> b | |
-> m () |
Deprecated: (Since version 1.10)Use animationGetTimeline
and timelineSetProgressMode
instead.
Sets alpha
as the Alpha
used by animation
.
If alpha
is not Nothing
, the Animation
will take ownership
of the Alpha
instance.
Since: 1.0
setDuration
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Word32 |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Sets the duration of animation
in milliseconds.
This function will set Animation:alpha and Animation:timeline if needed.
Since: 1.0
setLoop
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Sets whether animation
should loop over itself once finished.
A looping Animation
will not emit the Animation::completed
signal when finished.
This function will set Animation:alpha and Animation:timeline if needed.
Since: 1.0
setMode
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> CULong |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Sets the animation mode
of animation
. The animation mode
is
a logical id, either coming from the AnimationMode
enumeration
or the return value of clutter_alpha_register_func()
.
This function will also set Animation:alpha if needed.
Since: 1.0
setObject
:: (HasCallStack, MonadIO m, IsAnimation a, IsObject b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Attaches animation
to object
. The Animation
will take a
reference on object
.
Since: 1.0
setTimeline
:: (HasCallStack, MonadIO m, IsAnimation a, IsTimeline b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Sets the Timeline
used by animation
.
This function will take a reference on the passed timeline
.
Since: 1.0
unbindProperty
animationUnbindProperty Source #
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Removes propertyName
from the list of animated properties.
Since: 1.0
update
:: (HasCallStack, MonadIO m, IsAnimation a) | |
=> a |
|
-> Text |
|
-> GValue |
|
-> m Animation | Returns: The animation itself. |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Updates the final
value of the interval for propertyName
Since: 1.0
updateInterval
animationUpdateInterval Source #
:: (HasCallStack, MonadIO m, IsAnimation a, IsInterval b) | |
=> a |
|
-> Text |
|
-> b |
|
-> m () |
Deprecated: (Since version 1.12)Use PropertyTransition
instead
Changes the interval
for propertyName
. The Animation
will take ownership of the passed Interval
.
Since: 1.0
Properties
alpha
The Alpha
used by the animation.
Since: 1.0
constructAnimationAlpha :: (IsAnimation o, MonadIO m, IsAlpha a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “alpha
” property. This is rarely needed directly, but it is used by new
.
getAnimationAlpha :: (MonadIO m, IsAnimation o) => o -> m Alpha Source #
Get the value of the “alpha
” property.
When overloading is enabled, this is equivalent to
get
animation #alpha
setAnimationAlpha :: (MonadIO m, IsAnimation o, IsAlpha a) => o -> a -> m () Source #
Set the value of the “alpha
” property.
When overloading is enabled, this is equivalent to
set
animation [ #alpha:=
value ]
duration
The duration of the animation, expressed in milliseconds.
Since: 1.0
constructAnimationDuration :: (IsAnimation o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “duration
” property. This is rarely needed directly, but it is used by new
.
getAnimationDuration :: (MonadIO m, IsAnimation o) => o -> m Word32 Source #
Get the value of the “duration
” property.
When overloading is enabled, this is equivalent to
get
animation #duration
setAnimationDuration :: (MonadIO m, IsAnimation o) => o -> Word32 -> m () Source #
Set the value of the “duration
” property.
When overloading is enabled, this is equivalent to
set
animation [ #duration:=
value ]
loop
Whether the animation should loop.
Since: 1.0
constructAnimationLoop :: (IsAnimation o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “loop
” property. This is rarely needed directly, but it is used by new
.
getAnimationLoop :: (MonadIO m, IsAnimation o) => o -> m Bool Source #
Get the value of the “loop
” property.
When overloading is enabled, this is equivalent to
get
animation #loop
setAnimationLoop :: (MonadIO m, IsAnimation o) => o -> Bool -> m () Source #
Set the value of the “loop
” property.
When overloading is enabled, this is equivalent to
set
animation [ #loop:=
value ]
mode
The animation mode, either a value from AnimationMode
or a value returned by clutter_alpha_register_func()
. The
default value is AnimationModeLinear
.
Since: 1.0
constructAnimationMode :: (IsAnimation o, MonadIO m) => CULong -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “mode
” property. This is rarely needed directly, but it is used by new
.
getAnimationMode :: (MonadIO m, IsAnimation o) => o -> m CULong Source #
Get the value of the “mode
” property.
When overloading is enabled, this is equivalent to
get
animation #mode
setAnimationMode :: (MonadIO m, IsAnimation o) => o -> CULong -> m () Source #
Set the value of the “mode
” property.
When overloading is enabled, this is equivalent to
set
animation [ #mode:=
value ]
object
The Object
to which the animation applies.
Since: 1.0
constructAnimationObject :: (IsAnimation o, MonadIO m, IsObject a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “object
” property. This is rarely needed directly, but it is used by new
.
getAnimationObject :: (MonadIO m, IsAnimation o) => o -> m Object Source #
Get the value of the “object
” property.
When overloading is enabled, this is equivalent to
get
animation #object
setAnimationObject :: (MonadIO m, IsAnimation o, IsObject a) => o -> a -> m () Source #
Set the value of the “object
” property.
When overloading is enabled, this is equivalent to
set
animation [ #object:=
value ]
timeline
The Timeline
used by the animation.
Since: 1.0
clearAnimationTimeline :: (MonadIO m, IsAnimation o) => o -> m () Source #
Set the value of the “timeline
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#timeline
constructAnimationTimeline :: (IsAnimation o, MonadIO m, IsTimeline a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “timeline
” property. This is rarely needed directly, but it is used by new
.
getAnimationTimeline :: (MonadIO m, IsAnimation o) => o -> m Timeline Source #
Get the value of the “timeline
” property.
When overloading is enabled, this is equivalent to
get
animation #timeline
setAnimationTimeline :: (MonadIO m, IsAnimation o, IsTimeline a) => o -> a -> m () Source #
Set the value of the “timeline
” property.
When overloading is enabled, this is equivalent to
set
animation [ #timeline:=
value ]
Signals
completed
type AnimationCompletedCallback = IO () Source #
Deprecated: (Since version 1.12)Use PropertyTransition
instead
The completed signal is emitted once the animation has been completed.
The animation
instance is guaranteed to be valid for the entire
duration of the signal emission chain.
Since: 1.0
afterAnimationCompleted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationCompletedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the completed signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
animation #completed 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.
onAnimationCompleted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationCompletedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the completed signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
animation #completed callback
started
type AnimationStartedCallback = IO () Source #
Deprecated: (Since version 1.12)Use PropertyTransition
instead
The started signal is emitted once the animation has been started
Since: 1.0
afterAnimationStarted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationStartedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the started signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
animation #started 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.
onAnimationStarted :: (IsAnimation a, MonadIO m) => a -> ((?self :: a) => AnimationStartedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the started signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
animation #started callback