Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::TinyXMLParser Class Reference

Implementation of XMLParser using TinyXML. More...

#include <CEGUITinyXMLParser.h>

Inheritance diagram for CEGUI::TinyXMLParser:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::TinyXMLParser:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TinyXMLParser (void)
 ~TinyXMLParser (void)
void parseXMLFile (XMLHandler &handler, const String &filename, const String &schemaName, const String &resourceGroup)
 abstract method which initiates parsing of an XML file.
bool initialise (void)
 Initialises the XMLParser module ready for use.
void cleanup (void)
 Cleans up the XMLParser module after use.
const StringgetIdentifierString () 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.

Protected Member Functions

bool initialiseImpl (void)
 abstract method which initialises the XMLParser ready for use.
void cleanupImpl (void)
 abstract method which cleans up the XMLParser after use.

Protected Attributes

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

Detailed Description

Implementation of XMLParser using TinyXML.

Definition at line 37 of file CEGUITinyXMLParser.h.


Constructor & Destructor Documentation

CEGUI::TinyXMLParser::TinyXMLParser void   ) 
 

Definition at line 100 of file CEGUITinyXMLParser.cpp.

References CEGUI::XMLParser::d_identifierString.

CEGUI::TinyXMLParser::~TinyXMLParser void   ) 
 

Definition at line 106 of file CEGUITinyXMLParser.cpp.


Member Function Documentation

void CEGUI::XMLParser::cleanup void   )  [inherited]
 

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.

Definition at line 49 of file CEGUIXMLParser.cpp.

References CEGUI::XMLParser::cleanupImpl().

Referenced by CEGUI::System::~System().

void CEGUI::TinyXMLParser::cleanupImpl void   )  [protected, virtual]
 

abstract method which cleans up the XMLParser after use.

Returns:
Nothing.

Implements CEGUI::XMLParser.

Definition at line 120 of file CEGUITinyXMLParser.cpp.

const String & CEGUI::XMLParser::getIdentifierString  )  const [inherited]
 

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.

Definition at line 58 of file CEGUIXMLParser.cpp.

References CEGUI::XMLParser::d_identifierString.

bool CEGUI::XMLParser::initialise void   )  [inherited]
 

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.

Definition at line 38 of file CEGUIXMLParser.cpp.

References CEGUI::XMLParser::initialiseImpl().

bool CEGUI::TinyXMLParser::initialiseImpl void   )  [protected, virtual]
 

abstract method which initialises the XMLParser ready for use.

Returns:
  • true if the module initialised successfully.
  • false if the module initialisation failed.

Implements CEGUI::XMLParser.

Definition at line 115 of file CEGUITinyXMLParser.cpp.

void CEGUI::TinyXMLParser::parseXMLFile XMLHandler handler,
const String filename,
const String schemaName,
const String resourceGroup
[virtual]
 

abstract 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.

Implements CEGUI::XMLParser.

Definition at line 109 of file CEGUITinyXMLParser.cpp.


Member Data Documentation

String CEGUI::XMLParser::d_identifierString [protected, inherited]
 

String that holds some id information about the module.

Definition at line 132 of file CEGUIXMLParser.h.

Referenced by CEGUI::XMLParser::getIdentifierString(), TinyXMLParser(), and CEGUI::XercesParser::XercesParser().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:07:37 2005 for Crazy Eddies GUI System by  doxygen 1.4.3