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 Transition
structure contains private
data and should only be accessed using the provided API.
Since: 1.10
Synopsis
- newtype Transition = Transition (ManagedPtr Transition)
- class (GObject o, IsDescendantOf Transition o) => IsTransition o
- toTransition :: (MonadIO m, IsTransition o) => o -> m Transition
- transitionGetAnimatable :: (HasCallStack, MonadIO m, IsTransition a) => a -> m Animatable
- transitionGetInterval :: (HasCallStack, MonadIO m, IsTransition a) => a -> m Interval
- transitionGetRemoveOnComplete :: (HasCallStack, MonadIO m, IsTransition a) => a -> m Bool
- transitionSetAnimatable :: (HasCallStack, MonadIO m, IsTransition a, IsAnimatable b) => a -> Maybe b -> m ()
- transitionSetFrom :: (HasCallStack, MonadIO m, IsTransition a) => a -> GValue -> m ()
- transitionSetInterval :: (HasCallStack, MonadIO m, IsTransition a, IsInterval b) => a -> Maybe b -> m ()
- transitionSetRemoveOnComplete :: (HasCallStack, MonadIO m, IsTransition a) => a -> Bool -> m ()
- transitionSetTo :: (HasCallStack, MonadIO m, IsTransition a) => a -> GValue -> m ()
- clearTransitionAnimatable :: (MonadIO m, IsTransition o) => o -> m ()
- constructTransitionAnimatable :: (IsTransition o, MonadIO m, IsAnimatable a) => a -> m (GValueConstruct o)
- getTransitionAnimatable :: (MonadIO m, IsTransition o) => o -> m Animatable
- setTransitionAnimatable :: (MonadIO m, IsTransition o, IsAnimatable a) => o -> a -> m ()
- clearTransitionInterval :: (MonadIO m, IsTransition o) => o -> m ()
- constructTransitionInterval :: (IsTransition o, MonadIO m, IsInterval a) => a -> m (GValueConstruct o)
- getTransitionInterval :: (MonadIO m, IsTransition o) => o -> m Interval
- setTransitionInterval :: (MonadIO m, IsTransition o, IsInterval a) => o -> a -> m ()
- constructTransitionRemoveOnComplete :: (IsTransition o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTransitionRemoveOnComplete :: (MonadIO m, IsTransition o) => o -> m Bool
- setTransitionRemoveOnComplete :: (MonadIO m, IsTransition o) => o -> Bool -> m ()
Exported types
newtype Transition Source #
Memory-managed wrapper type.
Transition (ManagedPtr Transition) |
Instances
Eq Transition Source # | |
Defined in GI.Clutter.Objects.Transition (==) :: Transition -> Transition -> Bool # (/=) :: Transition -> Transition -> Bool # | |
GObject Transition Source # | |
Defined in GI.Clutter.Objects.Transition | |
ManagedPtrNewtype Transition Source # | |
Defined in GI.Clutter.Objects.Transition toManagedPtr :: Transition -> ManagedPtr Transition | |
TypedObject Transition Source # | |
Defined in GI.Clutter.Objects.Transition | |
HasParentTypes Transition Source # | |
Defined in GI.Clutter.Objects.Transition | |
IsGValue (Maybe Transition) Source # | Convert |
Defined in GI.Clutter.Objects.Transition gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Transition -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Transition) | |
type ParentTypes Transition Source # | |
Defined in GI.Clutter.Objects.Transition |
class (GObject o, IsDescendantOf Transition o) => IsTransition o Source #
Type class for types which can be safely cast to Transition
, for instance with toTransition
.
Instances
(GObject o, IsDescendantOf Transition o) => IsTransition o Source # | |
Defined in GI.Clutter.Objects.Transition |
toTransition :: (MonadIO m, IsTransition o) => o -> m Transition Source #
Cast to Transition
, 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
addMarker, addMarkerAtTime, advance, advanceToMarker, bindProperty, bindPropertyFull, clone, forceFloating, freezeNotify, getv, hasMarker, isFloating, isPlaying, listMarkers, notify, notifyByPspec, parseCustomNode, pause, ref, refSink, removeMarker, rewind, runDispose, skip, start, stealData, stealQdata, stop, thawNotify, unref, watchClosure.
Getters
getAnimatable, getAutoReverse, getCubicBezierProgress, getCurrentRepeat, getData, getDelay, getDelta, getDirection, getDuration, getDurationHint, getElapsedTime, getId, getInterval, getLoop, getProgress, getProgressMode, getProperty, getQdata, getRemoveOnComplete, getRepeatCount, getStepProgress.
Setters
setAnimatable, setAutoReverse, setCubicBezierProgress, setCustomProperty, setData, setDataFull, setDelay, setDirection, setDuration, setFrom, setId, setInterval, setLoop, setProgressFunc, setProgressMode, setProperty, setRemoveOnComplete, setRepeatCount, setStepProgress, setTo.
getAnimatable
transitionGetAnimatable Source #
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> m Animatable | Returns: a |
Retrieves the Animatable
set using transitionSetAnimatable
.
Since: 1.10
getInterval
transitionGetInterval Source #
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> m Interval | Returns: a |
Retrieves the interval set using transitionSetInterval
Since: 1.10
getRemoveOnComplete
transitionGetRemoveOnComplete Source #
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves the value of the Transition:removeOnComplete property.
Since: 1.10
setAnimatable
transitionSetAnimatable Source #
:: (HasCallStack, MonadIO m, IsTransition a, IsAnimatable b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the Transition:animatable property.
The transition
will acquire a reference to the animatable
instance,
and will call the TransitionClass
.attached
() virtual function.
If an existing Animatable
is attached to transition
, the
reference will be released, and the TransitionClass
.detached
()
virtual function will be called.
Since: 1.10
setFrom
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> GValue |
|
-> m () |
Sets the initial value of the transition.
This is a convenience function that will either create the
Interval
used by transition
, or will update it if
the Transition:interval is already set.
This function will copy the contents of value
, so it is
safe to call valueUnset
after it returns.
If transition
already has a Transition:interval set,
then value
must hold the same type, or a transformable type,
as the interval's Interval:valueType property.
This function is meant to be used by language bindings.
Since: 1.12
setInterval
transitionSetInterval Source #
:: (HasCallStack, MonadIO m, IsTransition a, IsInterval b) | |
=> a |
|
-> Maybe b | |
-> m () |
Sets the Transition:interval property using interval
.
The transition
will acquire a reference on the interval
, sinking
the floating flag on it if necessary.
Since: 1.10
setRemoveOnComplete
transitionSetRemoveOnComplete Source #
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether transition
should be detached from the Animatable
set using transitionSetAnimatable
when the
Timeline::completed signal is emitted.
Since: 1.10
setTo
:: (HasCallStack, MonadIO m, IsTransition a) | |
=> a |
|
-> GValue |
|
-> m () |
Sets the final value of the transition.
This is a convenience function that will either create the
Interval
used by transition
, or will update it if
the Transition:interval is already set.
This function will copy the contents of value
, so it is
safe to call valueUnset
after it returns.
If transition
already has a Transition:interval set,
then value
must hold the same type, or a transformable type,
as the interval's Interval:valueType property.
This function is meant to be used by language bindings.
Since: 1.12
Properties
animatable
The Animatable
instance currently being animated.
Since: 1.10
clearTransitionAnimatable :: (MonadIO m, IsTransition o) => o -> m () Source #
Set the value of the “animatable
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#animatable
constructTransitionAnimatable :: (IsTransition o, MonadIO m, IsAnimatable a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “animatable
” property. This is rarely needed directly, but it is used by new
.
getTransitionAnimatable :: (MonadIO m, IsTransition o) => o -> m Animatable Source #
Get the value of the “animatable
” property.
When overloading is enabled, this is equivalent to
get
transition #animatable
setTransitionAnimatable :: (MonadIO m, IsTransition o, IsAnimatable a) => o -> a -> m () Source #
Set the value of the “animatable
” property.
When overloading is enabled, this is equivalent to
set
transition [ #animatable:=
value ]
interval
The Interval
used to describe the initial and final states
of the transition.
Since: 1.10
clearTransitionInterval :: (MonadIO m, IsTransition o) => o -> m () Source #
Set the value of the “interval
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#interval
constructTransitionInterval :: (IsTransition o, MonadIO m, IsInterval a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “interval
” property. This is rarely needed directly, but it is used by new
.
getTransitionInterval :: (MonadIO m, IsTransition o) => o -> m Interval Source #
Get the value of the “interval
” property.
When overloading is enabled, this is equivalent to
get
transition #interval
setTransitionInterval :: (MonadIO m, IsTransition o, IsInterval a) => o -> a -> m () Source #
Set the value of the “interval
” property.
When overloading is enabled, this is equivalent to
set
transition [ #interval:=
value ]
removeOnComplete
Whether the Transition
should be automatically detached
from the Transition:animatable instance whenever the
Timeline::stopped signal is emitted.
The Transition:removeOnComplete property takes into account the value of the Timeline:repeatCount property, and it only detaches the transition if the transition is not repeating.
Since: 1.10
constructTransitionRemoveOnComplete :: (IsTransition o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “remove-on-complete
” property. This is rarely needed directly, but it is used by new
.
getTransitionRemoveOnComplete :: (MonadIO m, IsTransition o) => o -> m Bool Source #
Get the value of the “remove-on-complete
” property.
When overloading is enabled, this is equivalent to
get
transition #removeOnComplete
setTransitionRemoveOnComplete :: (MonadIO m, IsTransition o) => o -> Bool -> m () Source #
Set the value of the “remove-on-complete
” property.
When overloading is enabled, this is equivalent to
set
transition [ #removeOnComplete:=
value ]