Class TiXmlElement

Inheritance Relationships

Base Type

Class Documentation

class TiXmlElement : public TiXmlNode

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.

Public Functions

TiXmlElement(const char *in_value)

Construct an element.

TiXmlElement(const TiXmlElement&)
TiXmlElement &operator=(const TiXmlElement &base)
virtual ~TiXmlElement()
const char *Attribute(const char *name) const

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

const char *Attribute(const char *name, int *i) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an integer, the integer value will be put in the return ‘i’, if ‘i’ is non-null.

const char *Attribute(const char *name, double *d) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an double, the double value will be put in the return ‘d’, if ‘d’ is non-null.

int QueryIntAttribute(const char *name, int *_value) const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. If the attribute is an integer, it is stored in ‘value’ and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

int QueryUnsignedAttribute(const char *name, unsigned *_value) const

QueryUnsignedAttribute examines the attribute - see QueryIntAttribute().

int QueryBoolAttribute(const char *name, bool *_value) const

QueryBoolAttribute examines the attribute - see QueryIntAttribute(). Note that ‘1’, ‘true’, or ‘yes’ are considered true, while ‘0’, ‘false’ and ‘no’ are considered false.

int QueryDoubleAttribute(const char *name, double *_value) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

inline int QueryFloatAttribute(const char *name, float *_value) const

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

void SetAttribute(const char *name, const char *_value)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

void SetAttribute(const char *name, int value)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

void SetDoubleAttribute(const char *name, double value)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

void RemoveAttribute(const char *name)

Deletes an attribute with the given name.

inline const TiXmlAttribute *FirstAttribute() const

Access the first attribute in this element.

inline TiXmlAttribute *FirstAttribute()
inline const TiXmlAttribute *LastAttribute() const

Access the last attribute in this element.

inline TiXmlAttribute *LastAttribute()
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 “.

WARNING: GetText() accesses a child node - don’t become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

virtual TiXmlNode *Clone() const

Creates a new Element and returns it - the returned element is a copy.

virtual void Print(FILE *cfile, int depth) const

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

virtual const char *Parse(const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
inline virtual const TiXmlElement *ToElement() const

Cast to a more defined type. Will return null not of the requested type.

inline virtual TiXmlElement *ToElement()

Cast to a more defined type. Will return null not of the requested type.

virtual bool Accept(TiXmlVisitor *visitor) const

Walk the XML tree visiting this node and all of its children.

Protected Functions

void CopyTo(TiXmlElement *target) const
void ClearThis()
const char *ReadValue(const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)