cocos2d-x  2.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
XMLNode Class Referenceabstract

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. More...

#include <tinyxml2.h>

Inheritance diagram for XMLNode:
XMLComment XMLDeclaration XMLDocument XMLElement XMLText XMLUnknown

Public Member Functions

const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLElementToElement () const
virtual const XMLTextToText () const
virtual const XMLCommentToComment () const
virtual const XMLDocumentToDocument () const
virtual const XMLDeclarationToDeclaration () const
virtual const XMLUnknownToUnknown () const
const char * Value () const
 The meaning of 'value' changes for the specific type. More...
 
void SetValue (const char *val, bool staticMem=false)
 Set the Value of an XML node. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
const XMLElementFirstChildElement (const char *value=0) const
 Get the first child element, or optionally the first child element with the specified name. More...
 
XMLElementFirstChildElement (const char *value=0)
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
const XMLElementLastChildElement (const char *value=0) const
 Get the last child element or optionally the last child element with the specified name. More...
 
XMLElementLastChildElement (const char *value=0)
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
const XMLElementPreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *value=0)
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
const XMLElementNextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementNextSiblingElement (const char *value=0)
XMLNodeInsertEndChild (XMLNode *addThis)
 Add a child node as the last (right) child. More...
 
XMLNodeLinkEndChild (XMLNode *addThis)
XMLNodeInsertFirstChild (XMLNode *addThis)
 Add a child node as the first (left) child. More...
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 Add a node after the specified child node. More...
 
void DeleteChildren ()
 Delete all the children of this node. More...
 
void DeleteChild (XMLNode *node)
 Delete a child of this node. More...
 
virtual XMLNodeShallowClone (XMLDocument *document) const =0
 Make a copy of this node, but not its children. More...
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 Test if 2 nodes are the same, but don't test children. More...
 
virtual bool Accept (XMLVisitor *visitor) const =0
 Accept a hierarchical visit of the nodes in the TinyXML DOM. More...
 
virtual char * ParseDeep (char *, StrPair *)

Protected Member Functions

 XMLNode (XMLDocument *)
virtual ~XMLNode ()
 XMLNode (const XMLNode &)
XMLNodeoperator= (const XMLNode &)

Protected Attributes

XMLDocument_document
XMLNode_parent
StrPair _value
XMLNode_firstChild
XMLNode_lastChild
XMLNode_prev
XMLNode_next

Friends

class XMLDocument
class XMLElement

Detailed Description

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes.

Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

Constructor & Destructor Documentation

XMLNode ( XMLDocument )
protected
virtual ~XMLNode ( )
protectedvirtual
XMLNode ( const XMLNode )
protected

Member Function Documentation

virtual bool Accept ( XMLVisitor visitor) const
pure virtual

Accept a hierarchical visit of 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 XMLDocument, XMLElement, XMLUnknown, XMLDeclaration, XMLComment, and XMLText.

void DeleteChild ( XMLNode node)

Delete a child of this node.

void DeleteChildren ( )

Delete all the children of this node.

const XMLNode* FirstChild ( ) const
inline

Get the first child node, or null if none exists.

XMLNode* FirstChild ( )
inline
const XMLElement* FirstChildElement ( const char *  value = 0) const

Get the first child element, or optionally the first child element with the specified name.

XMLElement* FirstChildElement ( const char *  value = 0)
inline
const XMLDocument* GetDocument ( ) const
inline

Get the XMLDocument that owns this XMLNode.

XMLDocument* GetDocument ( )
inline

Get the XMLDocument that owns this XMLNode.

XMLNode* InsertAfterChild ( XMLNode afterThis,
XMLNode addThis 
)

Add a node after the specified child node.

XMLNode* InsertEndChild ( XMLNode addThis)

Add a child node as the last (right) child.

XMLNode* InsertFirstChild ( XMLNode addThis)

Add a child node as the first (left) child.

const XMLNode* LastChild ( ) const
inline

Get the last child node, or null if none exists.

XMLNode* LastChild ( )
inline
const XMLElement* LastChildElement ( const char *  value = 0) const

Get the last child element or optionally the last child element with the specified name.

XMLElement* LastChildElement ( const char *  value = 0)
inline
XMLNode* LinkEndChild ( XMLNode addThis)
inline
const XMLNode* NextSibling ( ) const
inline

Get the next (right) sibling node of this node.

XMLNode* NextSibling ( )
inline
const XMLElement*
NextSiblingElement
( const char *  value = 0) const

Get the next (right) sibling element of this node, with an opitionally supplied name.

XMLElement* NextSiblingElement ( const char *  value = 0)
inline
bool NoChildren ( ) const
inline

Returns true if this node has no children.

XMLNode& operator= ( const XMLNode )
protected
const XMLNode* Parent ( ) const
inline

Get the parent of this node on the DOM.

XMLNode* Parent ( )
inline
virtual char* ParseDeep ( char *  ,
StrPair  
)
virtual
const XMLNode* PreviousSibling ( ) const
inline

Get the previous (left) sibling node of this node.

XMLNode* PreviousSibling ( )
inline
const XMLElement*
PreviousSiblingElement
( const char *  value = 0) const

Get the previous (left) sibling element of this node, with an opitionally supplied name.

XMLElement* PreviousSiblingElement ( const char *  value = 0)
inline
void SetValue ( const char *  val,
bool  staticMem = false 
)

Set the Value of an XML node.

See Also
Value()
virtual XMLNode* ShallowClone ( XMLDocument document) const
pure virtual

Make a copy of this node, but not its children.

You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implemented in XMLDocument, XMLElement, XMLUnknown, XMLDeclaration, XMLComment, and XMLText.

virtual bool ShallowEqual ( const XMLNode compare) const
pure virtual

Test if 2 nodes are the same, but don't test children.

The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implemented in XMLDocument, XMLElement, XMLUnknown, XMLDeclaration, XMLComment, and XMLText.

virtual XMLComment* ToComment ( )
inlinevirtual

Safely cast to a Comment, or null.

Reimplemented in XMLComment.

virtual const XMLComment* ToComment ( ) const
inlinevirtual

Reimplemented in XMLComment.

virtual XMLDeclaration*
ToDeclaration
( )
inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in XMLDeclaration.

virtual const XMLDeclaration*
ToDeclaration
( ) const
inlinevirtual

Reimplemented in XMLDeclaration.

virtual XMLDocument* ToDocument ( )
inlinevirtual

Safely cast to a Document, or null.

Reimplemented in XMLDocument.

virtual const XMLDocument*
ToDocument
( ) const
inlinevirtual

Reimplemented in XMLDocument.

virtual XMLElement* ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented in XMLElement.

virtual const XMLElement* ToElement ( ) const
inlinevirtual

Reimplemented in XMLElement.

virtual XMLText* ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented in XMLText.

virtual const XMLText* ToText ( ) const
inlinevirtual

Reimplemented in XMLText.

virtual XMLUnknown* ToUnknown ( )
inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in XMLUnknown.

virtual const XMLUnknown* ToUnknown ( ) const
inlinevirtual

Reimplemented in XMLUnknown.

const char* Value ( ) const
inline

The meaning of 'value' changes for the specific type.

Document:   empty
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

Friends And Related Function Documentation

friend class XMLDocument
friend
friend class XMLElement
friend

Member Data Documentation

XMLDocument* _document
protected
XMLNode* _firstChild
protected
XMLNode* _lastChild
protected
XMLNode* _next
protected
XMLNode* _parent
protected
XMLNode* _prev
protected
StrPair _value
mutableprotected

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