Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker Clutter.State

Class Clutter.State

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterState
Class :	State
Implements:	Clutter.Scriptable
Extends:	GObject.Object

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

Properties
Properties		Defined By
	duration : guint32 Default duration used if an duration has not been specified for a specific source/target state pair. Default duration used if an duration has not been specified for a specific source/target state pair. The values is in milliseconds.	Clutter.State
	parent : GObject.Object read only	Clutter.State
	priv : Clutter.StatePrivate read only	Clutter.State
	state : String The currently set target state, setting it causes the state machine to transition to the new state, use clutter_state_change() with a final FALSE argument to change state without a transition. The currently set target state, setting it causes the state machine to transition to the new state, use clutter_state_change() with a final FALSE argument to change state without a transition.	Clutter.State

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.State (Object *properties) Create a new Clutter.State Create a new Clutter.State Parameters: Object properties*
	get_animator (String *source_state_name, String target_state_name) : Clutter.Animator Retrieves the ClutterAnimator* that is being used for transitioning between the two states, if any has been set Retrieves the ClutterAnimator that is being used for transitioning between the two states, if any has been set Parameters: String source_state_name Required (not null) the name of a source state String target_state_name Required (not null) the name of a target state Returns: Clutter.Animator a ClutterAnimator instance, or NULL	Clutter.State
	get_duration (String *source_state_name, String target_state_name) : guint32 Queries the duration used for transitions between a source and target state pair The semantics for the query are the same as the semantics used for setting the duration with clutter_state_set_duration() Queries the duration used for transitions between a source and target state pair The semantics for the query are the same as the semantics used for setting the duration with clutter_state_set_duration() Parameters: String source_state_name* the name of the source state to get the duration of, or NULL String target_state_name the name of the source state to get the duration of, or NULL Returns: guint32 the duration, in milliseconds	Clutter.State
	get_id () : String Retrieves the id of scriptable set using clutter_scriptable_set_id(). Retrieves the id of scriptable set using clutter_scriptable_set_id(). the scriptable object and should never be modified of freed Returns: String the id of the object. The returned string is owned by	Clutter.Scriptable
	get_keys (String *source_state_name, String target_state_name, Object object, String property_name) : Array Returns a list of pointers to opaque structures with accessor functions that describe the keys added to an animator. Returns a list of pointers to opaque structures with accessor functions that describe the keys added to an animator. newly allocated GList* of ClutterStateKeys. The contents of the returned list are owned by the ClutterState and should not be modified or freed. Use g_list_free() to free the resources allocated by the returned list when done using it Parameters: String source_state_name the source transition name to query, or NULL for all source states String target_state_name the target transition name to query, or NULL for all target states GObject.Object object the specific object instance to list keys for, or NULL for all managed objects String property_name the property name to search for, or NULL for all properties. Returns: Array a	Clutter.State
	get_state () : String Queries the currently set target state. Queries the currently set target state. During a transition this function will return the target of the transition. This function is useful when called from handlers of the ClutterState::completed signal. is owned by the ClutterState and should not be modified or freed Returns: String a string containing the target state. The returned string	Clutter.State
	get_states () : Array Gets a list of all the state names managed by this ClutterState. Gets a list of all the state names managed by this ClutterState. GList of state names. The contents of the returned GList are owned by the ClutterState and should not be modified or freed. Use g_list_free() to free the resources allocated by the returned list when done using it Returns: Array a newly allocated	Clutter.State
	get_timeline () : Clutter.Timeline Gets the timeline driving the ClutterState the state change animations. Gets the timeline driving the ClutterState the state change animations. The returned timeline is owned by the ClutterState and it should not be unreferenced directly Returns: Clutter.Timeline the ClutterTimeline that drives	Clutter.State
	parse_custom_node (Script *script, Value value, String name, Node node) : gboolean Parses the passed JSON node. Parses the passed JSON node. The implementation must set the type of the passed GValue* pointer using g_value_init(). Parameters: Clutter.Script script Required (not null) the ClutterScript creating the scriptable instance GObject.Value value Required (not null) the generic value to be set String name Required (not null) the name of the node Json.Node node Required (not null) the JSON node to be parsed Returns: gboolean TRUE if the node was successfully parsed, FALSE otherwise.	Clutter.Scriptable
	remove_key (String *source_state_name, String target_state_name, Object object, String property_name) : none Removes all keys matching the search criteria passed in arguments. Removes all keys matching the search criteria passed in arguments. Parameters: String source_state_name* the source state name to query, or NULL for all source states String target_state_name the target state name to query, or NULL for all target states GObject.Object object the specific object instance to list keys for, or NULL for all managed objects String property_name the property name to search for, or NULL for all properties. Returns: none	Clutter.State
	set_animator (String *source_state_name, String target_state_name, Animator animator) : none Specifies a ClutterAnimator* to be used when transitioning between the two named states. Specifies a ClutterAnimator to be used when transitioning between the two named states. The animator allows specifying a transition between the state that is more elaborate than the basic transitions other allowed by the simple tweening of properties defined in the ClutterState keys. If animator is NULL it will unset an existing animator. ClutterState will take a reference on the passed animator, if any Parameters: String source_state_name Required (not null) the name of a source state String target_state_name Required (not null) the name of a target state Clutter.Animator animator a ClutterAnimator instance, or NULL to unset an existing ClutterAnimator Returns: none	Clutter.State
	set_custom_property (Script *script, String name, Value value) : none Overrides the common properties setting. Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties. Parameters: Clutter.Script script* Required (not null) the ClutterScript creating the scriptable instance String name Required (not null) the name of the property GObject.Value value Required (not null) the value of the property Returns: none	Clutter.Scriptable
	set_duration (String *source_state_name, String target_state_name, guint32 duration) : none Sets the duration of a transition. Sets the duration of a transition. If both state names are NULL* the default duration for state is set. If only target_state_name is specified, the passed duration becomes the default duration for transitions to the target state. If both states names are specified, the passed duration only applies to the specified transition. Parameters: String source_state_name the name of the source state, or NULL String target_state_name the name of the target state, or NULL guint32 duration Required (not null) the duration of the transition, in milliseconds Returns: none	Clutter.State
	set_id (String *id_) : none Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by ClutterScript. Parameters: String id_* Required (not null) Returns: none	Clutter.Scriptable
	set_key (String *source_state_name, String target_state_name, Object object, String property_name, guint32 mode, Value value, gdouble pre_delay, gdouble post_delay) : Clutter.State Sets one specific end key for a state_name, object, property_name combination. Sets one specific end key for a state_name, object, property_name combination. multiple calls Parameters: String source_state_name* Required (not null) the source transition to specify transition for or NULL to specify the default fallback when a more specific source_state doesn't exist. String target_state_name Required (not null) the name of the transition to set a key value for. GObject.Object object Required (not null) the GObject to set a key for String property_name Required (not null) the property to set a key for guint32 mode Required (not null) the id of the alpha function to use GObject.Value value Required (not null) the value for property_name of object in state_name gdouble pre_delay Required (not null) relative time of the transition to be idle in the beginning of the transition gdouble post_delay Required (not null) relative time of the transition to be idle in the end of the transition Returns: Clutter.State the ClutterState instance, allowing chaining of	Clutter.State
	set_state (String *target_state_name) : Clutter.Timeline Change the current state of ClutterState* to target_state_name The state will animate during its transition, see clutter_state_warp_to_state for animation-free state switching. Change the current state of ClutterState to target_state_name The state will animate during its transition, see clutter_state_warp_to_state for animation-free state switching. Parameters: String target_state_name Required (not null) the state to transition to Returns: Clutter.Timeline the ClutterTimeline that drives the state transition	Clutter.State
	warp_to_state (String *target_state_name) : Clutter.Timeline Change the current state of ClutterState* to target_state_name Change to the specified target state immediately with no animation. Change the current state of ClutterState to target_state_name Change to the specified target state immediately with no animation. Parameters: String target_state_name Required (not null) the state to transition to Returns: Clutter.Timeline the ClutterTimeline that drives the state transition	Clutter.State

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	completed (State *self) : none The ::completed signal is emitted when a ClutterState* reaches the target state specified by clutter_state_change() The ::completed signal is emitted when a ClutterState reaches the target state specified by clutter_state_change() Parameters: Clutter.State self Returns: {none}	Clutter.State

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Sat Apr 16 2011 17:09:38 GMT+0800 (HKT)