TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

Collaboration diagram for TiXmlNode:

Public Types
enum	NodeType {   TINYXML_DOCUMENT , TINYXML_ELEMENT , TINYXML_COMMENT , TINYXML_UNKNOWN ,   TINYXML_TEXT , TINYXML_DECLARATION , TINYXML_TYPECOUNT }
Public Types inherited from TiXmlBase
enum	{   TIXML_NO_ERROR = 0 , TIXML_ERROR , TIXML_ERROR_OPENING_FILE , TIXML_ERROR_PARSING_ELEMENT ,   TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME , TIXML_ERROR_READING_ELEMENT_VALUE , TIXML_ERROR_READING_ATTRIBUTES , TIXML_ERROR_PARSING_EMPTY ,   TIXML_ERROR_READING_END_TAG , TIXML_ERROR_PARSING_UNKNOWN , TIXML_ERROR_PARSING_COMMENT , TIXML_ERROR_PARSING_DECLARATION ,   TIXML_ERROR_DOCUMENT_EMPTY , TIXML_ERROR_EMBEDDED_NULL , TIXML_ERROR_PARSING_CDATA , TIXML_ERROR_DOCUMENT_TOP_ONLY ,   TIXML_ERROR_STRING_COUNT }

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const =0
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...
virtual TiXmlNode *	Clone () const =0
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...
TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. More...
const TiXmlNode *	FirstChild (const char *value) const
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement (const char *_value)
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...
TiXmlDocument *	GetDocument ()
const TiXmlDocument *	GetDocument () const
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
TiXmlNode *	IterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const char *value, const TiXmlNode *previous) const
	This flavor of IterateChildren searches for children with a particular 'value'. More...
TiXmlNode *	IterateChildren (const TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const char *value) const
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...
TiXmlNode *	NextSibling (const char *_next)
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement () const
const TiXmlElement *	NextSiblingElement (const char *) const
TiXmlElement *	NextSiblingElement (const char *_next)
bool	NoChildren () const
	Returns true if this node has no children. More...
TiXmlNode *	Parent ()
	One step up the DOM. More...
const TiXmlNode *	Parent () const
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...
TiXmlNode *	PreviousSibling (const char *_prev)
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void	SetValue (const char *_value)
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type. More...
int	Type () const
const char *	Value () const
const TIXML_STRING &	ValueTStr () const
virtual	~TiXmlNode ()
Public Member Functions inherited from TiXmlBase
int	Column () const
	See Row() More...
void *	GetUserData ()
	Get a pointer to arbitrary user data. More...
const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
virtual void	Print (FILE *cfile, int depth) const =0
int	Row () const
void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...
	TiXmlBase ()
virtual	~TiXmlBase ()

Protected Member Functions
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
	TiXmlNode (NodeType _type)

Protected Attributes
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TiXmlNode *	next
TiXmlNode *	parent
TiXmlNode *	prev
NodeType	type
TIXML_STRING	value
Protected Attributes inherited from TiXmlBase
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer. More...

Private Member Functions
void	operator= (const TiXmlNode &base)
	TiXmlNode (const TiXmlNode &)

Friends
class	TiXmlDocument
class	TiXmlElement

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	SetCondenseWhiteSpace (bool condense)
Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]
Static Protected Member Functions inherited from TiXmlBase
static void	ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char *	GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char *	GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int c)
static const char *	ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char *	ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int	ToLower (int v, TiXmlEncoding encoding)
Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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

NodeType

enum TiXmlNode::NodeType

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT
TINYXML_ELEMENT
TINYXML_COMMENT
TINYXML_UNKNOWN
TINYXML_TEXT
TINYXML_DECLARATION
TINYXML_TYPECOUNT

    {
        TINYXML_DOCUMENT,
        TINYXML_ELEMENT,
        TINYXML_COMMENT,
        TINYXML_UNKNOWN,
        TINYXML_TEXT,
        TINYXML_DECLARATION,
        TINYXML_TYPECOUNT
    };

Constructor & Destructor Documentation

