Clutter.Scriptable

g Clutter.Scriptable Clutter.Scriptable GObject.GInterface GObject.GInterface GObject.GInterface->Clutter.Scriptable

Implementations:

Clutter.Actor, Clutter.Alpha, Clutter.Animation, Clutter.Animator, Clutter.Behaviour, Clutter.Interval, Clutter.Model, Clutter.State, Clutter.Timeline

Methods

get_id ()

parse_custom_node (script, value, name, node)

set_custom_property (script, name, value)

set_id (id_)

Virtual Methods

do_get_id ()

do_parse_custom_node (script, value, name, node)

do_set_custom_property (script, name, value)

do_set_id (id_)

Properties

None

Signals

None

Fields

None

Class Details

class Clutter.Scriptable
Bases:

GObject.GInterface

Structure:

Clutter.ScriptableIface

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

New in version 0.6.

get_id()
Returns:

the id of the object. The returned string is owned by the scriptable object and should never be modified of freed

Return type:

str

Retrieves the id of self set using Clutter.Scriptable.set_id().

New in version 0.6.

parse_custom_node(script, value, name, node)
Parameters:
Returns:

True if the node was successfully parsed, False otherwise.

Return type:

bool

Parses the passed JSON node. The implementation must set the type of the passed GObject.Value pointer using GObject.Value.init().

New in version 0.6.

set_custom_property(script, name, value)
Parameters:

Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

New in version 0.6.

set_id(id_)
Parameters:

id (str) – the Clutter.Script id of the object

Sets id_ as the unique Clutter script it for this instance of Clutter.ScriptableIface.

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 Clutter.Script.

New in version 0.6.

do_get_id() virtual
Returns:

the id of the object. The returned string is owned by the scriptable object and should never be modified of freed

Return type:

str

Retrieves the id of scriptable set using Clutter.Scriptable.set_id().

New in version 0.6.

do_parse_custom_node(script, value, name, node) virtual
Parameters:
Returns:

True if the node was successfully parsed, False otherwise.

Return type:

bool

Parses the passed JSON node. The implementation must set the type of the passed GObject.Value pointer using GObject.Value.init().

New in version 0.6.

do_set_custom_property(script, name, value) virtual
Parameters:

Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

New in version 0.6.

do_set_id(id_) virtual
Parameters:

id (str) – the Clutter.Script id of the object

Sets id_ as the unique Clutter script it for this instance of Clutter.ScriptableIface.

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 Clutter.Script.

New in version 0.6.