An XML Comment. More...

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLComment:

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
	Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. More...

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

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

virtual const XMLComment *	ToComment () const

Public Member Functions inherited from tinyxml2::XMLNode
XMLNode *	DeepClone (XMLDocument *target) const
	Make a copy of this node and all its children. More...

void	DeleteChild (XMLNode *node)
	Delete a child of this node. More...

void	DeleteChildren ()
	Delete all the children of this node. More...

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

XMLNode *	FirstChild ()

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

XMLElement *	FirstChildElement (const char *name=0)

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

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

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file. More...

void *	GetUserData () const
	Get user data set into the XMLNode. More...

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
	Add a node after the specified child node. More...

XMLNode *	InsertEndChild (XMLNode *addThis)
	Add a child node as the last (right) child. More...

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

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

XMLNode *	LastChild ()

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

XMLElement *	LastChildElement (const char *name=0)

XMLNode *	LinkEndChild (XMLNode *addThis)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()

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

XMLElement *	NextSiblingElement (const char *name=0)

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

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	Parent ()

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()

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

XMLElement *	PreviousSiblingElement (const char *name=0)

void	SetUserData (void *userData)
	Set user data into the XMLNode. More...

void	SetValue (const char *val, bool staticMem=false)
	Set the Value of an XML node. More...

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

virtual const XMLDeclaration *	ToDeclaration () const

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

virtual const XMLDocument *	ToDocument () const

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

virtual const XMLElement *	ToElement () const

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

virtual const XMLText *	ToText () const

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

virtual const XMLUnknown *	ToUnknown () const

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

Protected Member Functions
	XMLComment (XMLDocument *doc)

virtual	~XMLComment ()

char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)

Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

Private Member Functions
	XMLComment (const XMLComment &)

XMLComment &	operator= (const XMLComment &)

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_next

XMLNode *	_parent

int	_parseLineNum

XMLNode *	_prev

void *	_userData

StrPair	_value

Detailed Description

An XML Comment.

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

tinyxml2::XMLComment::XMLComment ( XMLDocument * doc )

explicitprotected

◆ ~XMLComment()

virtual tinyxml2::XMLComment::~XMLComment ( )

protectedvirtual

◆ XMLComment() [2/2]

tinyxml2::XMLComment::XMLComment ( const XMLComment & )

private

Member Function Documentation

◆ Accept()

virtual bool tinyxml2::XMLComment::Accept ( XMLVisitor * visitor ) const

virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM.

Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

◆ operator=()

XMLComment& tinyxml2::XMLComment::operator= ( const XMLComment & )

private

◆ ParseDeep()

char* tinyxml2::XMLComment::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ ShallowClone()

virtual XMLNode* tinyxml2::XMLComment::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 tinyxml2::XMLNode.

◆ ShallowEqual()

virtual bool tinyxml2::XMLComment::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 tinyxml2::XMLNode.

◆ ToComment() [1/2]

virtual XMLComment* tinyxml2::XMLComment::ToComment ( )

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

◆ ToComment() [2/2]

virtual const XMLComment* tinyxml2::XMLComment::ToComment ( ) const

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument

friend

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

include/tinyxml2.h

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

◆ ~XMLComment()

◆ XMLComment() [2/2]

Member Function Documentation

◆ Accept()

◆ operator=()

◆ ParseDeep()

◆ ShallowClone()

◆ ShallowEqual()

◆ ToComment() [1/2]

◆ ToComment() [2/2]

Friends And Related Function Documentation

◆ XMLDocument