An XML Comment. More...

#include <tinyxml2.h>

Inheritance diagram for XMLComment:

Public Member Functions
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null. More...

virtual const XMLComment *	ToComment () const
virtual bool	Accept (XMLVisitor *visitor) const
	Accept a hierarchical visit of the nodes in the TinyXML DOM. More...

char *	ParseDeep (char , StrPair endTag)
virtual XMLNode *	ShallowClone (XMLDocument *document) const
	Make a copy of this node, but not its children. More...

virtual bool	ShallowEqual (const XMLNode *compare) const
	Test if 2 nodes are the same, but don't test children. More...

Public Member Functions inherited from XMLNode
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

virtual const XMLElement *	ToElement () const
virtual const XMLText *	ToText () const
virtual const XMLDocument *	ToDocument () const
virtual const XMLDeclaration *	ToDeclaration () const
virtual const XMLUnknown *	ToUnknown () 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 XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	Parent ()
bool	NoChildren () const
	Returns true if this node has no children. More...

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists. More...

XMLNode *	FirstChild ()
const XMLElement *	FirstChildElement (const char *value=0) const
	Get the first child element, or optionally the first child element with the specified name. More...

XMLElement *	FirstChildElement (const char *value=0)
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists. More...

XMLNode *	LastChild ()
const XMLElement *	LastChildElement (const char *value=0) const
	Get the last child element or optionally the last child element with the specified name. More...

XMLElement *	LastChildElement (const char *value=0)
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()
const XMLElement *	PreviousSiblingElement (const char *value=0) const
	Get the previous (left) sibling element of this node, with an opitionally supplied name. More...

XMLElement *	PreviousSiblingElement (const char *value=0)
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()
const XMLElement *	NextSiblingElement (const char *value=0) const
	Get the next (right) sibling element of this node, with an opitionally supplied name. More...

XMLElement *	NextSiblingElement (const char *value=0)
XMLNode *	InsertEndChild (XMLNode *addThis)
	Add a child node as the last (right) child. More...

XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
	Add a child node as the first (left) child. More...

XMLNode *	InsertAfterChild (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...

Protected Member Functions
	XMLComment (XMLDocument *doc)
virtual	~XMLComment ()
	XMLComment (const XMLComment &)
XMLComment &	operator= (const XMLComment &)
Protected Member Functions inherited from XMLNode
	XMLNode (XMLDocument *)
virtual	~XMLNode ()
	XMLNode (const XMLNode &)
XMLNode &	operator= (const XMLNode &)

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from XMLNode
XMLDocument *	_document
XMLNode *	_parent
StrPair	_value
XMLNode *	_firstChild
XMLNode *	_lastChild
XMLNode *	_prev
XMLNode *	_next

Detailed Description

An XML Comment.

Constructor & Destructor Documentation

XMLComment ( XMLDocument * doc)

protected

virtual ~XMLComment ( )

protectedvirtual

XMLComment ( const XMLComment & )

protected

Member Function Documentation

virtual bool Accept ( XMLVisitor * visitor) const

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();

Implements XMLNode.

XMLComment& operator= ( const XMLComment & )

protected

char* ParseDeep	(	char *	,
		StrPair *	endTag
	)

virtual

Reimplemented from XMLNode.

virtual XMLNode* ShallowClone ( XMLDocument * document) const

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.

Implements XMLNode.

virtual bool ShallowEqual ( const XMLNode * compare) const

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.

Implements XMLNode.

virtual XMLComment* ToComment ( )

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from XMLNode.

virtual const XMLComment* ToComment ( ) const

inlinevirtual

Reimplemented from XMLNode.

Friends And Related Function Documentation

friend class XMLDocument

friend

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

/Users/cocos2d/MyWork/cocos2d-x/cocos2dx/support/tinyxml2/tinyxml2.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation