Clutter::Script Class Reference

#include <script.h>

Inheritance diagram for Clutter::Script:

[legend]

List of all members.

Public Member Functions
virtual	~Script ()
ClutterScript *	gobj ()
	Provides access to the underlying C GObject.
const ClutterScript *	gobj () const
	Provides access to the underlying C GObject.
ClutterScript *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
guint	load_from_file (const std::string &filename)
	Loads the definitions from filename into script and merges with the currently loaded ones, if any.
Glib::RefPtr< Glib::Object >	get_object (const Glib::ustring &name)
	Retrieves the object bound to name.
Glib::RefPtr< const Glib::Object >	get_object (const Glib::ustring &name) const
	Retrieves the object bound to name.
void	unmerge_object (guint merge_id)
	Unmerges the objects identified by merge_id.
void	ensure_objects ()
	Ensure that every object defined inside script is correctly constructed.
Glib::PropertyProxy_ReadOnly < std::string >	property_filename () const
	The path of the currently parsed file.
Glib::PropertyProxy_ReadOnly < bool >	property_filename_set () const
	Whether the :filename property is set.
Static Public Member Functions
static Glib::RefPtr< Script >	create ()
static std::string	get_script_id (const Glib::RefPtr< const Glib::Object > &object)
	Retrieves the Clutter script id, if any.
Protected Member Functions
	Script ()
Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::Script >	wrap (ClutterScript *object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Constructor & Destructor Documentation

virtual Clutter::Script::~Script

(

)

[virtual]

Clutter::Script::Script

(

)

[protected]

---

Member Function Documentation

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.

static Glib::RefPtr<Script> Clutter::Script::create

(

)

[static]

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.

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 clutter_script_unmerge().

Since: 0.6.

Glib::RefPtr<Glib::Object> Clutter::Script::get_object

(

const Glib::ustring &

name

)

Retrieves the object bound to name.

This function does not increment the reference count of the returned object.

Parameters:

name

The name of the object to retrieve.

Returns:

The named object, or 0 if no object with the given name was available

Since: 0.6.

Glib::RefPtr<const Glib::Object> Clutter::Script::get_object

(

const Glib::ustring &

name

)

const

Retrieves the object bound to name.

This function does not increment the reference count of the returned object.

Parameters:

name

The name of the object to retrieve.

Returns:

The named object, or 0 if no object with the given name was available

Since: 0.6.

void Clutter::Script::unmerge_object

(

guint

merge_id

)

Unmerges the objects identified by merge_id.

Since: 0.6

Parameters:

merge_id

Merge id returned when loading a UI definition.

void Clutter::Script::ensure_objects

(

)

Ensure that every object defined inside script is correctly constructed.

You should rarely need to use this function.

Since: 0.6

static std::string Clutter::Script::get_script_id

(

const Glib::RefPtr< const Glib::Object > &

object

)

[static]

Retrieves the Clutter script id, if any.

Parameters:

gobject

A Object.

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.

Since: 0.6.

Glib::PropertyProxy_ReadOnly<std::string> Clutter::Script::property_filename

(

)

const

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 that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Clutter::Script::property_filename_set

(

)

const

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 that allows you to get or set the property of the value, or receive notification when the value of the property changes.

---

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Script > wrap	(	ClutterScript *	object,
		bool	take_copy = false
	)			[related]

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:

• script.h