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

CEGUI::XmlHandlerHelper Class Reference

Internal helper class to extract attribute values from xerces-c attribute blocks. More...

#include <CEGUIXmlHandlerHelper.h>

List of all members.

Static Public Member Functions

char * getAttributeValueAsChar (const XERCES_CPP_NAMESPACE::Attributes &attrs, const char *const attributeName)
 Return a pointer to a character array that contains the value of the requested attribute from the given attributes collection.
const XMLCh * getAttributeValueAsXmlChar (const XERCES_CPP_NAMESPACE::Attributes &attrs, const char *const attributeName)
 Return a pointer to a XMLCh array that contains the value of the requested attribute from the given attributes collection.
int getAttributeValueAsInteger (const XERCES_CPP_NAMESPACE::Attributes &attrs, const char *const attributeName)
 Return an integer equal to the value of the requested attribute from the given attributes collection.
String getAttributeValueAsString (const XERCES_CPP_NAMESPACE::Attributes &attrs, const char *const attributeName)
 Return a String object that contains the value of the requested attribute from the given attributes collection.
String transcodeXmlCharToString (const XMLCh *const xmlch_str)
 Return a string object containing data transcoded from the given XMLCh array.


Detailed Description

Internal helper class to extract attribute values from xerces-c attribute blocks.

Definition at line 29 of file CEGUIXmlHandlerHelper.h.


Member Function Documentation

char * CEGUI::XmlHandlerHelper::getAttributeValueAsChar const XERCES_CPP_NAMESPACE::Attributes &  attrs,
const char *const   attributeName
[static]
 

Return a pointer to a character array that contains the value of the requested attribute from the given attributes collection.

Parameters:
attrs Xerces-c Attributes collection.
attributeName character array holding the name of the attribute to be accessed.
Returns:
pointer to a character array holding the string value of attributeName. Note that the returned pointer is owned by xerces-c and should be released by using XMLString::release when it is no longer needed.

Definition at line 47 of file CEGUIXmlHandlerHelper.cpp.

References getAttributeValueAsXmlChar().

int CEGUI::XmlHandlerHelper::getAttributeValueAsInteger const XERCES_CPP_NAMESPACE::Attributes &  attrs,
const char *const   attributeName
[static]
 

Return an integer equal to the value of the requested attribute from the given attributes collection.

Parameters:
attrs Xerces-c Attributes collection.
attributeName character array holding the name of the attribute to be accessed.
Returns:
integer value of the requested attribute.

Definition at line 52 of file CEGUIXmlHandlerHelper.cpp.

References getAttributeValueAsXmlChar().

String CEGUI::XmlHandlerHelper::getAttributeValueAsString const XERCES_CPP_NAMESPACE::Attributes &  attrs,
const char *const   attributeName
[static]
 

Return a String object that contains the value of the requested attribute from the given attributes collection.

Parameters:
attrs Xerces-c Attributes collection.
attributeName character array holding the name of the attribute to be accessed.
Returns:
String object containing the text of the attribute value requested.

Definition at line 57 of file CEGUIXmlHandlerHelper.cpp.

References getAttributeValueAsXmlChar(), and transcodeXmlCharToString().

const XMLCh * CEGUI::XmlHandlerHelper::getAttributeValueAsXmlChar const XERCES_CPP_NAMESPACE::Attributes &  attrs,
const char *const   attributeName
[static]
 

Return a pointer to a XMLCh array that contains the value of the requested attribute from the given attributes collection.

Parameters:
attrs Xerces-c Attributes collection.
attributeName character array holding the name of the attribute to be accessed.
Returns:
pointer to a XMLCh array holding the string value of attributeName. Note that the returned pointer is owned by xerces-c and should be released by using XMLString::release when it is no longer needed.

Definition at line 38 of file CEGUIXmlHandlerHelper.cpp.

Referenced by getAttributeValueAsChar(), getAttributeValueAsInteger(), and getAttributeValueAsString().

String CEGUI::XmlHandlerHelper::transcodeXmlCharToString const XMLCh *const   xmlch_str  )  [static]
 

Return a string object containing data transcoded from the given XMLCh array.

Parameters:
xmlch_str Pointer to an XMLCh array holding the source string to be transcoded.
Returns:
String object containing the transcoded text string.

Definition at line 62 of file CEGUIXmlHandlerHelper.cpp.

References CEGUI::String::append(), and CEGUI::utf8.

Referenced by getAttributeValueAsString().


The documentation for this class was generated from the following files:
Generated on Wed Feb 16 12:41:12 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1