GI.Clutter.Objects.Transition

The Transition structure contains private data and should only be accessed using the provided API.

Since: 1.10

Exported types

newtype Transition

Memory-managed wrapper type.

Constructors

Transition (ManagedPtr Transition)

Instances

Eq Transition

Defined in GI.Clutter.Objects.Transition

Methods

(==) :: Transition -> Transition -> Bool

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

GObject Transition

Defined in GI.Clutter.Objects.Transition

ManagedPtrNewtype Transition

Defined in GI.Clutter.Objects.Transition

Methods

toManagedPtr :: Transition -> ManagedPtr Transition

TypedObject Transition

Defined in GI.Clutter.Objects.Transition

Methods

glibType :: IO GType

HasParentTypes Transition

Defined in GI.Clutter.Objects.Transition

IsGValue (Maybe Transition)

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

Defined in GI.Clutter.Objects.Transition

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Transition

Defined in GI.Clutter.Objects.Transition

type ParentTypes Transition = '[Timeline, Object, Scriptable]

class (GObject o, IsDescendantOf Transition o) => IsTransition o

Type class for types which can be safely cast to Transition, for instance with toTransition.

Instances

(GObject o, IsDescendantOf Transition o) => IsTransition o

Defined in GI.Clutter.Objects.Transition

toTransition :: (MonadIO m, IsTransition o) => o -> m Transition

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

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> m Animatable

Returns: a Animatable, or Nothing; the returned animatable is owned by the Transition, and it should not be freed directly.

Retrieves the Animatable set using transitionSetAnimatable.

Since: 1.10

getInterval

transitionGetInterval

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> m Interval

Returns: a Interval, or Nothing; the returned interval is owned by the Transition and it should not be freed directly

Retrieves the interval set using transitionSetInterval

Since: 1.10

getRemoveOnComplete

transitionGetRemoveOnComplete

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> m Bool

Returns: True if the transition should be detached when complete, and False otherwise

Retrieves the value of the Transition:remove-on-complete property.

Since: 1.10

setAnimatable

transitionSetAnimatable

Arguments

:: (HasCallStack, MonadIO m, IsTransition a, IsAnimatable b)

=> a

transition: a Transition

-> Maybe b

animatable: a Animatable, or Nothing

-> 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

transitionSetFrom

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> GValue

value: a Value with the initial value of the transition

-> 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:value-type property.

This function is meant to be used by language bindings.

Since: 1.12

setInterval

transitionSetInterval

Arguments

:: (HasCallStack, MonadIO m, IsTransition a, IsInterval b)

=> a

transition: a Transition

-> Maybe b

interval: a Interval, or Nothing

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> Bool

removeComplete: whether to detach transition when complete

-> m ()

Sets whether transition should be detached from the Animatable set using transitionSetAnimatable when the completed signal is emitted.

Since: 1.10

setTo

transitionSetTo

Arguments

:: (HasCallStack, MonadIO m, IsTransition a)

=> a

transition: a Transition

-> GValue

value: a Value with the final value of the transition

-> 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:value-type 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 ()

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)

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

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 ()

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 ()

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)

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

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 ()

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 stopped signal is emitted.

The Transition:remove-on-complete property takes into account the value of the Timeline:repeat-count 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)

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

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 ()

Set the value of the “remove-on-complete” property. When overloading is enabled, this is equivalent to

set transition [ #removeOnComplete := value ]