The parent class for everything in the Document Object Model. More...

#include "tinyxml.h"

Inheritance diagram for TiXmlNode:
TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

List of all members.

Public Types

enum  NodeType {
  TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN,
  TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT
}
 

The types of XML nodes supported by TinyXml.

More...

Public Member Functions

virtual bool Accept (TiXmlVisitor *visitor) const =0
 Accept a hierchical visit the nodes in the TinyXML DOM.
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
virtual TiXmlNodeClone () const =0
 Create an exact duplicate of this node and return it.
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'.
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
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)
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
TiXmlDocumentGetDocument ()
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNodeIterateChildren (const 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, const TiXmlNode *previous)
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild () const
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.
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling (const char *_next)
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling ()
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement (const char *_next)
bool NoChildren () const
 Returns true if this node has no children.
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodeParent () const
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
void SetValue (const char *_value)
 Changes the value of the node.
virtual TiXmlCommentToComment ()
 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 TiXmlDeclarationToDeclaration ()
 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 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 TiXmlElementToElement ()
 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 const TiXmlTextToText () const
 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 const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
int Type () const
 Query the type (as an enumerated value, above) of this node.
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
const TiXmlString & ValueTStr () const

Protected Member Functions

 TiXmlNode (NodeType _type)
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)

Protected Attributes

TiXmlNodefirstChild
TiXmlNodelastChild
TiXmlNodenext
TiXmlNodeparent
TiXmlNodeprev
NodeType type
TiXmlString value

Friends

class TiXmlDocument
class TiXmlElement

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.

Definition at line 423 of file tinyxml.h.


Member Enumeration Documentation

The types of XML nodes supported by TinyXml.

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

Definition at line 462 of file tinyxml.h.


Member Function Documentation

virtual bool TiXmlNode::Accept ( TiXmlVisitor visitor) const [pure virtual]

Accept a hierchical visit the nodes in the TinyXML DOM.

Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

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

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

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

Referenced by TiXmlDocument::Accept(), and TiXmlElement::Accept().

void TiXmlNode::Clear ( )

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

Definition at line 191 of file tinyxml.cpp.

Referenced by TiXmlDocument::LoadFile().

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 TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

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

The first child of this node with the matching 'value'.

Will be null if none found.

Definition at line 379 of file tinyxml.cpp.

References Value().

TiXmlNode* TiXmlNode::FirstChild ( const char *  _value) [inline]

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

Definition at line 526 of file tinyxml.h.

const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline]

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

Definition at line 522 of file tinyxml.h.

Referenced by TiXmlDocument::Accept(), TiXmlElement::Accept(), FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), TiXmlDocument::Print(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 470 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

Referenced by TiXmlDocument::RootElement().

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

Convenience function to get through elements.

Definition at line 485 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 530 of file tinyxml.cpp.

References ToDocument().

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), and ReplaceChild().

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.

Definition at line 282 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

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.

Definition at line 250 of file tinyxml.cpp.

References Clone(), GetDocument(), and Type().

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.

Definition at line 235 of file tinyxml.cpp.

References Clone(), GetDocument(), LinkEndChild(), and Type().

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

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

Definition at line 417 of file tinyxml.cpp.

References FirstChild(), and NextSibling().

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.

Definition at line 403 of file tinyxml.cpp.

References FirstChild(), and NextSibling().

TiXmlNode* TiXmlNode::LastChild ( ) [inline]

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

Definition at line 532 of file tinyxml.h.

TiXmlNode* TiXmlNode::LastChild ( const char *  _value) [inline]

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

Definition at line 535 of file tinyxml.h.

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

Definition at line 208 of file tinyxml.cpp.

References GetDocument(), and Type().

Referenced by InsertEndChild(), and TiXmlDocument::Parse().

const TiXmlNode* TiXmlNode::NextSibling ( ) const [inline]
const TiXmlNode * TiXmlNode::NextSibling ( const char *  _value) const

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

Definition at line 431 of file tinyxml.cpp.

References Value().

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.

Definition at line 515 of file tinyxml.cpp.

References NextSibling(), and ToElement().

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.

Definition at line 500 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement().

bool TiXmlNode::NoChildren ( ) const [inline]

Returns true if this node has no children.

Definition at line 695 of file tinyxml.h.

TiXmlNode* TiXmlNode::Parent ( ) [inline]

One step up the DOM.

Definition at line 519 of file tinyxml.h.

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

Navigate to a sibling node.

Definition at line 443 of file tinyxml.cpp.

References Value().

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 614 of file tinyxml.h.

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)

Delete a child of this node.

Definition at line 353 of file tinyxml.cpp.

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.

Definition at line 314 of file tinyxml.cpp.

References Clone(), GetDocument(), and ToDocument().

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
        

Definition at line 508 of file tinyxml.h.

Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

virtual TiXmlComment* TiXmlNode::ToComment ( ) [inline, virtual]

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

Reimplemented in TiXmlComment.

Definition at line 706 of file tinyxml.h.

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const [inline, virtual]

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

Reimplemented in TiXmlComment.

Definition at line 699 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const [inline, virtual]

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

Reimplemented in TiXmlDeclaration.

Definition at line 702 of file tinyxml.h.

Referenced by TiXmlDocument::Parse().

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) [inline, virtual]

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

Reimplemented in TiXmlDeclaration.

Definition at line 709 of file tinyxml.h.

virtual TiXmlDocument* TiXmlNode::ToDocument ( ) [inline, virtual]

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

Reimplemented in TiXmlDocument.

Definition at line 704 of file tinyxml.h.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const [inline, virtual]

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

Reimplemented in TiXmlDocument.

Definition at line 697 of file tinyxml.h.

Referenced by GetDocument(), and ReplaceChild().

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const [inline, virtual]

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

Reimplemented in TiXmlElement.

Definition at line 698 of file tinyxml.h.

Referenced by FirstChildElement(), and NextSiblingElement().

virtual TiXmlElement* TiXmlNode::ToElement ( ) [inline, virtual]

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

Reimplemented in TiXmlElement.

Definition at line 705 of file tinyxml.h.

virtual TiXmlText* TiXmlNode::ToText ( ) [inline, virtual]

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

Reimplemented in TiXmlText.

Definition at line 708 of file tinyxml.h.

virtual const TiXmlText* TiXmlNode::ToText ( ) const [inline, virtual]

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

Reimplemented in TiXmlText.

Definition at line 701 of file tinyxml.h.

Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( ) [inline, virtual]

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

Reimplemented in TiXmlUnknown.

Definition at line 707 of file tinyxml.h.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const [inline, virtual]

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

Reimplemented in TiXmlUnknown.

Definition at line 700 of file tinyxml.h.

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.

Definition at line 684 of file tinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().

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.

Definition at line 487 of file tinyxml.h.

Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().


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