Module: Clutter::Scriptable

Defined in:

(unknown)

Overview

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

Instance Method Summary

• #get_id(scriptable) ⇒ String

  The id of the object.

• #id ⇒ String

  Retrieves the id of scriptable set using clutter_scriptable_set_id().

• #id=(id_) ⇒ nil

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

• #parse_custom_node(scriptable, script, value, name, node) ⇒ Boolean

  True if the node was successfully parsed, false otherwise.

• #set_custom_property(scriptable, script, name, value) ⇒ nil
• #set_id(scriptable, id_) ⇒ nil

Instance Method Details

#get_id(scriptable) ⇒ String

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

Parameters:

• scriptable (Clutter::Scriptable) —

  a Clutter::Scriptable

Returns:

• (String) —

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

#id ⇒ String

Retrieves the id of scriptable set using clutter_scriptable_set_id().

Returns:

• (String) —

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

#id=(id_) ⇒ nil

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.

Parameters:

• id_ (String) —

  the Clutter::Script id of the object

Returns:

• (nil)

#parse_custom_node(scriptable, script, value, name, node) ⇒ Boolean

Returns true if the node was successfully parsed, false otherwise.

Parameters:

• scriptable (Clutter::Scriptable) —

  a Clutter::Scriptable

• script (Clutter::Script) —

  the Clutter::Script creating the scriptable instance

• value (GObject::Value) —

  the generic value to be set

• name (String) —

  the name of the node

• node (Json::Node) —

  the JSON node to be parsed

Returns:

• (Boolean) —

  true if the node was successfully parsed, false otherwise.

#set_custom_property(scriptable, script, name, value) ⇒ nil

Parameters:

• scriptable (Clutter::Scriptable) —

  a Clutter::Scriptable

• script (Clutter::Script) —

  the Clutter::Script creating the scriptable instance

• name (String) —

  the name of the property

• value (GObject::Value) —

  the value of the property

Returns:

• (nil)

#set_id(scriptable, id_) ⇒ nil

Parameters:

• scriptable (Clutter::Scriptable) —

  a Clutter::Scriptable

• id_ (String) —

  the Clutter::Script id of the object

Returns:

• (nil)