~TiXmlNode()

TiXmlNode::~TiXmlNode ( )

virtual

{
    TiXmlNode* node = firstChild;
    TiXmlNode* temp = 0;
 
    while ( node )
    {
        temp = node;
        node = node->next;
        delete temp;
    }   
}

TiXmlNode() [1/2]

TiXmlNode::TiXmlNode ( NodeType  _type )

protected

                                     : TiXmlBase()
{
    parent = 0;
    type = _type;
    firstChild = 0;
    lastChild = 0;
    prev = 0;
    next = 0;
}

TiXmlNode() [2/2]

TiXmlNode::TiXmlNode ( const TiXmlNode &  )

private

Member Function Documentation

Accept()

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:

• http://www.saxproject.org/
• http://c2.com/cgi/wiki?HierarchicalVisitorPattern

Which are both good references for "visiting".

An example of using Accept():

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

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

Clear()

void TiXmlNode::Clear

(

)

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

{
    TiXmlNode* node = firstChild;
    TiXmlNode* temp = 0;
 
    while ( node )
    {
        temp = node;
        node = node->next;
        delete temp;
    }   
 
    firstChild = 0;
    lastChild = 0;
}

Clone()

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

CopyTo()

void TiXmlNode::CopyTo ( TiXmlNode *  target ) const

protected

{
    target->SetValue (value.c_str() );
    target->userData = userData; 
    target->location = location;
}

FirstChild() [1/4]

TiXmlNode* TiXmlNode::FirstChild ( )

inline

{ return firstChild; }

FirstChild() [2/4]

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inline

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

FirstChild() [3/4]

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

inline

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

                                                 {
        // Call through to the const version - safe since nothing is changed. Exiting syntax: cast this to a const (always safe)
        // call the method, cast the return back to non-const.
        return const_cast< TiXmlNode* > ((const_cast< const TiXmlNode* >(this))->FirstChild( _value ));
    }

FirstChild() [4/4]

const TiXmlNode * TiXmlNode::FirstChild

(

const char *

value

)

const

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

{
    const TiXmlNode* node;
    for ( node = firstChild; node; node = node->next )
    {
        if ( strcmp( node->Value(), _value ) == 0 )
            return node;
    }
    return 0;
}

FirstChildElement() [1/4]

TiXmlElement* TiXmlNode::FirstChildElement ( )

inline

                                      {
        return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement() );
    }

FirstChildElement() [2/4]

const TiXmlElement * TiXmlNode::FirstChildElement

(

)

const

Convenience function to get through elements.

{
    const TiXmlNode* node;
 
    for (   node = FirstChild();
            node;
            node = node->NextSibling() )
    {
        if ( node->ToElement() )
            return node->ToElement();
    }
    return 0;
}

FirstChildElement() [3/4]

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

inline

                                                           {
        return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->FirstChildElement( _value ) );
    }

FirstChildElement() [4/4]

const TiXmlElement * TiXmlNode::FirstChildElement

(

const char *

_value

)

const

Convenience function to get through elements.

{
    const TiXmlNode* node;
 
    for (   node = FirstChild( _value );
            node;
            node = node->NextSibling( _value ) )
    {
        if ( node->ToElement() )
            return node->ToElement();
    }
    return 0;
}

GetDocument() [1/2]

TiXmlDocument* TiXmlNode::GetDocument ( )

inline

                                 {
        return const_cast< TiXmlDocument* >( (const_cast< const TiXmlNode* >(this))->GetDocument() );
    }

GetDocument() [2/2]

const TiXmlDocument * TiXmlNode::GetDocument

(

)

const

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

{
    const TiXmlNode* node;
 
    for( node = this; node; node = node->parent )
    {
        if ( node->ToDocument() )
            return node->ToDocument();
    }
    return 0;
}

Identify()

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

protected

{
    TiXmlNode* returnNode = 0;
 
    p = SkipWhiteSpace( p, encoding );
    if( !p || !*p || *p != '<' )
    {
        return 0;
    }
 
    p = SkipWhiteSpace( p, encoding );
 
    if ( !p || !*p )
    {
        return 0;
    }
 
    // What is this thing? 
    // - Elements start with a letter or underscore, but xml is reserved.
    // - Comments: <!--
    // - Decleration: <?xml
    // - Everthing else is unknown to tinyxml.
    //
 
    const char* xmlHeader = { "<?xml" };
    const char* commentHeader = { "<!--" };
    const char* dtdHeader = { "<!" };
    const char* cdataHeader = { "<![CDATA[" };
 
    if ( StringEqual( p, xmlHeader, true, encoding ) )
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing Declaration\n" );
        #endif
        returnNode = new TiXmlDeclaration();
    }
    else if ( StringEqual( p, commentHeader, false, encoding ) )
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing Comment\n" );
        #endif
        returnNode = new TiXmlComment();
    }
    else if ( StringEqual( p, cdataHeader, false, encoding ) )
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing CDATA\n" );
        #endif
        TiXmlText* text = new TiXmlText( "" );
        text->SetCDATA( true );
        returnNode = text;
    }
    else if ( StringEqual( p, dtdHeader, false, encoding ) )
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing Unknown(1)\n" );
        #endif
        returnNode = new TiXmlUnknown();
    }
    else if (    IsAlpha( *(p+1), encoding )
              || *(p+1) == '_' )
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing Element\n" );
        #endif
        returnNode = new TiXmlElement( "" );
    }
    else
    {
        #ifdef DEBUG_PARSER
            TIXML_LOG( "XML parsing Unknown(2)\n" );
        #endif
        returnNode = new TiXmlUnknown();
    }
 
    if ( returnNode )
    {
        // Set the parent, so it can report errors
        returnNode->parent = this;
    }
    return returnNode;
}

InsertAfterChild()

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.

{
    if ( !afterThis || afterThis->parent != this ) {
        return 0;
    }
    if ( addThis.Type() == TiXmlNode::TINYXML_DOCUMENT )
    {
        if ( GetDocument() ) 
            GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    TiXmlNode* node = addThis.Clone();
    if ( !node )
        return 0;
    node->parent = this;
 
    node->prev = afterThis;
    node->next = afterThis->next;
    if ( afterThis->next )
    {
        afterThis->next->prev = node;
    }
    else
    {
        assert( lastChild == afterThis );
        lastChild = node;
    }
    afterThis->next = node;
    return node;
}

InsertBeforeChild()

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.

{   
    if ( !beforeThis || beforeThis->parent != this ) {
        return 0;
    }
    if ( addThis.Type() == TiXmlNode::TINYXML_DOCUMENT )
    {
        if ( GetDocument() ) 
            GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    TiXmlNode* node = addThis.Clone();
    if ( !node )
        return 0;
    node->parent = this;
 
    node->next = beforeThis;
    node->prev = beforeThis->prev;
    if ( beforeThis->prev )
    {
        beforeThis->prev->next = node;
    }
    else
    {
        assert( firstChild == beforeThis );
        firstChild = node;
    }
    beforeThis->prev = node;
    return node;
}

InsertEndChild()

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.

{
    if ( addThis.Type() == TiXmlNode::TINYXML_DOCUMENT )
    {
        if ( GetDocument() ) 
            GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
    TiXmlNode* node = addThis.Clone();
    if ( !node )
        return 0;
 
    return LinkEndChild( node );
}

IterateChildren() [1/4]

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

inline

                                                                                 {
        return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( _value, previous ) );
    }

IterateChildren() [2/4]

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

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

{
    if ( !previous )
    {
        return FirstChild( val );
    }
    else
    {
        assert( previous->parent == this );
        return previous->NextSibling( val );
    }
}

IterateChildren() [3/4]

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode *  previous )

inline

                                                            {
        return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->IterateChildren( previous ) );
    }

IterateChildren() [4/4]

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.

