virtual Clutter::Script::~Script |
( |
) | |
|
|
virtual |
Clutter::Script::Script |
( |
) | |
|
|
protected |
void Clutter::Script::ensure_objects |
( |
) | |
|
Ensure that every object defined inside script is correctly constructed.
You should rarely need to use this function.
- Since cluttermm 0.6:
GObject* Clutter::Script::get_cobject |
( |
const Glib::ustring & |
name) | |
|
|
protected |
template <class T_Object >
Get a RefPtr to an object from the ClutterScript JSON file.
For instance:
scriptObject->get_object("myRectangle", aRectangleRef);
This method prints a warning message to the console if the object doesn't exist or has the wrong type, so you don't need to check that manually.
- Parameters
-
name | The name of the object. |
- Return values
-
derived_object | A RefPtr to the object, or 0 on failure. |
Retrieves the Clutter script id, if any.
- Since cluttermm 0.6:
- Parameters
-
- Returns
- The script id, or
0
if object was not defined inside a UI definition file. The returned string is owned by the object and should never be modified or freed.
static GType Clutter::Script::get_type |
( |
) | |
|
|
static |
Get the GType for this class, for use with the underlying GObject type system.
virtual GType Clutter::Script::get_type_from_name_vfunc |
( |
const Glib::ustring & |
type_name) | |
|
|
protectedvirtual |
ClutterScript* Clutter::Script::gobj |
( |
) | |
|
|
inline |
Provides access to the underlying C GObject.
const ClutterScript* Clutter::Script::gobj |
( |
) | |
const |
|
inline |
Provides access to the underlying C GObject.
ClutterScript* Clutter::Script::gobj_copy |
( |
) | |
|
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
guint Clutter::Script::load_from_data |
( |
const Glib::ustring & |
data) | |
|
Loads the definitions from data into script and merges with the currently loaded ones, if any.
- Since cluttermm 0.6:
- Parameters
-
data | A buffer containing the definitions. |
length | The length of the buffer, or -1 if data is a NUL-terminated buffer. |
- Returns
- On error, zero is returned and error is set accordingly. On success, the merge id for the UI definitions is returned. You can use the merge id with unmerge_objects().
guint Clutter::Script::load_from_file |
( |
const std::string & |
filename) | |
|
Loads the definitions from filename into script and merges with the currently loaded ones, if any.
- Since cluttermm 0.6:
- Parameters
-
filename | The full path to the definition file. |
- Returns
- On error, zero is returned and error is set accordingly. On success, the merge id for the UI definitions is returned. You can use the merge id with unmerge_objects().
Looks up filename inside the search paths of script.
If filename is found, its full path will be returned .
- Since cluttermm 0.8:
- Parameters
-
filename | The name of the file to lookup. |
- Returns
- The full path of filename or
0
if no path was found.
The path of the currently parsed file.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Whether the :filename property is set.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Clutter::Script::unmerge_object |
( |
guint |
merge_id) | |
|
Unmerges the objects identified by merge_id.
- Since cluttermm 0.6:
- Parameters
-
merge_id | Merge id returned when loading a UI definition. |
A Glib::wrap() method for this object.
- Parameters
-
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
- Returns
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file: