#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLComment:

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
virtual bool	Accept (XMLVisitor *visitor) const
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual bool	ShallowEqual (const XMLNode *compare) const
virtual bool	ShallowEqual (const XMLNode *compare) const
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual const XMLComment *	ToComment () const
virtual const XMLComment *	ToComment () const
Public Member Functions inherited from tinyxml2::XMLNode
XMLNode *	DeepClone (XMLDocument *target) const
XMLNode *	DeepClone (XMLDocument *target) const
void	DeleteChild (XMLNode *node)
void	DeleteChild (XMLNode *node)
void	DeleteChildren ()
void	DeleteChildren ()
XMLNode *	FirstChild ()
XMLNode *	FirstChild ()
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
XMLElement *	FirstChildElement (const char *name=0)
XMLElement *	FirstChildElement (const char *name=0)
const XMLElement *	FirstChildElement (const char *name=0) const
const XMLElement *	FirstChildElement (const char *name=0) const
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.
int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.
void *	GetUserData () const
void *	GetUserData () const
XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
XMLNode *	LastChild ()
XMLNode *	LastChild ()
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
XMLElement *	LastChildElement (const char *name=0)
XMLElement *	LastChildElement (const char *name=0)
const XMLElement *	LastChildElement (const char *name=0) const
const XMLElement *	LastChildElement (const char *name=0) const
XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	NextSibling ()
XMLNode *	NextSibling ()
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLElement *	NextSiblingElement (const char *name=0)
XMLElement *	NextSiblingElement (const char *name=0)
const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.
const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.
bool	NoChildren () const
	Returns true if this node has no children.
bool	NoChildren () const
	Returns true if this node has no children.
XMLNode *	Parent ()
XMLNode *	Parent ()
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
XMLNode *	PreviousSibling ()
XMLNode *	PreviousSibling ()
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
XMLElement *	PreviousSiblingElement (const char *name=0)
XMLElement *	PreviousSiblingElement (const char *name=0)
const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.
const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.
void	SetUserData (void *userData)
void	SetUserData (void *userData)
void	SetValue (const char *val, bool staticMem=false)
void	SetValue (const char *val, bool staticMem=false)
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual const XMLDeclaration *	ToDeclaration () const
virtual const XMLDeclaration *	ToDeclaration () const
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
virtual const XMLDocument *	ToDocument () const
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual const XMLElement *	ToElement () const
virtual const XMLElement *	ToElement () const
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual const XMLText *	ToText () const
virtual const XMLText *	ToText () const
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual const XMLUnknown *	ToUnknown () const
virtual const XMLUnknown *	ToUnknown () const
const char *	Value () const
const char *	Value () const

Protected Member Functions
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)
	XMLComment (XMLDocument *doc)
	XMLComment (XMLDocument *doc)
virtual	~XMLComment ()
virtual	~XMLComment ()
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)
	XMLNode (XMLDocument *)
virtual	~XMLNode ()
virtual	~XMLNode ()

Private Member Functions
XMLComment &	operator= (const XMLComment &)
XMLComment &	operator= (const XMLComment &)
	XMLComment (const XMLComment &)
	XMLComment (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.

Definition at line 1031 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLComment() [1/4]

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

explicitprotected

◆ ~XMLComment() [1/2]

virtual tinyxml2::XMLComment::~XMLComment ( )

protectedvirtual

◆ XMLComment() [2/4]

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

private

◆ XMLComment() [3/4]

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

explicitprotected

◆ ~XMLComment() [2/2]

virtual tinyxml2::XMLComment::~XMLComment ( )

protectedvirtual

◆ XMLComment() [4/4]

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

private

Member Function Documentation

◆ Accept() [1/2]

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.

◆ Accept() [2/2]

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=() [1/2]

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

private

◆ operator=() [2/2]

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

private

◆ ParseDeep() [1/2]

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

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ ParseDeep() [2/2]

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

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ ShallowClone() [1/2]

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.

◆ ShallowClone() [2/2]

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() [1/2]

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.

◆ ShallowEqual() [2/2]

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/4]

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

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1035 of file tinyxml2.h.

◆ ToComment() [2/4]

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

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1035 of file tinyxml2.h.

◆ ToComment() [3/4]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1038 of file tinyxml2.h.

◆ ToComment() [4/4]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1038 of file tinyxml2.h.

◆ XMLDocument

XMLDocument

friend

Definition at line 1033 of file tinyxml2.h.

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

tinyxml2/tinyxml2.h
XML/tinyxml2.h

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLComment() [1/4]

◆ ~XMLComment() [1/2]

◆ XMLComment() [2/4]

◆ XMLComment() [3/4]

◆ ~XMLComment() [2/2]

◆ XMLComment() [4/4]

Member Function Documentation

◆ Accept() [1/2]

◆ Accept() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ParseDeep() [1/2]

◆ ParseDeep() [2/2]

◆ ShallowClone() [1/2]

◆ ShallowClone() [2/2]

◆ ShallowEqual() [1/2]

◆ ShallowEqual() [2/2]

◆ ToComment() [1/4]

◆ ToComment() [2/4]

◆ ToComment() [3/4]

◆ ToComment() [4/4]

Friends And Related Symbol Documentation

◆ XMLDocument