Clutter.Transition¶
- Subclasses:
Methods¶
- Inherited:
Clutter.Timeline (39), GObject.Object (37), Clutter.Scriptable (4)
- Structs:
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Clutter.Timeline (6), GObject.Object (7), Clutter.Scriptable (4)
|
|
|
|
|
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
The animatable object |
||
r/w |
The interval of values to transition |
||
r/w |
Detach the transition when completed |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_instance |
r |
Class Details¶
- class Clutter.Transition(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
The
Clutter.Transition
structure contains private data and should only be accessed using the provided API.New in version 1.10.
- get_animatable()¶
- Returns:
a
Clutter.Animatable
, orNone
; the returned animatable is owned by theClutter.Transition
, and it should not be freed directly.- Return type:
Retrieves the
Clutter.Animatable
set usingClutter.Transition.set_animatable
().New in version 1.10.
- get_interval()¶
- Returns:
a
Clutter.Interval
, orNone
; the returned interval is owned by theClutter.Transition
and it should not be freed directly- Return type:
Retrieves the interval set using
Clutter.Transition.set_interval
()New in version 1.10.
- get_remove_on_complete()¶
-
Retrieves the value of the
Clutter.Transition
:remove-on-complete
property.New in version 1.10.
- set_animatable(animatable)¶
- Parameters:
animatable (
Clutter.Animatable
orNone
) – aClutter.Animatable
, orNone
Sets the
Clutter.Transition
:animatable
property.The self will acquire a reference to the animatable instance, and will call the
Clutter.Transition.do_attached
() virtual function.If an existing
Clutter.Animatable
is attached to self, the reference will be released, and theClutter.Transition.do_detached
() virtual function will be called.New in version 1.10.
- set_from(value)¶
- Parameters:
value (
GObject.Value
) – aGObject.Value
with the initial value of the transition
Sets the initial value of the transition.
This is a convenience function that will either create the
Clutter.Interval
used by self, or will update it if theClutter.Transition
:interval
is already set.This function will copy the contents of value, so it is safe to call
GObject.Value.unset
() after it returns.If self already has a
Clutter.Transition
:interval
set, then value must hold the same type, or a transformable type, as the interval’sClutter.Interval
:value-type
property.This function is meant to be used by language bindings.
New in version 1.12.
- set_interval(interval)¶
- Parameters:
interval (
Clutter.Interval
orNone
) – aClutter.Interval
, orNone
Sets the
Clutter.Transition
:interval
property using interval.The self will acquire a reference on the interval, sinking the floating flag on it if necessary.
New in version 1.10.
- set_remove_on_complete(remove_complete)¶
- Parameters:
remove_complete (
bool
) – whether to detach self when complete
Sets whether self should be detached from the
Clutter.Animatable
set usingClutter.Transition.set_animatable
() when theClutter.Timeline
::completed
signal is emitted.New in version 1.10.
- set_to(value)¶
- Parameters:
value (
GObject.Value
) – aGObject.Value
with the final value of the transition
Sets the final value of the transition.
This is a convenience function that will either create the
Clutter.Interval
used by self, or will update it if theClutter.Transition
:interval
is already set.This function will copy the contents of value, so it is safe to call
GObject.Value.unset
() after it returns.If self already has a
Clutter.Transition
:interval
set, then value must hold the same type, or a transformable type, as the interval’sClutter.Interval
:value-type
property.This function is meant to be used by language bindings.
New in version 1.12.
- do_attached(animatable) virtual¶
- Parameters:
animatable (
Clutter.Animatable
) –
- do_compute_value(animatable, interval, progress) virtual¶
- Parameters:
animatable (
Clutter.Animatable
) –interval (
Clutter.Interval
) –progress (
float
) –
- do_detached(animatable) virtual¶
- Parameters:
animatable (
Clutter.Animatable
) –
Property Details¶
- Clutter.Transition.props.animatable¶
- Name:
animatable
- Type:
- Default Value:
- Flags:
The
Clutter.Animatable
instance currently being animated.New in version 1.10.
- Clutter.Transition.props.interval¶
- Name:
interval
- Type:
- Default Value:
- Flags:
The
Clutter.Interval
used to describe the initial and final states of the transition.New in version 1.10.
- Clutter.Transition.props.remove_on_complete¶
-
Whether the
Clutter.Transition
should be automatically detached from theClutter.Transition
:animatable
instance whenever theClutter.Timeline
::stopped
signal is emitted.The
Clutter.Transition
:remove-on-complete
property takes into account the value of theClutter.Timeline
:repeat-count
property, and it only detaches the transition if the transition is not repeating.New in version 1.10.