Project

General

Profile

SO3Engine
Public Types | Public Member Functions | Friends | List of all members
tinyxml2::XMLElement Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:
tinyxml2::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.)
 
void SetName (const char *str, bool staticMem=false)
 Set the name of the element.
 
virtual XMLElement * ToElement ()
 Safely cast to an Element, or null.
 
virtual const XMLElement * ToElement () const
 
virtual bool Accept (XMLVisitor *visitor) const
 
const char * Attribute (const char *name, const char *value=0) const
 
int IntAttribute (const char *name) const
 
unsigned UnsignedAttribute (const char *name) const
 See IntAttribute()
 
bool BoolAttribute (const char *name) const
 See IntAttribute()
 
double DoubleAttribute (const char *name) const
 See IntAttribute()
 
float FloatAttribute (const char *name) const
 See IntAttribute()
 
XMLError QueryIntAttribute (const char *name, int *value) const
 
XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const
 See QueryIntAttribute()
 
XMLError QueryBoolAttribute (const char *name, bool *value) const
 See QueryIntAttribute()
 
XMLError QueryDoubleAttribute (const char *name, double *value) const
 See QueryIntAttribute()
 
XMLError QueryFloatAttribute (const char *name, float *value) const
 See QueryIntAttribute()
 
int QueryAttribute (const char *name, int *value) const
 
int QueryAttribute (const char *name, unsigned int *value) const
 
int QueryAttribute (const char *name, bool *value) const
 
int QueryAttribute (const char *name, double *value) const
 
int QueryAttribute (const char *name, float *value) const
 
void SetAttribute (const char *name, const char *value)
 Sets the named attribute to value.
 
void SetAttribute (const char *name, int value)
 Sets the named attribute to value.
 
void SetAttribute (const char *name, unsigned value)
 Sets the named attribute to value.
 
void SetAttribute (const char *name, bool value)
 Sets the named attribute to value.
 
void SetAttribute (const char *name, double value)
 Sets the named attribute to value.
 
void SetAttribute (const char *name, float value)
 Sets the named attribute to value.
 
void DeleteAttribute (const char *name)
 
const XMLAttribute * FirstAttribute () const
 Return the first attribute in the list.
 
const XMLAttribute * FindAttribute (const char *name) const
 Query a specific attribute in the list.
 
const char * GetText () const
 
void SetText (const char *inText)
 
void SetText (int value)
 Convenience method for setting text inside and element. See SetText() for important limitations.
 
void SetText (unsigned value)
 Convenience method for setting text inside and element. See SetText() for important limitations.
 
void SetText (bool value)
 Convenience method for setting text inside and element. See SetText() for important limitations.
 
void SetText (double value)
 Convenience method for setting text inside and element. See SetText() for important limitations.
 
void SetText (float value)
 Convenience method for setting text inside and element. See SetText() for important limitations.
 
XMLError QueryIntText (int *ival) const
 
XMLError QueryUnsignedText (unsigned *uval) const
 See QueryIntText()
 
XMLError QueryBoolText (bool *bval) const
 See QueryIntText()
 
XMLError QueryDoubleText (double *dval) const
 See QueryIntText()
 
XMLError QueryFloatText (float *fval) const
 See QueryIntText()
 
int ClosingType () const
 
char * ParseDeep (char *p, StrPair *endTag)
 
virtual XMLNode * ShallowClone (XMLDocument *document) const
 
virtual bool ShallowEqual (const XMLNode *compare) const
 
- Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument * GetDocument () const
 Get the XMLDocument that owns this XMLNode.
 
XMLDocument * GetDocument ()
 Get the XMLDocument that owns this XMLNode.
 
virtual XMLText * ToText ()
 Safely cast to Text, or null.
 
virtual XMLComment * ToComment ()
 Safely cast to a Comment, or null.
 
virtual XMLDocument * ToDocument ()
 Safely cast to a Document, or null.
 
virtual XMLDeclaration * ToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual XMLUnknown * ToUnknown ()
 Safely cast to an Unknown, or null.
 
virtual const XMLText * ToText () const
 
virtual const XMLComment * ToComment () const
 
virtual const XMLDocument * ToDocument () const
 
virtual const XMLDeclaration * ToDeclaration () const
 
virtual const XMLUnknown * ToUnknown () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
const XMLNode * Parent () const
 Get the parent of this node on the DOM.
 
XMLNode * Parent ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
const XMLNode * FirstChild () const
 Get the first child node, or null if none exists.
 
XMLNode * FirstChild ()
 
const XMLElement * FirstChildElement (const char *value=0) const
 
XMLElement * FirstChildElement (const char *value=0)
 
const XMLNode * LastChild () const
 Get the last child node, or null if none exists.
 
XMLNode * LastChild ()
 
const XMLElement * LastChildElement (const char *value=0) const
 
XMLElement * LastChildElement (const char *value=0)
 
const XMLNode * PreviousSibling () const
 Get the previous (left) sibling node of this node.
 
XMLNode * PreviousSibling ()
 
const XMLElement * PreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
 
XMLElement * PreviousSiblingElement (const char *value=0)
 
const XMLNode * NextSibling () const
 Get the next (right) sibling node of this node.
 
XMLNode * NextSibling ()
 
const XMLElement * NextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
 
XMLElement * NextSiblingElement (const char *value=0)
 
XMLNode * InsertEndChild (XMLNode *addThis)
 
XMLNode * LinkEndChild (XMLNode *addThis)
 
XMLNode * InsertFirstChild (XMLNode *addThis)
 
XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 

Friends

class XMLBase
 
class XMLDocument
 

Additional Inherited Members

- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
 XMLNode (const XMLNode &)
 
XMLNode & operator= (const XMLNode &)
 
- Protected Attributes inherited from tinyxml2::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.

Definition at line 1129 of file tinyxml2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
OPEN 
CLOSED 
CLOSING 

Definition at line 1458 of file tinyxml2.h.

Member Function Documentation

◆ Accept()

virtual bool tinyxml2::XMLElement::Accept ( XMLVisitor *  visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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(): 

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

Implements tinyxml2::XMLNode.

◆ Attribute()

const char * tinyxml2::XMLElement::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();
}

◆ BoolAttribute()

bool tinyxml2::XMLElement::BoolAttribute ( const char *  name) const
inline

See IntAttribute()

Definition at line 1193 of file tinyxml2.h.

◆ ClosingType()

int tinyxml2::XMLElement::ClosingType ( ) const
inline

Definition at line 1463 of file tinyxml2.h.

◆ DeleteAttribute()

void tinyxml2::XMLElement::DeleteAttribute ( const char *  name)

Delete an attribute.

◆ DoubleAttribute()

double tinyxml2::XMLElement::DoubleAttribute ( const char *  name) const
inline

See IntAttribute()

Definition at line 1199 of file tinyxml2.h.

◆ FindAttribute()

const XMLAttribute * tinyxml2::XMLElement::FindAttribute ( const char *  name) const

Query a specific attribute in the list.

◆ FirstAttribute()

const XMLAttribute * tinyxml2::XMLElement::FirstAttribute ( ) const
inline

Return the first attribute in the list.

Definition at line 1339 of file tinyxml2.h.

◆ FloatAttribute()

float tinyxml2::XMLElement::FloatAttribute ( const char *  name) const
inline

See IntAttribute()

Definition at line 1205 of file tinyxml2.h.

◆ GetText()

const char * tinyxml2::XMLElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the XMLText child and accessing it directly.

If the first child of 'this' is a XMLText, 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 ".

◆ IntAttribute()

int tinyxml2::XMLElement::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()

Definition at line 1181 of file tinyxml2.h.

◆ Name()

const char * tinyxml2::XMLElement::Name ( ) const
inline

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

Definition at line 1135 of file tinyxml2.h.

◆ ParseDeep()

char * tinyxml2::XMLElement::ParseDeep ( char *  p,
StrPair *  endTag 
)
virtual

Reimplemented from tinyxml2::XMLNode.

◆ QueryAttribute() [1/5]

int tinyxml2::XMLElement::QueryAttribute ( const char *  name,
bool *  value 
) const
inline

Definition at line 1290 of file tinyxml2.h.

◆ QueryAttribute() [2/5]

int tinyxml2::XMLElement::QueryAttribute ( const char *  name,
double *  value 
) const
inline

Definition at line 1294 of file tinyxml2.h.

◆ QueryAttribute() [3/5]

int tinyxml2::XMLElement::QueryAttribute ( const char *  name,
float *  value 
) const
inline

Definition at line 1298 of file tinyxml2.h.

◆ QueryAttribute() [4/5]

int tinyxml2::XMLElement::QueryAttribute ( const char *  name,
int *  value 
) const
inline

Given an attribute name, QueryAttribute() 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. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

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;
QueryAttribute( "foo", &value );                // if "foo" isn't found, value will still be 10

Definition at line 1282 of file tinyxml2.h.

◆ QueryAttribute() [5/5]

int tinyxml2::XMLElement::QueryAttribute ( const char *  name,
unsigned int *  value 
) const
inline

Definition at line 1286 of file tinyxml2.h.