{
    if ( !previous )
    {
        return FirstChild();
    }
    else
    {
        assert( previous->parent == this );
        return previous->NextSibling();
    }
}

LastChild() [1/4]

TiXmlNode* TiXmlNode::LastChild ( )

inline

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

{ return lastChild; }

LastChild() [2/4]

const TiXmlNode* TiXmlNode::LastChild ( ) const

inline

{ return lastChild; }       

LastChild() [3/4]

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

inline

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

                                                {
        return const_cast< TiXmlNode* > ((const_cast< const TiXmlNode* >(this))->LastChild( _value ));
    }

LastChild() [4/4]

const TiXmlNode * TiXmlNode::LastChild

(

const char *

value

)

const

{
    const TiXmlNode* node;
    for ( node = lastChild; node; node = node->prev )
    {
        if ( strcmp( node->Value(), _value ) == 0 )
            return node;
    }
    return 0;
}

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

{
    assert( node->parent == 0 || node->parent == this );
    assert( node->GetDocument() == 0 || node->GetDocument() == this->GetDocument() );
 
    if ( node->Type() == TiXmlNode::TINYXML_DOCUMENT )
    {
        delete node;
        if ( GetDocument() ) 
            GetDocument()->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    node->parent = this;
 
    node->prev = lastChild;
    node->next = 0;
 
    if ( lastChild )
        lastChild->next = node;
    else
        firstChild = node;          // it was an empty list.
 
    lastChild = node;
    return node;
}

NextSibling() [1/4]

TiXmlNode* TiXmlNode::NextSibling ( )

inline

{ return next; }

NextSibling() [2/4]

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

{ return next; }

NextSibling() [3/4]

const TiXmlNode * TiXmlNode::NextSibling

(

const char *

_value

)

const

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

{
    const TiXmlNode* node;
    for ( node = next; node; node = node->next )
    {
        if ( strcmp( node->Value(), _value ) == 0 )
            return node;
    }
    return 0;
}

NextSibling() [4/4]

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

inline

                                                {
        return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->NextSibling( _next ) );
    }

NextSiblingElement() [1/4]

TiXmlElement* TiXmlNode::NextSiblingElement ( )

inline

                                       {
        return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement() );
    }

NextSiblingElement() [2/4]

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.

{
    const TiXmlNode* node;
 
    for (   node = NextSibling();
            node;
            node = node->NextSibling() )
    {
        if ( node->ToElement() )
            return node->ToElement();
    }
    return 0;
}

NextSiblingElement() [3/4]

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.

{
    const TiXmlNode* node;
 
    for (   node = NextSibling( _value );
            node;
            node = node->NextSibling( _value ) )
    {
        if ( node->ToElement() )
            return node->ToElement();
    }
    return 0;
}

NextSiblingElement() [4/4]

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

inline

                                                          {
        return const_cast< TiXmlElement* >( (const_cast< const TiXmlNode* >(this))->NextSiblingElement( _next ) );
    }

NoChildren()

bool TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

{ return !firstChild; }

operator=()

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

private

Parent() [1/2]

TiXmlNode* TiXmlNode::Parent ( )

inline

One step up the DOM.

{ return parent; }

Parent() [2/2]

const TiXmlNode* TiXmlNode::Parent ( ) const

inline

{ return parent; }

PreviousSibling() [1/4]

TiXmlNode* TiXmlNode::PreviousSibling ( )

inline

{ return prev; }

PreviousSibling() [2/4]

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

{ return prev; }

PreviousSibling() [3/4]

const TiXmlNode * TiXmlNode::PreviousSibling

(

const char *

_value

)

const

Navigate to a sibling node.

{
    const TiXmlNode* node;
    for ( node = prev; node; node = node->prev )
    {
        if ( strcmp( node->Value(), _value ) == 0 )
            return node;
    }
    return 0;
}

PreviousSibling() [4/4]

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

inline

                                                    {
        return const_cast< TiXmlNode* >( (const_cast< const TiXmlNode* >(this))->PreviousSibling( _prev ) );
    }

RemoveChild()

