This is an abstract class that is used by CEGUI to interface with XML parser libraries. More...

Inherits CEGUI::PropertySet, and CEGUI::AllocatedObject< XMLParser >.

Inherited by CEGUI::ExpatParser, CEGUI::LibxmlParser, CEGUI::RapidXMLParser, CEGUI::TinyXMLParser, and CEGUI::XercesParser.

Collaboration diagram for CEGUI::XMLParser:

Public Member Functions
	XMLParser (void)
	XMLParser base class constructor.

virtual	~XMLParser (void)
	XMLParser base class destructor.

bool	initialise (void)
	Initialises the XMLParser module ready for use. More...

void	cleanup (void)
	Cleans up the XMLParser module after use. More...

virtual void	parseXML (XMLHandler &handler, const RawDataContainer &source, const String &schemaName)=0
	abstract method which initiates parsing of an XML. More...

virtual void	parseXMLFile (XMLHandler &handler, const String &filename, const String &schemaName, const String &resourceGroup)
	convenience method which initiates parsing of an XML file. More...

virtual void	parseXMLString (XMLHandler &handler, const String &source, const String &schemaName)
	convenience method which initiates parsing of an XML source from string. More...

const String &	getIdentifierString () const
	Return identification string for the XML parser module. If the internal id string has not been set by the XML parser module creator, a generic string of "Unknown XML parser" will be returned. More...

Public Member Functions inherited from CEGUI::PropertySet
	PropertySet (void)
	Constructs a new PropertySet object.

virtual	~PropertySet (void)
	Destructor for PropertySet objects.

void	addProperty (Property *property)
	Adds a new Property to the PropertySet. More...

void	removeProperty (const String &name)
	Removes a Property from the PropertySet. More...

Property *	getPropertyInstance (const String &name) const
	Retrieves a property instance (that was previously added) More...

void	clearProperties (void)
	Removes all Property objects from the PropertySet.

bool	isPropertyPresent (const String &name) const
	Checks to see if a Property with the given name is in the PropertySet. More...

const String &	getPropertyHelp (const String &name) const
	Return the help text for the specified Property. More...

String	getProperty (const String &name) const
	Gets the current value of the specified Property. More...

template<typename T >
PropertyHelper< T >::return_type	getProperty (const String &name) const
	Gets the current value of the specified Property. More...

void	setProperty (const String &name, const String &value)
	Sets the current value of a Property. More...

template<typename T >
void	setProperty (const String &name, typename PropertyHelper< T >::pass_type value)
	Sets the current value of a Property. More...

bool	isPropertyDefault (const String &name) const
	Returns whether a Property is at it's default value. More...

String	getPropertyDefault (const String &name) const
	Returns the default value of a Property as a String. More...

PropertyIterator	getPropertyIterator (void) const
	Return a PropertySet::PropertyIterator object to iterate over the available Properties.

Protected Member Functions
virtual bool	initialiseImpl (void)=0
	abstract method which initialises the XMLParser ready for use. More...

virtual void	cleanupImpl (void)=0
	abstract method which cleans up the XMLParser after use. More...

Protected Attributes
String	d_identifierString
	String that holds some id information about the module.

Additional Inherited Members
Public Types inherited from CEGUI::PropertySet
typedef ConstMapIterator< PropertyRegistry >	PropertyIterator

Detailed Description

This is an abstract class that is used by CEGUI to interface with XML parser libraries.

Member Function Documentation

void CEGUI::XMLParser::cleanup ( void )

Cleans up the XMLParser module after use.

Note that this calls the protected abstract method 'cleanupImpl', which should be provided in your implementation to perform any required cleanup.

Returns: Nothing.

virtual void CEGUI::XMLParser::cleanupImpl ( void )

protectedpure virtual

abstract method which cleans up the XMLParser after use.

Returns: Nothing.

Implemented in CEGUI::XercesParser, CEGUI::ExpatParser, CEGUI::LibxmlParser, CEGUI::TinyXMLParser, and CEGUI::RapidXMLParser.

const String& CEGUI::XMLParser::getIdentifierString ( ) const

Return identification string for the XML parser module. If the internal id string has not been set by the XML parser module creator, a generic string of "Unknown XML parser" will be returned.

Returns: String object holding a string that identifies the XML parser in use.

bool CEGUI::XMLParser::initialise ( void )

Initialises the XMLParser module ready for use.

Note that this calls the protected abstract method 'initialiseImpl', which should be provided in your implementation to perform any required initialisation.

Returns

true if the module initialised successfully.
false if the module initialisation failed.

virtual bool CEGUI::XMLParser::initialiseImpl ( void )

protectedpure virtual

abstract method which initialises the XMLParser ready for use.

Returns

true if the module initialised successfully.
false if the module initialisation failed.

Implemented in CEGUI::XercesParser, CEGUI::ExpatParser, CEGUI::LibxmlParser, CEGUI::TinyXMLParser, and CEGUI::RapidXMLParser.

virtual void CEGUI::XMLParser::parseXML	(	XMLHandler &	handler,
		const RawDataContainer &	source,
		const String &	schemaName
	)

pure virtual

abstract method which initiates parsing of an XML.

Parameters

handler	XMLHandler based object which will process the XML elements.
source	RawDataContainer containing the data to parse
schemaName	String object holding the name of the XML schema file to use for validating the XML. Note that whether this is used or not is dependant upon the XMLParser in use.

Returns: Nothing.

Implemented in CEGUI::XercesParser, CEGUI::ExpatParser, CEGUI::LibxmlParser, CEGUI::TinyXMLParser, and CEGUI::RapidXMLParser.

virtual void CEGUI::XMLParser::parseXMLFile	(	XMLHandler &	handler,
		const String &	filename,
		const String &	schemaName,
		const String &	resourceGroup
	)

virtual

convenience method which initiates parsing of an XML file.

Parameters

handler	XMLHandler based object which will process the XML elements.
filename	String object holding the filename of the XML file to be parsed.
schemaName	String object holding the name of the XML schema file to use for validating the XML. Note that whether this is used or not is dependant upon the XMLParser in use.
resourceGroup	String object holding the resource group identifier which will be passed to the ResourceProvider when loading the XML and schema files.

Returns: Nothing.

virtual void CEGUI::XMLParser::parseXMLString	(	XMLHandler &	handler,
		const String &	source,
		const String &	schemaName
	)

virtual

convenience method which initiates parsing of an XML source from string.

Parameters

handler	XMLHandler based object which will process the XML elements.
source	The XML source passed as a String
schemaName	String object holding the name of the XML schema file to use for validating the XML. Note that whether this is used or not is dependant upon the XMLParser in use.

Returns: Nothing.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation