Nebula
Loading...
Searching...
No Matches
TiXmlNode Class Referenceabstract

#include <tinyxml.h>

Detailed Description

The parent class for everything in the Document Object Model.

(Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Inherits TiXmlBase.

Inherited by TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, and TiXmlUnknown.

Public Types

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
}
 

Public Member Functions

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 TiXmlElementToElement () 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 TiXmlElementToElement ()
 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.
 
virtual TiXmlNodeClone () const =0
 Create an exact duplicate of this node and return it.
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
virtual void Print (const Ptr< IO::TextWriter > &textWriter, int depth) const =0
 All TinyXml classes can print themselves to a filestream.
 
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 ()
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
 

Protected Member Functions

 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlBase
virtual void StreamOut (TIXML_OSTREAM *) const =0
 

Protected Attributes

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.
 

Private Member Functions

 TiXmlNode (const TiXmlNode &)
 
void operator= (const TiXmlNode &base)
 

Friends

class TiXmlDocument
 
class TiXmlElement
 
TIXML_OSTREAMoperator<< (TIXML_OSTREAM &out, const TiXmlNode &base)
 

Additional Inherited Members

- 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)
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Member Enumeration Documentation

◆ NodeType

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Enumerator
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 

Constructor & Destructor Documentation

◆ ~TiXmlNode()

TiXmlNode::~TiXmlNode ( )
virtual

◆ TiXmlNode() [1/2]

TiXmlNode::TiXmlNode ( NodeType _type)
protected

◆ TiXmlNode() [2/2]

TiXmlNode::TiXmlNode ( const TiXmlNode & )
private

Member Function Documentation

◆ Clear()

void TiXmlNode::Clear ( )

Delete all the children of this node. Does not affect 'this'.

◆ Clone()

virtual TiXmlNode * TiXmlNode::Clone ( ) const
pure virtual

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implemented in TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, and TiXmlUnknown.

◆ CopyTo()

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

◆ FirstChild() [1/4]

TiXmlNode * TiXmlNode::FirstChild ( )
inline

◆ FirstChild() [2/4]

const TiXmlNode * TiXmlNode::FirstChild ( ) const
inline

The first child of this node. Will be null if there are no children.

◆ FirstChild() [3/4]

TiXmlNode * TiXmlNode::FirstChild ( const char * value)

The first child of this node with the matching 'value'. Will be null if none found.

◆ FirstChild() [4/4]

const TiXmlNode * TiXmlNode::FirstChild ( const char * value) const

The first child of this node with the matching 'value'. Will be null if none found.

◆ FirstChildElement() [1/4]

TiXmlElement * TiXmlNode::FirstChildElement ( )

◆ FirstChildElement() [2/4]

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

◆ FirstChildElement() [3/4]

TiXmlElement * TiXmlNode::FirstChildElement ( const char * value)

◆ FirstChildElement() [4/4]

const TiXmlElement * TiXmlNode::FirstChildElement ( const char * value) const

Convenience function to get through elements.

◆ GetDocument() [1/2]

TiXmlDocument * TiXmlNode::GetDocument ( )

◆ GetDocument() [2/2]

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

◆ Identify()

TiXmlNode * TiXmlNode::Identify ( const char * start,
TiXmlEncoding encoding )
protected

◆ InsertAfterChild()

TiXmlNode * TiXmlNode::InsertAfterChild ( TiXmlNode * afterThis,
const TiXmlNode & addThis )

Add a new node related to this.

Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

◆ InsertBeforeChild()

TiXmlNode * TiXmlNode::InsertBeforeChild ( TiXmlNode * beforeThis,
const TiXmlNode & addThis )

Add a new node related to this.

Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

◆ InsertEndChild()

TiXmlNode * TiXmlNode::InsertEndChild ( const TiXmlNode & addThis)

Add a new node related to this.

Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

◆ IterateChildren() [1/4]

const TiXmlNode * TiXmlNode::IterateChildren ( const char * value,
const TiXmlNode * previous ) const

This flavor of IterateChildren searches for children with a particular 'value'.

◆ IterateChildren() [2/4]

TiXmlNode * TiXmlNode::IterateChildren ( const char * value,
TiXmlNode * previous )

◆ IterateChildren() [3/4]

const TiXmlNode * TiXmlNode::IterateChildren ( const TiXmlNode * previous) const

An alternate way to walk the children of a node.

One way to iterate over nodes is:

    for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

    child = 0;
    while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

◆ IterateChildren() [4/4]

TiXmlNode * TiXmlNode::IterateChildren ( TiXmlNode * previous)

◆ LastChild() [1/4]

TiXmlNode * TiXmlNode::LastChild ( )
inline

The last child of this node. Will be null if there are no children.

◆ LastChild() [2/4]

const TiXmlNode * TiXmlNode::LastChild ( ) const
inline

◆ LastChild() [3/4]

TiXmlNode * TiXmlNode::LastChild ( const char * value)

The last child of this node matching 'value'. Will be null if there are no children.

◆ LastChild() [4/4]

const TiXmlNode * TiXmlNode::LastChild ( const char * value) const

◆ LinkEndChild()

TiXmlNode * TiXmlNode::LinkEndChild ( TiXmlNode * addThis)

Add a new node related to this.

Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also
InsertEndChild

◆ NextSibling() [1/4]

TiXmlNode * TiXmlNode::NextSibling ( )
inline

◆ NextSibling() [2/4]

