Rocket::Core::SystemInterface Class Reference

#include <SystemInterface.h>

Inheritance diagram for Rocket::Core::SystemInterface:

Collaboration diagram for Rocket::Core::SystemInterface:


Public Member Functions
virtual float	GetElapsedTime ()=0
virtual int	TranslateString (String &translated, const String &input)
virtual void	JoinPath (String &translated_path, const String &document_path, const String &path)
virtual bool	LogMessage (Log::Type type, const String &message)
virtual void	Release ()
	Called when this system interface is no longer required.
Protected Member Functions
virtual void	OnReferenceDeactivate ()
	A hook method called when the reference count drops to 0.

Detailed Description

libRocket's System Interface.

This class provides interfaces for Time, Translation and Logging.

Time is the only required implementation.

The default implemention of Translation doesn't translate anything

The default implementation of logging logs Windows Debug Console, or Standard Error, depending on what platform you're using.

virtual float Rocket::Core::SystemInterface::GetElapsedTime ( ) [pure virtual]

Get the number of seconds elapsed since the start of the application.

int Rocket::Core::SystemInterface::TranslateString	(	String &	translated,
		const String &	input
	)			`[virtual]`

Translate the input string into the translated string.

Parameters:

`[out]`	translated	Translated string ready for display.
`[in]`	input	String as received from XML.

void Rocket::Core::SystemInterface::JoinPath	(	String &	translated_path,
		const String &	document_path,
		const String &	path
	)			`[virtual]`

Joins the path of an RML or RCSS file with the path of a resource specified within the file.

Parameters:

`[out]`	translated_path	The joined path.
`[in]`	document_path	The path of the source document (including the file name).
`[in]`	path	The path of the resource specified in the document.

virtual bool Rocket::Core::SystemInterface::LogMessage	(	Log::Type	type,
		const String &	message
	)			`[virtual]`

Log the specified message.

Parameters:

`[in]`	type	Type of log message, ERROR, WARNING, etc.
`[in]`	message	Message to log.

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