bool TiXmlNode::RemoveChild

(

TiXmlNode *

removeThis

)

Delete a child of this node.

{
    if ( !removeThis ) {
        return false;
    }
 
    if ( removeThis->parent != this )
    {   
        assert( 0 );
        return false;
    }
 
    if ( removeThis->next )
        removeThis->next->prev = removeThis->prev;
    else
        lastChild = removeThis->prev;
 
    if ( removeThis->prev )
        removeThis->prev->next = removeThis->next;
    else
        firstChild = removeThis->next;
 
    delete removeThis;
    return true;
}

ReplaceChild()

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.

{
    if ( !replaceThis )
        return 0;
 
    if ( replaceThis->parent != this )
        return 0;
 
    if ( withThis.ToDocument() ) {
        // A document can never be a child. Thanks to Noam.
        TiXmlDocument* document = GetDocument();
        if ( document ) 
            document->SetError( TIXML_ERROR_DOCUMENT_TOP_ONLY, 0, 0, TIXML_ENCODING_UNKNOWN );
        return 0;
    }
 
    TiXmlNode* node = withThis.Clone();
    if ( !node )
        return 0;
 
    node->next = replaceThis->next;
    node->prev = replaceThis->prev;
 
    if ( replaceThis->next )
        replaceThis->next->prev = node;
    else
        lastChild = node;
 
    if ( replaceThis->prev )
        replaceThis->prev->next = node;
    else
        firstChild = node;
 
    delete replaceThis;
    node->parent = this;
    return node;
}

SetValue()

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

{ value = _value;}

ToComment() [1/2]

virtual TiXmlComment* TiXmlNode::ToComment ( )

inlinevirtual

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

Reimplemented in TiXmlComment.

ToComment() [2/2]

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtual

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

Reimplemented in TiXmlComment.

ToDeclaration() [1/2]

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

ToDeclaration() [2/2]

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

ToDocument() [1/2]

virtual TiXmlDocument* TiXmlNode::ToDocument ( )

inlinevirtual

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

Reimplemented in TiXmlDocument.

ToDocument() [2/2]

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const

inlinevirtual

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

Reimplemented in TiXmlDocument.

ToElement() [1/2]

virtual TiXmlElement* TiXmlNode::ToElement ( )

inlinevirtual

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

Reimplemented in TiXmlElement.

ToElement() [2/2]

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const

inlinevirtual

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

Reimplemented in TiXmlElement.

ToText() [1/2]

virtual TiXmlText* TiXmlNode::ToText ( )

inlinevirtual

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

Reimplemented in TiXmlText.

ToText() [2/2]

virtual const TiXmlText* TiXmlNode::ToText ( ) const

inlinevirtual

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

Reimplemented in TiXmlText.

ToUnknown() [1/2]

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( )

inlinevirtual

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

Reimplemented in TiXmlUnknown.

ToUnknown() [2/2]

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const

inlinevirtual

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

Reimplemented in TiXmlUnknown.

Type()

int TiXmlNode::Type ( ) const

inline

Query the type (as an enumerated value, above) of this node. The possible types are: TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, and TINYXML_DECLARATION.

{ return type; }

Value()

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.

{ return value.c_str (); }

ValueTStr()

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const

inline

{ return value; }

Friends And Related Function Documentation

TiXmlDocument

friend class TiXmlDocument

friend

TiXmlElement

friend class TiXmlElement

friend

Member Data Documentation

firstChild

TiXmlNode* TiXmlNode::firstChild

protected

lastChild

TiXmlNode* TiXmlNode::lastChild

protected

next

TiXmlNode* TiXmlNode::next

protected

parent

TiXmlNode* TiXmlNode::parent

protected

prev

TiXmlNode* TiXmlNode::prev

protected

type

NodeType TiXmlNode::type

protected

value

TIXML_STRING TiXmlNode::value

protected

---

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

• src/libScan/tinyxml.h
• src/libScan/tinyxml.cpp
• src/libScan/tinyxmlparser.cpp