TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

Inheritance graph
[legend]
Collaboration diagram for TiXmlNode:

Collaboration graph
[legend]

List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

virtual ~TiXmlNode ()
const char * Value () const
void SetValue (const char *_value)
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
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)
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
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
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement (const char *) const
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
const TiXmlDocumentGetDocument () const
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

Protected Member Functions

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

Protected Attributes

TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext

Private Member Functions

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

Friends

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


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 385 of file tinyxml.h.


Member Enumeration Documentation

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 

Definition at line 427 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode (  )  [virtual]

Definition at line 156 of file tinyxml.cpp.

References firstChild, and next.

TiXmlNode::TiXmlNode ( NodeType  _type  )  [protected]

Definition at line 145 of file tinyxml.cpp.

References firstChild, lastChild, next, parent, prev, and type.

TiXmlNode::TiXmlNode ( const TiXmlNode  )  [private]


Member Function Documentation

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 452 of file tinyxml.h.

References value.

Referenced by TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), LastChild(), Lugre::LuaXML_ParseNode(), NextSibling(), and PreviousSibling().

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 471 of file tinyxml.h.

References value.

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

void TiXmlNode::Clear (  ) 

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

Definition at line 177 of file tinyxml.cpp.

References firstChild, lastChild, and next.

Referenced by TiXmlElement::ClearThis(), TiXmlDocument::LoadFile(), TiXmlDeclaration::operator=(), TiXmlComment::operator=(), and TiXmlDocument::operator=().

TiXmlNode* TiXmlNode::Parent (  )  [inline]

One step up the DOM.

Definition at line 482 of file tinyxml.h.

References parent.

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

Definition at line 483 of file tinyxml.h.

References parent.

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

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

Definition at line 485 of file tinyxml.h.

References firstChild.

Referenced by FirstChildElement(), TiXmlElement::GetText(), IterateChildren(), Lugre::LuaXML_ParseNode(), TiXmlDocument::Print(), and TiXmlDocument::StreamOut().

TiXmlNode* TiXmlNode::FirstChild (  )  [inline]

Definition at line 486 of file tinyxml.h.

References firstChild.

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 326 of file tinyxml.cpp.

References firstChild, next, and Value().

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

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

Definition at line 338 of file tinyxml.cpp.

References firstChild, next, and Value().

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

Definition at line 490 of file tinyxml.h.

References lastChild.

TiXmlNode* TiXmlNode::LastChild (  )  [inline]

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

Definition at line 491 of file tinyxml.h.

References lastChild.

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

Definition at line 350 of file tinyxml.cpp.

References lastChild, prev, and Value().

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

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

Definition at line 361 of file tinyxml.cpp.

References lastChild, prev, and Value().

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 372 of file tinyxml.cpp.

References assert, FirstChild(), NextSibling(), and parent.

TiXmlNode * TiXmlNode::IterateChildren ( TiXmlNode previous  ) 

Definition at line 385 of file tinyxml.cpp.

References assert, FirstChild(), NextSibling(), and parent.

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 398 of file tinyxml.cpp.

References assert, FirstChild(), NextSibling(), and parent.

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

Definition at line 411 of file tinyxml.cpp.

References assert, FirstChild(), NextSibling(), and parent.

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 214 of file tinyxml.cpp.

References Clone(), and 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

Definition at line 194 of file tinyxml.cpp.

References assert, firstChild, GetDocument(), lastChild, next, parent, and prev.

Referenced by TiXmlDocument::CopyTo(), TiXmlElement::CopyTo(), InsertEndChild(), Lugre::LuaXML_FillNode(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

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 224 of file tinyxml.cpp.

References assert, Clone(), firstChild, next, parent, and prev.

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 250 of file tinyxml.cpp.

References assert, Clone(), lastChild, next, parent, and prev.

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 276 of file tinyxml.cpp.

References Clone(), firstChild, lastChild, next, parent, and prev.

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis  ) 

Delete a child of this node.

Definition at line 304 of file tinyxml.cpp.

References assert, firstChild, lastChild, next, parent, and prev.

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

Navigate to a sibling node.

Definition at line 566 of file tinyxml.h.

References prev.

TiXmlNode* TiXmlNode::PreviousSibling (  )  [inline]

Definition at line 567 of file tinyxml.h.

References prev.

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

Navigate to a sibling node.

Definition at line 446 of file tinyxml.cpp.

References prev, and Value().

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

Definition at line 457 of file tinyxml.cpp.

References prev, and Value().

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

TiXmlNode* TiXmlNode::NextSibling (  )  [inline]

Definition at line 582 of file tinyxml.h.

References next.

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

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

Definition at line 424 of file tinyxml.cpp.

References next, and Value().

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

Definition at line 435 of file tinyxml.cpp.

References next, and Value().

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 535 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement().

TiXmlElement * TiXmlNode::NextSiblingElement (  ) 

Definition at line 549 of file tinyxml.cpp.

References NextSibling(), and ToElement().

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 563 of file tinyxml.cpp.

References NextSibling(), and ToElement().

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

Definition at line 577 of file tinyxml.cpp.

References NextSibling(), and ToElement().

const TiXmlElement * TiXmlNode::FirstChildElement (  )  const

Convenience function to get through elements.

Definition at line 479 of file tinyxml.cpp.

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

Referenced by TiXmlDocument::RootElement().

TiXmlElement * TiXmlNode::FirstChildElement (  ) 

Definition at line 493 of file tinyxml.cpp.

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

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

Convenience function to get through elements.

Definition at line 507 of file tinyxml.cpp.

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

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

Definition at line 521 of file tinyxml.cpp.

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

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 624 of file tinyxml.h.

References type.

Referenced by Lugre::LuaXML_ParseNode().

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 592 of file tinyxml.cpp.

References parent, and ToDocument().

Referenced by Identify(), LinkEndChild(), TiXmlDeclaration::Parse(), TiXmlText::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

TiXmlDocument * TiXmlNode::GetDocument (  ) 

Definition at line 604 of file tinyxml.cpp.

References parent, and ToDocument().

bool TiXmlNode::NoChildren (  )  const [inline]

Returns true if this node has no children.

Definition at line 633 of file tinyxml.h.

References firstChild.

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 635 of file tinyxml.h.

Referenced by GetDocument().

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 636 of file tinyxml.h.

Referenced by TiXmlHandle::Element(), FirstChildElement(), Lugre::LuaXML_ParseNode(), NextSiblingElement(), and TiXmlDocument::StreamOut().

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 637 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 638 of file tinyxml.h.

Referenced by TiXmlHandle::Unknown().

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 639 of file tinyxml.h.

Referenced by TiXmlElement::GetText(), TiXmlElement::Print(), and TiXmlHandle::Text().

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 640 of file tinyxml.h.

Referenced by TiXmlDocument::Parse().

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 642 of file tinyxml.h.

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 643 of file tinyxml.h.

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 644 of file tinyxml.h.

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 645 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 646 of file tinyxml.h.

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 647 of file tinyxml.h.

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 TiXmlDocument::CopyTo(), TiXmlElement::CopyTo(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

void TiXmlNode::CopyTo ( TiXmlNode target  )  const [protected]

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

void TiXmlNode::operator= ( const TiXmlNode base  )  [private]


Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented from TiXmlBase.

Definition at line 387 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.

Definition at line 388 of file tinyxml.h.

Referenced by Identify().

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

Definition at line 1659 of file tinyxml.cpp.


Member Data Documentation

Definition at line 670 of file tinyxml.h.

Referenced by TiXmlNode(), and Type().

TIXML_STRING TiXmlNode::value [protected]

TiXmlNode* TiXmlNode::prev [protected]

TiXmlNode* TiXmlNode::next [protected]


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

Generated on Tue May 22 06:00:31 2012 for cpp by  doxygen 1.5.6