◆ QueryBoolAttribute()

XMLError tinyxml2::XMLElement::QueryBoolAttribute ( const char *  name,
bool *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1240 of file tinyxml2.h.

◆ QueryBoolText()

XMLError tinyxml2::XMLElement::QueryBoolText ( bool *  bval) const

See QueryIntText()

◆ QueryDoubleAttribute()

XMLError tinyxml2::XMLElement::QueryDoubleAttribute ( const char *  name,
double *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1248 of file tinyxml2.h.

◆ QueryDoubleText()

XMLError tinyxml2::XMLElement::QueryDoubleText ( double *  dval) const

See QueryIntText()

◆ QueryFloatAttribute()

XMLError tinyxml2::XMLElement::QueryFloatAttribute ( const char *  name,
float *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1256 of file tinyxml2.h.

◆ QueryFloatText()

XMLError tinyxml2::XMLElement::QueryFloatText ( float *  fval) const

See QueryIntText()

◆ QueryIntAttribute()

XMLError tinyxml2::XMLElement::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

Definition at line 1224 of file tinyxml2.h.

◆ QueryIntText()

XMLError tinyxml2::XMLElement::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.

◆ QueryUnsignedAttribute()

XMLError tinyxml2::XMLElement::QueryUnsignedAttribute ( const char *  name,
unsigned int *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1232 of file tinyxml2.h.

◆ QueryUnsignedText()

XMLError tinyxml2::XMLElement::QueryUnsignedText ( unsigned *  uval) const

See QueryIntText()

◆ SetAttribute() [1/6]

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

Sets the named attribute to value.

Definition at line 1318 of file tinyxml2.h.

◆ SetAttribute() [2/6]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
const char *  value 
)
inline

Sets the named attribute to value.

Definition at line 1303 of file tinyxml2.h.

◆ SetAttribute() [3/6]

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

Sets the named attribute to value.

Definition at line 1323 of file tinyxml2.h.

◆ SetAttribute() [4/6]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
float  value 
)
inline

Sets the named attribute to value.

Definition at line 1328 of file tinyxml2.h.

◆ SetAttribute() [5/6]

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

Sets the named attribute to value.

Definition at line 1308 of file tinyxml2.h.

◆ SetAttribute() [6/6]

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

Sets the named attribute to value.

Definition at line 1313 of file tinyxml2.h.

◆ SetName()

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

Set the name of the element.

Definition at line 1139 of file tinyxml2.h.

◆ SetText() [1/6]

void tinyxml2::XMLElement::SetText ( bool  value)

Convenience method for setting text inside and element. See SetText() for important limitations.

◆ SetText() [2/6]

void tinyxml2::XMLElement::SetText ( const char *  inText)

Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.

If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.

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

<foo>This is text</foo>
        fooElement->SetText( "Hullaballoo!" );
<foo>Hullaballoo!</foo>

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

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

then it will not change "This is text", but rather prefix it with a text element: 

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

    For this XML:

        <foo />

SetText() will generate 

        <foo>Hullaballoo!</foo>

◆ SetText() [3/6]

void tinyxml2::XMLElement::SetText ( double  value)

Convenience method for setting text inside and element. See SetText() for important limitations.

◆ SetText() [4/6]

void tinyxml2::XMLElement::SetText ( float  value)

Convenience method for setting text inside and element. See SetText() for important limitations.

◆ SetText() [5/6]

void tinyxml2::XMLElement::SetText ( int  value)

Convenience method for setting text inside and element. See SetText() for important limitations.

◆ SetText() [6/6]

void tinyxml2::XMLElement::SetText ( unsigned  value)

Convenience method for setting text inside and element. See SetText() for important limitations.

◆ ShallowClone()

virtual XMLNode * tinyxml2::XMLElement::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 tinyxml2::XMLNode.

◆ ShallowEqual()

virtual bool tinyxml2::XMLElement::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 tinyxml2::XMLNode.

◆ ToElement() [1/2]

virtual XMLElement * tinyxml2::XMLElement::ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1143 of file tinyxml2.h.

◆ ToElement() [2/2]

virtual const XMLElement * tinyxml2::XMLElement::ToElement ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1146 of file tinyxml2.h.

◆ UnsignedAttribute()

unsigned tinyxml2::XMLElement::UnsignedAttribute ( const char *  name) const
inline

See IntAttribute()

Definition at line 1187 of file tinyxml2.h.

Friends And Related Symbol Documentation

◆ XMLBase

friend class XMLBase
friend

Definition at line 1131 of file tinyxml2.h.

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 1132 of file tinyxml2.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8