XMLParser_wrapper Struct Reference

Inheritance diagram for XMLParser_wrapper:

Collaboration diagram for XMLParser_wrapper:

Public Member Functions
virtual void	cleanupImpl ()
	abstract method which cleans up the XMLParser after use. More...
virtual bool	initialiseImpl ()
	abstract method which initialises the XMLParser ready for use. More...
virtual void	parseXML (::CEGUI::XMLHandler &handler,::CEGUI::RawDataContainer const &source,::CEGUI::String const &schemaName)
virtual void	parseXMLFile (::CEGUI::XMLHandler &handler,::CEGUI::String const &filename,::CEGUI::String const &schemaName,::CEGUI::String const &resourceGroup)
void	default_parseXMLFile (::CEGUI::XMLHandler &handler,::CEGUI::String const &filename,::CEGUI::String const &schemaName,::CEGUI::String const &resourceGroup)
virtual void	parseXMLString (::CEGUI::XMLHandler &handler,::CEGUI::String const &source,::CEGUI::String const &schemaName)
void	default_parseXMLString (::CEGUI::XMLHandler &handler,::CEGUI::String const &source,::CEGUI::String const &schemaName)
Public Member Functions inherited from CEGUI::XMLParser
	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...
	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. More...
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.
	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. More...
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.

Additional Inherited Members
Public Types inherited from CEGUI::PropertySet
typedef ConstMapIterator< PropertyRegistry >	PropertyIterator
typedef ConstMapIterator< PropertyRegistry >	PropertyIterator
Protected Attributes inherited from CEGUI::XMLParser
String	d_identifierString
	String that holds some id information about the module.

Member Function Documentation

virtual void XMLParser_wrapper::cleanupImpl ( )

inlinevirtual

abstract method which cleans up the XMLParser after use.

Returns

Nothing.

Implements CEGUI::XMLParser.

Referenced by initialiseImpl().

virtual bool XMLParser_wrapper::initialiseImpl ( )

inlinevirtual

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.

References CEGUI::XMLParser::cleanup(), cleanupImpl(), CEGUI::XMLParser::getIdentifierString(), CEGUI::XMLParser::initialise(), CEGUI::XMLParser::parseXML(), CEGUI::XMLParser::parseXMLFile(), and CEGUI::XMLParser::parseXMLString().