Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

TiXmlNode Class Reference

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

#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
}
 The types of XML nodes supported by TinyXml. More...


Public Member Functions

virtual ~TiXmlNode ()
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.

const std::string & ValueStr () const
 Return Value() as a std::string.

void SetValue (const char *_value)
 Changes the value of the node.

void SetValue (const std::string &_value)
 STL std::string form.

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 TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form.

TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form.

const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.

TiXmlNodeLastChild (const std::string &_value)
 STL std::string form.

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)
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.

TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous)
 STL std::string form.

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 TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.

TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form.

const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.

TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form.

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 TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.

TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form.

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 TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.

TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form.

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.


Protected Member Functions

 TiXmlNode (NodeType _type)
void CopyTo (TiXmlNode *target) const
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)=0
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
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 An input stream operator, for every class.

std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
 An output stream operator, for every class.

std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.

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.


Member Enumeration Documentation

enum TiXmlNode::NodeType
 

The types of XML nodes supported by TinyXml.

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

Enumeration values:
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 


Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode  )  [virtual]
 

TiXmlNode::TiXmlNode NodeType  _type  )  [protected]
 

TiXmlNode::TiXmlNode const TiXmlNode  )  [private]
 


Member Function Documentation

void TiXmlNode::Clear  ) 
 

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

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.

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

TiXmlNode* TiXmlNode::FirstChild const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlNode* TiXmlNode::FirstChild const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlNode * TiXmlNode::FirstChild const char *  value  ) 
 

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

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

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

TiXmlNode* TiXmlNode::FirstChild  )  [inline]
 

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

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

TiXmlElement* TiXmlNode::FirstChildElement const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlElement* TiXmlNode::FirstChildElement const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlElement * TiXmlNode::FirstChildElement const char *  value  ) 
 

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

Convenience function to get through elements.

TiXmlElement * TiXmlNode::FirstChildElement  ) 
 

const TiXmlElement * TiXmlNode::FirstChildElement  )  const
 

Convenience function to get through elements.

TiXmlDocument * TiXmlNode::GetDocument  ) 
 

const TiXmlDocument * TiXmlNode::GetDocument  )  const
 

Return a pointer to the Document this node lives in.

Returns null if not in a document.

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

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.

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.

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.

TiXmlNode* TiXmlNode::IterateChildren const std::string &  _value,
TiXmlNode previous
[inline]
 

STL std::string form.

const TiXmlNode* TiXmlNode::IterateChildren const std::string &  _value,
const TiXmlNode previous
const [inline]
 

STL std::string form.

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

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

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

TiXmlNode * TiXmlNode::IterateChildren TiXmlNode previous  ) 
 

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.

TiXmlNode* TiXmlNode::LastChild const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlNode* TiXmlNode::LastChild const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlNode * TiXmlNode::LastChild const char *  value  ) 
 

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

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

TiXmlNode* TiXmlNode::LastChild  )  [inline]
 

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

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

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

TiXmlNode * TiXmlNode::NextSibling const char *   ) 
 

const TiXmlNode * TiXmlNode::NextSibling const char *   )  const
 

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

TiXmlNode* TiXmlNode::NextSibling  )  [inline]
 

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

Navigate to a sibling node.

TiXmlNode* TiXmlNode::NextSibling const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlNode* TiXmlNode::NextSibling const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlElement* TiXmlNode::NextSiblingElement const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlElement* TiXmlNode::NextSiblingElement const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlElement * TiXmlNode::NextSiblingElement const char *   ) 
 

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

TiXmlElement * TiXmlNode::NextSiblingElement  ) 
 

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.

bool TiXmlNode::NoChildren  )  const [inline]
 

Returns true if this node has no children.

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

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

TiXmlNode* TiXmlNode::Parent  )  [inline]
 

One step up the DOM.

TiXmlNode* TiXmlNode::PreviousSibling const std::string &  _value  )  [inline]
 

STL std::string form.

const TiXmlNode* TiXmlNode::PreviousSibling const std::string &  _value  )  const [inline]
 

STL std::string form.

TiXmlNode * TiXmlNode::PreviousSibling const char *   ) 
 

const TiXmlNode * TiXmlNode::PreviousSibling const char *   )  const
 

Navigate to a sibling node.

TiXmlNode* TiXmlNode::PreviousSibling  )  [inline]
 

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

Navigate to a sibling node.

bool TiXmlNode::RemoveChild TiXmlNode removeThis  ) 
 

Delete a child of this node.

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.

void TiXmlNode::SetValue const std::string &  _value  )  [inline]
 

STL std::string form.

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
		

virtual void TiXmlNode::StreamIn TIXML_ISTREAM *  in,
TIXML_STRING *  tag
[protected, pure virtual]
 

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

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

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

Reimplemented in TiXmlComment.

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.

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

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

Reimplemented in TiXmlDeclaration.

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.

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

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

Reimplemented in TiXmlDocument.

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.

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

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

Reimplemented in TiXmlElement.

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.

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

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

Reimplemented in TiXmlText.

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.

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

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

Reimplemented in TiXmlUnknown.

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.

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.

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.

const std::string& TiXmlNode::ValueStr  )  const [inline]
 

Return Value() as a std::string.

If you only use STL, this is more efficient than calling Value(). Only available in STL mode.


Friends And Related Function Documentation

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

std::string& operator<< std::string &  out,
const TiXmlNode base
[friend]
 

Appends the XML node or attribute to a std::string.

std::ostream& operator<< std::ostream &  out,
const TiXmlNode base
[friend]
 

An output stream operator, for every class.

Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

std::istream& operator>> std::istream &  in,
TiXmlNode base
[friend]
 

An input stream operator, for every class.

Tolerant of newlines and formatting, but doesn't expect them.

friend class TiXmlDocument [friend]
 

Reimplemented from TiXmlBase.

friend class TiXmlElement [friend]
 

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.


Member Data Documentation

TiXmlNode* TiXmlNode::firstChild [protected]
 

TiXmlNode* TiXmlNode::lastChild [protected]
 

TiXmlNode* TiXmlNode::next [protected]
 

TiXmlNode* TiXmlNode::parent [protected]
 

TiXmlNode* TiXmlNode::prev [protected]
 

NodeType TiXmlNode::type [protected]
 

TIXML_STRING TiXmlNode::value [protected]
 


The documentation for this class was generated from the following files:
Generated for TinyXPath by doxygen SourceForge Logo