Clutter.StateKey¶

Fields¶

None

Methods¶

	`get_mode` ()
	`get_object` ()
	`get_post_delay` ()
	`get_pre_delay` ()
	`get_property_name` ()
	`get_property_type` ()
	`get_source_state_name` ()
	`get_target_state_name` ()
	`get_value` (value)

Details¶

class Clutter.StateKey¶

Clutter.StateKey is an opaque structure whose members cannot be accessed directly

New in version 1.4.

get_mode()¶

Returns:: the mode of a Clutter.StateKey
Return type:: int

Retrieves the easing mode used for self.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_object()¶

Returns:: the object this state key applies to.
Return type:: GObject.Object

Retrieves the object instance this Clutter.StateKey applies to.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_post_delay()¶

Returns:: the post delay, used after doing the transition.
Return type:: float

Retrieves the duration of the pause after transitioning is complete as a fraction of the total transition time.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_pre_delay()¶

Returns:: the pre delay used before starting the transition.
Return type:: float

Retrieves the pause before transitioning starts as a fraction of the total transition time.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_property_name()¶

Returns:: the name of the property. The returned string is owned by the Clutter.StateKey and should never be modified or freed
Return type:: str

Retrieves the name of the property this Clutter.StateKey applies to

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_property_type()¶

Returns:: the GObject.GType of the property
Return type:: GObject.GType

Retrieves the GObject.GType of the property a key applies to

You can use this type to initialize the GObject.Value to pass to Clutter.StateKey.get_value()

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_source_state_name()¶

Returns:: the name of the source state for this key, or None if this is the generic state key for the given property when transitioning to the target state. The returned string is owned by the Clutter.StateKey and should never be modified or freed
Return type:: str

Retrieves the name of the source state of the self

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_target_state_name()¶

Returns:: the name of the source state for this key, or None if the key is generic
Return type:: str

Get the name of the source state this Clutter.StateKey contains, or None if this is the generic state key for the given property when transitioning to the target state.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead

get_value(value)¶

Parameters:: value (GObject.Value) – a GObject.Value initialized with the correct type for the self
Returns:: True if the value was successfully retrieved, and False otherwise
Return type:: bool

Retrieves a copy of the value for a Clutter.StateKey.

The GObject.Value needs to be already initialized for the value type of the property or to a type that allow transformation from the value type of the key.

Use GObject.Value.unset() when done.

New in version 1.4.

Deprecated since version 1.12: Use Clutter.KeyframeTransition and Clutter.TransitionGroup instead