CEGUI::Config_xmlHandler Class Reference

Handler class used to parse the Configuration XML file. More...

#include <Config_xmlHandler.h>

Inheritance diagram for CEGUI::Config_xmlHandler:

Collaboration diagram for CEGUI::Config_xmlHandler:

Public Member Functions
	Config_xmlHandler ()
	Constructor.
	~Config_xmlHandler ()
	Destructor.
void	initialiseXMLParser () const
	Initialise the CEGUI XMLParser according to info parsed from config.
void	initialiseImageCodec () const
	Initialise the CEGUI ImageCodec according to info parsed from config.
void	initialiseLogger (const String &default_filename) const
	Initialise the CEGUI Logger according to info parsed from config.
void	initialiseResourceGroupDirectories () const
	Set resource group dirs read from the config. (DefaultResourceProvider only).
void	initialiseDefaultResourceGroups () const
	Set default resource groups according to those in the config.
void	loadAutoResources () const
	Auto-load all resources specified in the config.
void	initialiseDefaultFont () const
	initialise the system default font according to the config.
void	initialiseDefaultMouseCursor () const
	initialise the system default mouse cursor image according to the config.
void	initialiseDefaulTooltip () const
	initialise the system default tooltip according to the config.
void	executeInitScript () const
	execute the init script as specified in the config.
const String &	getTerminateScriptName () const
	return the name of the terminate script from the config (hacky!)
const String &	getSchemaName () const
	Retrieves the schema file name to use with resources handled by this handler. More...
const String &	getDefaultResourceGroup () const
	Retrieves the default resource group to be used when handling files. More...
void	elementStart (const String &element, const XMLAttributes &attributes)
	Method called to notify the handler at the start of each XML element encountered. More...
void	elementEnd (const String &element)
	Method called to notify the handler at the end of each XML element encountered. More...
Public Member Functions inherited from CEGUI::XMLHandler
	XMLHandler (void)
	XMLHandler base class constructor.
virtual	~XMLHandler (void)
	XMLHandler base class destructor.
virtual const String &	getSchemaName () const
	Retrieves the schema file name to use with resources handled by this handler. More...
virtual const String &	getDefaultResourceGroup () const =0
	Retrieves the default resource group to be used when handling files. More...
void	handleContainer (const RawDataContainer &source)
	Takes given RawDataContainer containing XML and handles it. More...
void	handleFile (const String &fileName, const String &resourceGroup)
	Takes given file containing XML and handles it. More...
void	handleString (const String &source)
	Takes given string containing XML source and handles it. More...
virtual void	elementStart (const String &element, const XMLAttributes &attributes)
	Method called to notify the handler at the start of each XML element encountered. More...
virtual void	elementEnd (const String &element)
	Method called to notify the handler at the end of each XML element encountered. More...
virtual void	text (const String &text)
	Method called to notify text node, several successiv text node are agregated. More...

Static Public Attributes
static const String	CEGUIConfigSchemaName
	Name of xsd schema file used for validation.
static const String	CEGUIConfigElement
static const String	LoggingElement
static const String	AutoLoadElement
static const String	ResourceDirectoryElement
static const String	DefaultResourceGroupElement
static const String	ScriptingElement
static const String	XMLParserElement
static const String	ImageCodecElement
static const String	DefaultFontElement
static const String	DefaultMouseCursorElement
static const String	DefaultTooltipElement
static const String	FilenameAttribute
static const String	LevelAttribute
static const String	TypeAttribute
static const String	GroupAttribute
static const String	PatternAttribute
static const String	DirectoryAttribute
static const String	InitScriptAttribute
static const String	TerminateScriptAttribute
static const String	ImageAttribute
static const String	NameAttribute

Detailed Description

Handler class used to parse the Configuration XML file.

Member Function Documentation

elementEnd()

void CEGUI::Config_xmlHandler::elementEnd ( const String &  element )

virtual

Method called to notify the handler at the end of each XML element encountered.

Parameters

element

String object holding the name of the element that is ending.

Returns

Nothing.

Reimplemented from CEGUI::XMLHandler.

elementStart()

void CEGUI::Config_xmlHandler::elementStart ( const String &  element, const XMLAttributes &  attributes  )

virtual

Method called to notify the handler at the start of each XML element encountered.

Parameters

element	String object holding the name of the element that is starting.
attributes	An XMLAttributes object holding the collection of attributes specified for the element.

Returns

Nothing.

Reimplemented from CEGUI::XMLHandler.

getDefaultResourceGroup()

const String & CEGUI::Config_xmlHandler::getDefaultResourceGroup ( ) const

virtual

Retrieves the default resource group to be used when handling files.

Implements CEGUI::XMLHandler.

getSchemaName()

const String & CEGUI::Config_xmlHandler::getSchemaName ( ) const

virtual

Retrieves the schema file name to use with resources handled by this handler.

Reimplemented from CEGUI::XMLHandler.