Nebula
Loading...
Searching...
No Matches
TiXmlElement Class Reference

#include <tinyxml.h>

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.

Inherits TiXmlNode.

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element.
 
 TiXmlElement (const TiXmlElement &)
 
void 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.
 
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.
 
int QueryIntAttribute (const char *name, int *_value) const
 QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
 
int QueryDoubleAttribute (const char *name, double *_value) const
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
 
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.
 
void SetAttribute (const char *name, int value)
 Sets an attribute of name to a given value.
 
void SetDoubleAttribute (const char *name, double value)
 Sets an attribute of name to a given value.
 
void RemoveAttribute (const char *name)
 Deletes an attribute with the given name.
 
const TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element.
 
TiXmlAttributeFirstAttribute ()
 
const TiXmlAttributeLastAttribute () const
 Access the last attribute in this element.
 
TiXmlAttributeLastAttribute ()
 
const char * GetText () const
 Convenience function for easy access to the text inside an element.
 
virtual TiXmlNodeClone () const
 Creates a new Element and returns it - the returned element is a copy.
 
virtual void Print (const Ptr< IO::TextWriter > &textWriter, int depth) const
 All TinyXml classes can print themselves to a filestream.
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type.
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
 
void SetValue (const char *_value)
 Changes the value of the node.
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
const TiXmlNodeLastChild (const char *value) const
 
TiXmlNodeLastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
 
TiXmlNodeIterateChildren (TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous)
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const char *)
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
TiXmlNodeNextSibling (const char *)
 
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
 
TiXmlElementNextSiblingElement (const char *)
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const char *value)
 
int Type () const
 Query the type (as an enumerated value, above) of this node.
 
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 Return the position, in the original source file, of this node or attribute.
 
int Column () const
 See Row()
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Protected Member Functions

void CopyTo (TiXmlElement *target) const
 
void ClearThis ()
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
const char * ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlBase

Private Attributes

TiXmlAttributeSet attributeSet
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT , ELEMENT , COMMENT , UNKNOWN ,
  TEXT , DECLARATION , TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0 , TIXML_ERROR , TIXML_ERROR_OPENING_FILE , TIXML_ERROR_OUT_OF_MEMORY ,
  TIXML_ERROR_PARSING_ELEMENT , TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME , TIXML_ERROR_READING_ELEMENT_VALUE , TIXML_ERROR_READING_ATTRIBUTES ,
  TIXML_ERROR_PARSING_EMPTY , TIXML_ERROR_READING_END_TAG , TIXML_ERROR_PARSING_UNKNOWN , TIXML_ERROR_PARSING_COMMENT ,
  TIXML_ERROR_PARSING_DECLARATION , TIXML_ERROR_DOCUMENT_EMPTY , TIXML_ERROR_EMBEDDED_NULL , TIXML_ERROR_PARSING_CDATA ,
  TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Protected Attributes inherited from TiXmlNode
TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer.
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Constructor & Destructor Documentation

◆ TiXmlElement() [1/2]

TiXmlElement::TiXmlElement ( const char * in_value)

Construct an element.

◆ TiXmlElement() [2/2]

TiXmlElement::TiXmlElement ( const TiXmlElement & copy)

◆ ~TiXmlElement()

TiXmlElement::~TiXmlElement ( )
virtual

Member Function Documentation

◆ Attribute() [1/3]

const char * TiXmlElement::Attribute ( const char * name) const

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

◆ Attribute() [2/3]

const char * TiXmlElement::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.

◆ Attribute() [3/3]

const char * TiXmlElement::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.

◆ ClearThis()

void TiXmlElement::ClearThis ( )
protected

◆ Clone()

TiXmlNode * TiXmlElement::Clone ( ) const
virtual

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

Implements TiXmlNode.

◆ CopyTo()

void TiXmlElement::CopyTo ( TiXmlElement * target) const
protected

◆ FirstAttribute() [1/2]

TiXmlAttribute * TiXmlElement::FirstAttribute ( )
inline

◆ FirstAttribute() [2/2]

const TiXmlAttribute * TiXmlElement::FirstAttribute ( ) const
inline

Access the first attribute in this element.

◆ GetText()

const char * TiXmlElement::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.

◆ LastAttribute() [1/2]

TiXmlAttribute * TiXmlElement::LastAttribute ( )
inline

◆ LastAttribute() [2/2]

const TiXmlAttribute * TiXmlElement::LastAttribute ( ) const
inline

Access the last attribute in this element.

◆ operator=()

void TiXmlElement::operator= ( const TiXmlElement & base)

◆ Parse()

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

Implements TiXmlBase.

◆ Print()

void TiXmlElement::Print ( const Ptr< IO::TextWriter > & textWriter,
int depth ) const
virtual

All TinyXml classes can print themselves to a filestream.

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

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

Implements TiXmlBase.

◆ QueryDoubleAttribute()

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

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

◆ QueryFloatAttribute()

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

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

◆ QueryIntAttribute()

int TiXmlElement::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.

◆ ReadValue()

const char * TiXmlElement::ReadValue ( const char * in,
TiXmlParsingData * prevData,
TiXmlEncoding encoding )
protected

◆ RemoveAttribute()

void TiXmlElement::RemoveAttribute ( const char * name)

Deletes an attribute with the given name.

◆ SetAttribute() [1/2]

void TiXmlElement::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.

◆ SetAttribute() [2/2]

void TiXmlElement::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.

◆ SetDoubleAttribute()

void TiXmlElement::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.

◆ StreamOut()

void TiXmlElement::StreamOut ( TIXML_OSTREAM * out) const
protectedvirtual

Implements TiXmlBase.

◆ ToElement() [1/2]

virtual TiXmlElement * TiXmlElement::ToElement ( )
inlinevirtual

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

Reimplemented from TiXmlNode.

◆ ToElement() [2/2]

virtual const TiXmlElement * TiXmlElement::ToElement ( ) const
inlinevirtual

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

Reimplemented from TiXmlNode.

Member Data Documentation

◆ attributeSet

TiXmlAttributeSet TiXmlElement::attributeSet
private

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