Clutter.Script
Description: Reference for Clutter.Script

### Class

# ClutterScript

#### Description [src]

    class Clutter.Script : GObject.Object {
      /* No available fields */
    }

The `ClutterScript` structure contains only private data and should be accessed using the provided API.

Available since: | 0.6

#### Ancestors

- GObject

#### Constructors

###### clutter_script_new

Creates a new `ClutterScript` instance. `ClutterScript` can be used to load objects definitions for scenegraph elements, like actors, or behavioural elements, like timelines. The definitions must be encoded using the JavaScript Object Notation (JSON) language.

Available since: 0.6

#### Instance methods

###### clutter_script_add_search_paths

Adds `paths` to the list of search paths held by `script`.

Available since: 0.8

###### clutter_script_connect_signals

Connects all the signals defined into a UI definition file to their handlers.

Available since: 0.6

###### clutter_script_connect_signals_full

Connects all the signals defined into a UI definition file to their handlers.

Available since: 0.6

###### clutter_script_ensure_objects

Ensure that every object defined inside `script` is correctly constructed. You should rarely need to use this function.

Available since: 0.6

###### clutter_script_get_object

Retrieves the object bound to `name`. This function does not increment the reference count of the returned object.

Available since: 0.6

###### clutter_script_get_objects

Retrieves a list of objects for the given names. After `script`, object names/return location pairs should be listed, with a `NULL` pointer ending the list, like:

Available since: 0.6

###### clutter_script_get_translation_domain

Retrieves the translation domain set using clutter_script_set_translation_domain().

Available since: 1.10

###### clutter_script_get_type_from_name

Looks up a type by name, using the virtual function that `ClutterScript` has for that purpose. This function should rarely be used.

Available since: 0.6

###### clutter_script_list_objects

Retrieves all the objects created by `script`.

Available since: 0.8

###### clutter_script_load_from_data

Loads the definitions from `data` into `script` and merges with the currently loaded ones, if any.

Available since: 0.6

###### clutter_script_load_from_file

Loads the definitions from `filename` into `script` and merges with the currently loaded ones, if any.

Available since: 0.6

###### clutter_script_load_from_resource

Loads the definitions from a resource file into `script` and merges with the currently loaded ones, if any.

Available since: 1.10

###### clutter_script_lookup_filename

Looks up `filename` inside the search paths of `script`. If `filename` is found, its full path will be returned .

Available since: 0.8

###### clutter_script_set_translation_domain

Sets the translation domain for `script`.

Available since: 1.10

###### clutter_script_unmerge_objects

Unmerges the objects identified by `merge_id`.

Available since: 0.6

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Clutter.Script:filename

The path of the currently parsed file. If `ClutterScript:filename-set` is `FALSE` then the value of this property is undefined.

Available since: 0.6

###### Clutter.Script:filename-set

Whether the `ClutterScript:filename` property is set. If this property is `TRUE` then the currently parsed data comes from a file, and the file name is stored inside the `ClutterScript:filename` property.

Available since: 0.6

###### Clutter.Script:translation-domain

The translation domain, used to localize strings marked as translatable inside a UI definition.

Available since: 1.10

#### Signals

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct ClutterScriptClass {
      GType (* get_type_from_name) (
        ClutterScript* script,
        const gchar* type_name
      );
      void (* _clutter_reserved1) (
    void
      );
      void (* _clutter_reserved2) (
    void
      );
      void (* _clutter_reserved3) (
    void
      );
      void (* _clutter_reserved4) (
    void
      );
      void (* _clutter_reserved5) (
    void
      );
      void (* _clutter_reserved6) (
    void
      );
      void (* _clutter_reserved7) (
    void
      );
      void (* _clutter_reserved8) (
    void
      );

    }

###### Class members

`get_type_from_name` |
    GType (* get_type_from_name) (
        ClutterScript* script,
        const gchar* type_name
      )
| No description available.
`_clutter_reserved1` |
    void (* _clutter_reserved1) (
    void
      )
| No description available.
`_clutter_reserved2` |
    void (* _clutter_reserved2) (
    void
      )
| No description available.
`_clutter_reserved3` |
    void (* _clutter_reserved3) (
    void
      )
| No description available.
`_clutter_reserved4` |
    void (* _clutter_reserved4) (
    void
      )
| No description available.
`_clutter_reserved5` |
    void (* _clutter_reserved5) (
    void
      )
| No description available.
`_clutter_reserved6` |
    void (* _clutter_reserved6) (
    void
      )
| No description available.
`_clutter_reserved7` |
    void (* _clutter_reserved7) (
    void
      )
| No description available.
`_clutter_reserved8` |
    void (* _clutter_reserved8) (
    void
      )
| No description available.

#### Virtual methods

###### Clutter.ScriptClass.get_type_from_name

Looks up a type by name, using the virtual function that `ClutterScript` has for that purpose. This function should rarely be used.

Available since: 0.6