TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

List of all members.


Public Types

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

Public Member Functions

virtual ~TiXmlNode ()
const char * Value () const
const std::string & ValueStr () const
const TIXML_STRING & ValueTStr () const
void SetValue (const char *_value)
void SetValue (const std::string &_value)
 STL std::string form.
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNode * Parent ()
 One step up the DOM.
const TiXmlNode * Parent () const
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNode * FirstChild ()
const TiXmlNode * FirstChild (const char *value) const
TiXmlNode * FirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNode * LastChild () const
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNode * LastChild (const char *value) const
TiXmlNode * LastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode * FirstChild (const std::string &_value) const
 STL std::string form.
TiXmlNode * FirstChild (const std::string &_value)
 STL std::string form.
const TiXmlNode * LastChild (const std::string &_value) const
 STL std::string form.
TiXmlNode * LastChild (const std::string &_value)
 STL std::string form.
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
TiXmlNode * IterateChildren (const TiXmlNode *previous)
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNode * IterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNode * IterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.
TiXmlNode * IterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form.
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling ()
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const char *_prev)
const TiXmlNode * PreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNode * PreviousSibling (const std::string &_value)
 STL std::string form.
const TiXmlNode * NextSibling (const std::string &_value) const
 STL std::string form.
TiXmlNode * NextSibling (const std::string &_value)
 STL std::string form.
const TiXmlNode * NextSibling () const
 Navigate to a sibling node.
TiXmlNode * NextSibling ()
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNode * NextSibling (const char *_next)
const TiXmlElement * NextSiblingElement () const
TiXmlElement * NextSiblingElement ()
const TiXmlElement * NextSiblingElement (const char *) const
TiXmlElement * NextSiblingElement (const char *_next)
const TiXmlElement * NextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElement * NextSiblingElement (const std::string &_value)
 STL std::string form.
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement ()
const TiXmlElement * FirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const char *_value)
const TiXmlElement * FirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElement * FirstChildElement (const std::string &_value)
 STL std::string form.
int Type () const
const TiXmlDocument * GetDocument () const
TiXmlDocument * GetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
virtual const
TiXmlDocument * 		ToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlElement * 		ToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlComment * 		ToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlUnknown * 		ToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlText * ToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual const
TiXmlDeclaration * 		ToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlText * ToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual
TiXmlDeclaration * 		ToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlNode * Clone () const =0
virtual bool Accept (TiXmlVisitor *visitor) const =0

Protected Member Functions

 TiXmlNode (NodeType _type)
void CopyTo (TiXmlNode *target) const
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)=0
TiXmlNode * Identify (const char *start, TiXmlEncoding encoding)

Protected Attributes

TiXmlNode * parent
NodeType type
TiXmlNode * firstChild
TiXmlNode * lastChild
TIXML_STRING value
TiXmlNode * prev
TiXmlNode * next

Private Member Functions

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

Friends

class TiXmlDocument
class TiXmlElement
std::istream & operator>> (std::istream &in, TiXmlNode &base)
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.

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 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 (  )  [virtual]

TiXmlNode ( NodeType  _type  )  [protected]

TiXmlNode ( const TiXmlNode &   )  [private]

Member Function Documentation

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

const TIXML_STRING& ValueTStr (  )  const [inline]

void 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

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

STL std::string form.

void Clear (  ) 

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

TiXmlNode* Parent (  )  [inline]

One step up the DOM.

const TiXmlNode* Parent (  )  const [inline]

const TiXmlNode* FirstChild (  )  const [inline]

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

TiXmlNode* FirstChild (  )  [inline]

const TiXmlNode * FirstChild ( const char *  value  )  const

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

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

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

const TiXmlNode* LastChild (  )  const [inline]

TiXmlNode* LastChild (  )  [inline]

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

const TiXmlNode * LastChild ( const char *  value  )  const

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

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

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

STL std::string form.

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

STL std::string form.

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

STL std::string form.

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

STL std::string form.

const 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* IterateChildren ( const TiXmlNode *  previous  )  [inline]

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

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

TiXmlNode* IterateChildren ( const char *  _value,
const TiXmlNode *  previous 
) [inline]

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

STL std::string form.

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

STL std::string form.

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 * 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 * 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 * 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 * 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.

bool RemoveChild ( TiXmlNode *  removeThis  ) 

Delete a child of this node.

const TiXmlNode* PreviousSibling (  )  const [inline]

Navigate to a sibling node.

TiXmlNode* PreviousSibling (  )  [inline]

const TiXmlNode * PreviousSibling ( const char *  _value  )  const

Navigate to a sibling node.

TiXmlNode* PreviousSibling ( const char *  _prev  )  [inline]

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

STL std::string form.

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

STL std::string form.

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

STL std::string form.

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

STL std::string form.

const TiXmlNode* NextSibling (  )  const [inline]

Navigate to a sibling node.

TiXmlNode* NextSibling (  )  [inline]

const TiXmlNode * NextSibling ( const char *  _value  )  const

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

TiXmlNode* NextSibling ( const char *  _next  )  [inline]

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

TiXmlElement* NextSiblingElement (  )  [inline]

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

TiXmlElement* NextSiblingElement ( const char *  _next  )  [inline]

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

STL std::string form.

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

STL std::string form.

const TiXmlElement * FirstChildElement (  )  const

Convenience function to get through elements.

TiXmlElement* FirstChildElement (  )  [inline]

const TiXmlElement * FirstChildElement ( const char *  _value  )  const

Convenience function to get through elements.

TiXmlElement* FirstChildElement ( const char *  _value  )  [inline]

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

STL std::string form.

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

STL std::string form.

int 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 TiXmlDocument * GetDocument (  )  const

Return a pointer to the Document this node lives in. Returns null if not in a document.

TiXmlDocument* GetDocument (  )  [inline]

bool NoChildren (  )  const [inline]

Returns true if this node has no children.

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

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

Reimplemented in TiXmlDocument.

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

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

Reimplemented in TiXmlElement.

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

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

Reimplemented in TiXmlComment.

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

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

Reimplemented in TiXmlUnknown.

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

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

Reimplemented in TiXmlText.

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

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

Reimplemented in TiXmlDeclaration.

virtual TiXmlDocument* ToDocument (  )  [inline, virtual]

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

Reimplemented in TiXmlDocument.

virtual TiXmlElement* ToElement (  )  [inline, virtual]

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

Reimplemented in TiXmlElement.

virtual TiXmlComment* ToComment (  )  [inline, virtual]

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

Reimplemented in TiXmlComment.

virtual TiXmlUnknown* ToUnknown (  )  [inline, virtual]

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

Reimplemented in TiXmlUnknown.

virtual TiXmlText* ToText (  )  [inline, virtual]

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

Reimplemented in TiXmlText.

virtual TiXmlDeclaration* ToDeclaration (  )  [inline, virtual]

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

Reimplemented in TiXmlDeclaration.

virtual 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.

virtual bool 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.

void CopyTo ( TiXmlNode *  target  )  const [protected]

virtual void StreamIn ( std::istream *  in,
TIXML_STRING *  tag 
) [protected, pure virtual]

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

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

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

Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented from TiXmlBase.

friend class TiXmlElement [friend]

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.

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.

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::string& operator<< ( std::string &  out,
const TiXmlNode &  base 
) [friend]

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

Member Data Documentation

TiXmlNode* parent [protected]

NodeType type [protected]

TiXmlNode* firstChild [protected]

TiXmlNode* lastChild [protected]

TIXML_STRING value [protected]

TiXmlNode* prev [protected]

TiXmlNode* next [protected]

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