Rocket::Core::Python::ContextInterface Class Reference

#include <ContextInterface.h>


Static Public Member Functions
static bool	InitialisePythonInterface ()
	Initialises the Python context interface.
static void	InitialiseRocketInterface ()
	Initialise the Rocket context interface.
static void	AddEventListener (Context self, const char event, const char *script, bool in_capture_phase)
static python::object	CreateDocument (Context self, const char tag)
static python::object	LoadDocument (Context self, const char document_path)
static python::object	LoadDocumentFromMemory (Context self, const char stream)
static python::object	LoadMouseCursor (Context self, const char document_path)
static ContextDocumentProxy	GetDocuments (Context *self)

Detailed Description

Installs and manages the Python interface for libRocket Context objects.

void Rocket::Core::Python::ContextInterface::AddEventListener	(	Context *	self,
		const char *	event,
		const char *	script,
		bool	in_capture_phase
	)			`[static]`

The "AddEventListener" function bound into Python context objects instead of the C++ function.

Parameters:

`[in]`	self	The calling context.
`[in]`	event	The event to bind to.
`[in]`	script	The script fragment to execute.
`[in]`	in_capture_phase	True if binding on the capture phase, false if the bubble phase.

python::object Rocket::Core::Python::ContextInterface::CreateDocument	(	Context *	self,
		const char *	tag
	)			`[static]`

The "CreateDocument" function bound into Python context objects instead of the C++ function.

Parameters:

`[in]`	self	The calling context.
`[in]`	tag	The tag name for the instanced document.

python::object Rocket::Core::Python::ContextInterface::LoadDocument	(	Context *	self,
		const char *	document_path
	)			`[static]`

The "LoadDocument" function bound into Python context objects instead of the C++ function.

Parameters:

`[in]`	self	The calling context.
`[in]`	document_path	The path to load the document from.

python::object Rocket::Core::Python::ContextInterface::LoadDocumentFromMemory	(	Context *	self,
		const char *	stream
	)			`[static]`

The "LoadDocument" function bound into Python context objects instead of the C++ function.

Parameters:

`[in]`	self	The calling context.
`[in]`	stream	The document stream

python::object Rocket::Core::Python::ContextInterface::LoadMouseCursor	(	Context *	self,
		const char *	document_path
	)			`[static]`

The "LoadMouseCursor" function bound into Python context objects instead of the C++ function.

Parameters:

`[in]`	self	The calling context.
`[in]`	document_path	The path to load the cursor from.

ContextDocumentProxy Rocket::Core::Python::ContextInterface::GetDocuments ( Context * self ) [static]

Returns the document proxy object for the 'document' property.

Parameters:

[in] self The calling context.

The documentation for this class was generated from the following files: