cocos2d-x  2.2.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
XMLElement Class Reference

The element is a container class. More...

#include <tinyxml2.h>

Inheritance diagram for XMLElement:
XMLNode

Public Types

enum  { OPEN, CLOSED, CLOSING }
 

Public Member Functions

const char * Name () const
 Get the name of an element (which is the Value() of the node.) More...
 
void SetName (const char *str, bool staticMem=false)
 Set the name of the element. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual const XMLElementToElement () const
virtual bool Accept (XMLVisitor *visitor) const
 Accept a hierarchical visit of the nodes in the TinyXML DOM. More...
 
const char * Attribute (const char *name, const char *value=0) const
 Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. More...
 
int IntAttribute (const char *name) const
 Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. More...
 
unsigned UnsignedAttribute (const char *name) const
 See IntAttribute() More...
 
bool BoolAttribute (const char *name) const
 See IntAttribute() More...
 
double DoubleAttribute (const char *name) const
 See IntAttribute() More...
 
float FloatAttribute (const char *name) const
 See IntAttribute() More...
 
XMLError QueryIntAttribute (const char *name, int *value) const
 Given an attribute name, QueryIntAttribute() returns XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. More...
 
XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const
 See QueryIntAttribute() More...
 
XMLError QueryBoolAttribute (const char *name, bool *value) const
 See QueryIntAttribute() More...
 
XMLError QueryDoubleAttribute (const char *name, double *value) const
 See QueryIntAttribute() More...
 
XMLError QueryFloatAttribute (const char *name, float *value) const
 See QueryIntAttribute() More...
 
void SetAttribute (const char *name, const char *value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, int value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, unsigned value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, bool value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, double value)
 Sets the named attribute to value. More...
 
void DeleteAttribute (const char *name)
 Delete an attribute. More...
 
const XMLAttributeFirstAttribute () const
 Return the first attribute in the list. More...
 
const XMLAttributeFindAttribute (const char *name) const
 Query a specific attribute in the list. More...
 
const char * GetText () const
 Convenience function for easy access to the text inside an element. More...
 
XMLError QueryIntText (int *ival) const
 Convenience method to query the value of a child text node. More...
 
XMLError QueryUnsignedText (unsigned *uval) const
 See QueryIntText() More...
 
XMLError QueryBoolText (bool *bval) const
 See QueryIntText() More...
 
XMLError QueryDoubleText (double *dval) const
 See QueryIntText() More...
 
XMLError QueryFloatText (float *fval) const
 See QueryIntText() More...
 
int ClosingType () const
char * ParseDeep (char *p, StrPair *endTag)
virtual XMLNodeShallowClone (XMLDocument *document) const
 Make a copy of this node, but not its children. More...
 
virtual bool ShallowEqual (const XMLNode *compare) const
 Test if 2 nodes are the same, but don't test children. More...
 
- Public Member Functions inherited from XMLNode
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLTextToText () const
virtual const XMLCommentToComment () const
virtual const XMLDocumentToDocument () const
virtual const XMLDeclarationToDeclaration () const
virtual const XMLUnknownToUnknown () const
const char * Value () const
 The meaning of 'value' changes for the specific type. More...
 
void SetValue (const char *val, bool staticMem=false)
 Set the Value of an XML node. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
const XMLElementFirstChildElement (const char *value=0) const
 Get the first child element, or optionally the first child element with the specified name. More...
 
XMLElementFirstChildElement (const char *value=0)
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
const XMLElementLastChildElement (const char *value=0) const
 Get the last child element or optionally the last child element with the specified name. More...
 
XMLElementLastChildElement (const char *value=0)
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
const XMLElementPreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *value=0)
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
const XMLElementNextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementNextSiblingElement (const char *value=0)
XMLNodeInsertEndChild (XMLNode *addThis)
 Add a child node as the last (right) child. More...
 
XMLNodeLinkEndChild (XMLNode *addThis)
XMLNodeInsertFirstChild (XMLNode *addThis)
 Add a child node as the first (left) child. More...
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 Add a node after the specified child node. More...
 
void DeleteChildren ()
 Delete all the children of this node. More...
 
void DeleteChild (XMLNode *node)
 Delete a child of this node. More...
 

Friends

class XMLBase
class XMLDocument

Additional Inherited Members

- Protected Member Functions inherited from XMLNode
 XMLNode (XMLDocument *)
virtual ~XMLNode ()
 XMLNode (const XMLNode &)
XMLNodeoperator= (const XMLNode &)
- Protected Attributes inherited from XMLNode
XMLDocument_document
XMLNode_parent
StrPair _value
XMLNode_firstChild
XMLNode_lastChild
XMLNode_prev
XMLNode_next

Detailed Description

The element is a container class.

It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

Member Enumeration Documentation

anonymous enum
Enumerator
OPEN 
CLOSED 
CLOSING 

Member Function Documentation

virtual bool Accept ( XMLVisitor visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML DOM.

Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implements XMLNode.

const char* Attribute ( const char *  name,
const char *  value = 0 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

For example:

const char* value = ele->Attribute( "foo" );

The 'value' parameter is normally null. However, if specified, the attribute will only be returned if the 'name' and 'value' match. This allow you to write code:

if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();

rather than:

if ( ele->Attribute( "foo" ) ) {
    if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
}
bool BoolAttribute ( const char *  name) const
inline
int ClosingType ( ) const
inline
void DeleteAttribute ( const char *  name)

Delete an attribute.

double DoubleAttribute ( const char *  name) const
inline
const XMLAttribute* FindAttribute ( const char *  name) const

Query a specific attribute in the list.

const XMLAttribute* FirstAttribute ( ) const
inline

Return the first attribute in the list.

float FloatAttribute ( const char *  name) const
inline
const char* GetText ( ) const

Convenience function for easy access to the text inside an element.

Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

<foo>This is text</foo>
    const char* str = fooElement->GetText();

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

    <foo><b>This is text</b></foo>

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

    <foo>This is <b>text</b></foo>

GetText() will return "This is ".

int IntAttribute ( const char *  name) const
inline

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer.

0 will be returned if there is an error. For a method with error checking, see QueryIntAttribute()

const char* Name ( ) const
inline

Get the name of an element (which is the Value() of the node.)

char* ParseDeep ( char *  p,
StrPair endTag 
)
virtual

Reimplemented from XMLNode.

XMLError QueryBoolAttribute ( const char *  name,
bool *  value 
) const
inline
XMLError QueryBoolText ( bool *  bval) const
XMLError QueryDoubleAttribute ( const char *  name,
double *  value 
) const
inline
XMLError QueryDoubleText ( double *  dval) const
XMLError QueryFloatAttribute ( const char *  name,
float *  value 
) const
inline
XMLError QueryFloatText ( float *  fval) const
XMLError QueryIntAttribute ( const char *  name,
int *  value 
) const
inline

Given an attribute name, QueryIntAttribute() returns XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist.

If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

int value = 10;
QueryIntAttribute( "foo", &value );     // if "foo" isn't found, value will still be 10
XMLError QueryIntText ( int *  ival) const

Convenience method to query the value of a child text node.

This is probably best shown by example. Given you have a document is this form:

    <point>
        <x>1</x>
        <y>1.4</y>
    </point>

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

    int x = 0;
    float y = 0;    // types of x and y are contrived for example
    const XMLElement* xElement = pointElement->FirstChildElement( "x" );
    const XMLElement* yElement = pointElement->FirstChildElement( "y" );
    xElement->QueryIntText( &x );
    yElement->QueryFloatText( &y );
Returns
XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.
XMLError QueryUnsignedAttribute ( const char *  name,
unsigned int *  value 
) const
inline
XMLError QueryUnsignedText ( unsigned *  uval) const
void SetAttribute ( const char *  name,
const char *  value 
)
inline

Sets the named attribute to value.

void SetAttribute ( const char *  name,
int  value 
)
inline

Sets the named attribute to value.

void SetAttribute ( const char *  name,
unsigned  value 
)
inline

Sets the named attribute to value.

void SetAttribute ( const char *  name,
bool  value 
)
inline

Sets the named attribute to value.

void SetAttribute ( const char *  name,
double  value 
)
inline

Sets the named attribute to value.

void SetName ( const char *  str,
bool  staticMem = false 
)
inline

Set the name of the element.

virtual XMLNode* ShallowClone ( XMLDocument document) const
virtual

Make a copy of this node, but not its children.

You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements XMLNode.

virtual bool ShallowEqual ( const XMLNode compare) const
virtual

Test if 2 nodes are the same, but don't test children.

The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements XMLNode.

virtual XMLElement* ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented from XMLNode.

virtual const XMLElement* ToElement ( ) const
inlinevirtual

Reimplemented from XMLNode.

unsigned UnsignedAttribute ( const char *  name) const
inline

Friends And Related Function Documentation

friend class XMLBase
friend
friend class XMLDocument
friend

The documentation for this class was generated from the following file: