- Cal3D 0.9 API Reference -

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

TiXmlNode Class Reference

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 {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...


Public Methods

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

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

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 () const
 One step up the DOM.

TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.

TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode * LastChild () const
TiXmlNode * LastChild (const char *value) const
 The last child of this node. Will be null if there are no children.

TiXmlNode * FirstChild (const std::string &value) const
 STL std::string form.

TiXmlNode * LastChild (const std::string &value) const
 STL std::string form.

TiXmlNode * IterateChildren (TiXmlNode *previous) const
 An alternate way to walk the children of a node. More...

TiXmlNode * IterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode * IterateChildren (const std::string &value, TiXmlNode *previous) const
 STL std::string form.

TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this. More...

TiXmlNode * LinkEndChild (TiXmlNode *addThis)
 Add a new node related to this. More...

TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this. More...

TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this. More...

TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node. More...

bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.

TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.

TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.

TiXmlNode * PreviousSibling (const std::string &value) const
 STL std::string form.

TiXmlNode * NextSibling (const std::string &value) const
 STL std::string form.

TiXmlNode * NextSibling () const
 Navigate to a sibling node.

TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.

TiXmlElement * NextSiblingElement () const
 Convenience function to get through elements. More...

TiXmlElement * NextSiblingElement (const char *) const
 Convenience function to get through elements. More...

TiXmlElement * NextSiblingElement (const std::string &value) const
 STL std::string form.

TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.

TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements.

TiXmlElement * FirstChildElement (const std::string &value) const
 STL std::string form.

virtual int Type () const
 Query the type (as an enumerated value, above) of this node.

TiXmlDocument * GetDocument () const
 Return a pointer to the Document this node lives in. More...

bool NoChildren () const
 Returns true if this node has no children.

TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null not of the requested type.

TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null not of the requested type.

TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type.

TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.

TiXmlText * ToText () const
 Cast to a more defined type. Will return null not of the requested type.

TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.

virtual TiXmlNode * Clone () const=0
void SetUserData (void *user)
void * GetUserData ()

Protected Methods

 TiXmlNode (NodeType type)
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)=0
TiXmlNode * Identify (const char *start)
void CopyToClone (TiXmlNode *target) const
TIXML_STRING SValue () const

Protected Attributes

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

Friends

class TiXmlDocument
class TiXmlElement
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 An input stream operator, for every class. More...

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

Detailed Description

The parent class for everything in the Document Object Model.

(Except for attributes, which are contained in elements.) 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.)

Member Function Documentation

TiXmlDocument * TiXmlNode::GetDocument (    )  const
 

Return a pointer to the Document this node lives in.

Returns null if not in a document.

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 (  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::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

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
 

Convenience function to get through elements.

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

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

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 Function Documentation

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.

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.

The documentation for this class was generated from the following files:
Generated at Sun Oct 12 18:38:50 2003 by The Cal3D Team with doxygen 1.2.14 © 1997-2001 Dimitri van Heesch