TinyXML-2 5.0.1

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

`#include <tinyxml2.h>`

Inheritance diagram for tinyxml2::XMLElement:

## 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 bool | Accept (XMLVisitor *visitor) const
const char * | Attribute (const char *name, const char *value=0) const
int | IntAttribute (const char *name, int defaultValue=0) const
unsigned | UnsignedAttribute (const char *name, unsigned defaultValue=0) const
| See IntAttribute()
int64_t | Int64Attribute (const char *name, int64_t defaultValue=0) const
| See IntAttribute()
bool | BoolAttribute (const char *name, bool defaultValue=false) const
| See IntAttribute()
double | DoubleAttribute (const char *name, double defaultValue=0) const
| See IntAttribute()
float | FloatAttribute (const char *name, float defaultValue=0) const
| See IntAttribute()
XMLError | QueryIntAttribute (const char *name, int *value) const
XMLError | QueryUnsignedAttribute (const char *name, unsigned int *value) const
| See QueryIntAttribute()
XMLError | QueryInt64Attribute (const char *name, int64_t *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
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, int64_t 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 an element. See SetText() for important limitations.
void | SetText (unsigned value)
| Convenience method for setting text inside an element. See SetText() for important limitations.
void | SetText (int64_t value)
| Convenience method for setting text inside an element. See SetText() for important limitations.
void | SetText (bool value)
| Convenience method for setting text inside an element. See SetText() for important limitations.
void | SetText (double value)
| Convenience method for setting text inside an element. See SetText() for important limitations.
void | SetText (float value)
| Convenience method for setting text inside an element. See SetText() for important limitations.
XMLError | QueryIntText (int *ival) const
XMLError | QueryUnsignedText (unsigned *uval) const
| See QueryIntText()
XMLError | QueryInt64Text (int64_t *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()
unsigned | UnsignedText (unsigned defaultValue=0) const
| See QueryIntText()
int64_t | Int64Text (int64_t defaultValue=0) const
| See QueryIntText()
bool | BoolText (bool defaultValue=false) const
| See QueryIntText()
double | DoubleText (double defaultValue=0) const
| See QueryIntText()
float | FloatText (float defaultValue=0) const
| See QueryIntText()
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.
const char * | Value () const
void | SetValue (const char *val, bool staticMem=false)
int | GetLineNum () const
| Gets the line number the node is in, if the document was parsed from a file.
const XMLNode * | Parent () const
| Get the parent of this node on the DOM.
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.
const XMLElement * | FirstChildElement (const char *name=0) const
const XMLNode * | LastChild () const
| Get the last child node, or null if none exists.
const XMLElement * | LastChildElement (const char *name=0) const
const XMLNode * | PreviousSibling () const
| Get the previous (left) sibling node of this node.
const XMLElement * | PreviousSiblingElement (const char *name=0) const
| Get the previous (left) sibling element of this node, with an optionally supplied name.
const XMLNode * | NextSibling () const
| Get the next (right) sibling node of this node.
const XMLElement * | NextSiblingElement (const char *name=0) const
| Get the next (right) sibling element of this node, with an optionally supplied name.
XMLNode * | InsertEndChild (XMLNode *addThis)
XMLNode * | InsertFirstChild (XMLNode *addThis)
XMLNode * | InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
void | DeleteChildren ()
void | DeleteChild (XMLNode *node)
XMLNode * | DeepClone (XMLDocument *target) const
void | SetUserData (void *userData)
void * | GetUserData () const

## 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 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:

- http://www.saxproject.org/
- http://c2.com/cgi/wiki?HierarchicalVisitorPattern

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();
    }

## ◆ DeleteAttribute()

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

Delete an attribute.

## ◆ 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,
|  | int | defaultValue = `0`
| ) |  | const

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).

## ◆ QueryAttribute()

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

Given an attribute name, QueryAttribute() returns XML_SUCCESS, 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

## ◆ QueryIntAttribute()

XMLError tinyxml2::XMLElement::QueryIntAttribute | ( | const char * | name,
|  | int * | value
| ) |  | const
| inline

Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, 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

## ◆ 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.

## ◆ SetText()

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>

## ◆ 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.

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

- tinyxml2.h