const TiXmlNode * TiXmlNode::NextSibling ( ) const
inline

Navigate to a sibling node.

◆ NextSibling() [3/4]

TiXmlNode * TiXmlNode::NextSibling ( const char * _value)

◆ NextSibling() [4/4]

const TiXmlNode * TiXmlNode::NextSibling ( const char * _value) const

Navigate to a sibling node with the given 'value'.

◆ NextSiblingElement() [1/4]

TiXmlElement * TiXmlNode::NextSiblingElement ( )

◆ NextSiblingElement() [2/4]

const TiXmlElement * TiXmlNode::NextSiblingElement ( ) const

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

◆ NextSiblingElement() [3/4]

TiXmlElement * TiXmlNode::NextSiblingElement ( const char * _value)

◆ NextSiblingElement() [4/4]

const TiXmlElement * TiXmlNode::NextSiblingElement ( const char * _value) const

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

◆ NoChildren()

bool TiXmlNode::NoChildren ( ) const
inline

Returns true if this node has no children.

◆ operator=()

void TiXmlNode::operator= ( const TiXmlNode & base)
private

◆ Parent() [1/2]

TiXmlNode * TiXmlNode::Parent ( )
inline

One step up the DOM.

◆ Parent() [2/2]

const TiXmlNode * TiXmlNode::Parent ( ) const
inline

◆ PreviousSibling() [1/4]

TiXmlNode * TiXmlNode::PreviousSibling ( )
inline

◆ PreviousSibling() [2/4]

const TiXmlNode * TiXmlNode::PreviousSibling ( ) const
inline

Navigate to a sibling node.

◆ PreviousSibling() [3/4]

TiXmlNode * TiXmlNode::PreviousSibling ( const char * _value)

◆ PreviousSibling() [4/4]

const TiXmlNode * TiXmlNode::PreviousSibling ( const char * _value) const

Navigate to a sibling node.

◆ RemoveChild()

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis)

Delete a child of this node.

◆ ReplaceChild()

TiXmlNode * TiXmlNode::ReplaceChild ( TiXmlNode * replaceThis,
const TiXmlNode & withThis )

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occured.

◆ SetValue()

void TiXmlNode::SetValue ( const char * _value)
inline

Changes the value of the node.

Defined as:

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

◆ ToComment() [1/2]

virtual TiXmlComment * TiXmlNode::ToComment ( )
inlinevirtual

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

Reimplemented in TiXmlComment.

◆ ToComment() [2/2]

virtual const TiXmlComment * TiXmlNode::ToComment ( ) const
inlinevirtual

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

Reimplemented in TiXmlComment.

◆ ToDeclaration() [1/2]

virtual TiXmlDeclaration * TiXmlNode::ToDeclaration ( )
inlinevirtual

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

Reimplemented in TiXmlDeclaration.

◆ ToDeclaration() [2/2]

virtual const TiXmlDeclaration * TiXmlNode::ToDeclaration ( ) const
inlinevirtual

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

Reimplemented in TiXmlDeclaration.

◆ ToDocument() [1/2]

virtual TiXmlDocument * TiXmlNode::ToDocument ( )
inlinevirtual

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

Reimplemented in TiXmlDocument.

◆ ToDocument() [2/2]

virtual const TiXmlDocument * TiXmlNode::ToDocument ( ) const
inlinevirtual

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

Reimplemented in TiXmlDocument.

◆ ToElement() [1/2]

virtual TiXmlElement * TiXmlNode::ToElement ( )
inlinevirtual

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

Reimplemented in TiXmlElement.

◆ ToElement() [2/2]

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

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

Reimplemented in TiXmlElement.

◆ ToText() [1/2]

virtual TiXmlText * TiXmlNode::ToText ( )
inlinevirtual

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

Reimplemented in TiXmlText.

◆ ToText() [2/2]

virtual const TiXmlText * TiXmlNode::ToText ( ) const
inlinevirtual

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

Reimplemented in TiXmlText.

◆ ToUnknown() [1/2]

virtual TiXmlUnknown * TiXmlNode::ToUnknown ( )
inlinevirtual

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

Reimplemented in TiXmlUnknown.

◆ ToUnknown() [2/2]

virtual const TiXmlUnknown * TiXmlNode::ToUnknown ( ) const
inlinevirtual

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

Reimplemented in TiXmlUnknown.

◆ Type()

int TiXmlNode::Type ( ) const
inline

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

◆ Value()

const char * TiXmlNode::Value ( ) const
inline

The meaning of 'value' changes for the specific type of TiXmlNode.

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

The subclasses will wrap this function.

Friends And Related Symbol Documentation

◆ operator<<

TIXML_OSTREAM & operator<< ( TIXML_OSTREAM & out,
const TiXmlNode & base )
friend

◆ TiXmlDocument

friend class TiXmlDocument
friend

◆ TiXmlElement

friend class TiXmlElement
friend

Member Data Documentation

◆ firstChild

TiXmlNode* TiXmlNode::firstChild
protected

◆ lastChild

TiXmlNode* TiXmlNode::lastChild
protected

◆ next

TiXmlNode* TiXmlNode::next
protected

◆ parent

TiXmlNode* TiXmlNode::parent
protected

◆ prev

TiXmlNode* TiXmlNode::prev
protected

◆ type

NodeType TiXmlNode::type
protected

◆ value

TIXML_STRING TiXmlNode::value
protected

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