tinyxml2::XMLComment Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLComment:

Public Member Functions
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual const XMLComment *	ToComment () const
virtual bool	Accept (XMLVisitor *visitor) const
char *	ParseDeep (char *, StrPair *endTag)
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual bool	ShallowEqual (const XMLNode *compare) const
Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
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
void	SetValue (const char *val, bool staticMem=false)
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
XMLNode *	Parent ()
bool	NoChildren () const
	Returns true if this node has no children.
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
XMLNode *	FirstChild ()
const XMLElement *	FirstChildElement (const char *value=0) const
XMLElement *	FirstChildElement (const char *value=0)
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
XMLNode *	LastChild ()
const XMLElement *	LastChildElement (const char *value=0) const
XMLElement *	LastChildElement (const char *value=0)
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
XMLNode *	PreviousSibling ()
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)
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLNode *	NextSibling ()
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)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
XMLNode *	InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
void	DeleteChildren ()
void	DeleteChild (XMLNode *node)

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

Friends
class	XMLDocument

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

Detailed Description

An XML Comment.

Definition at line 828 of file tinyxml2.h.

Constructor & Destructor Documentation

XMLComment()

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

protected

Definition at line 905 of file tinyxml2.cpp.

~XMLComment()

tinyxml2::XMLComment::~XMLComment ( )

protectedvirtual

Definition at line 910 of file tinyxml2.cpp.

Member Function Documentation

Accept()

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

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

Implements tinyxml2::XMLNode.

Definition at line 943 of file tinyxml2.cpp.

ParseDeep()

char * tinyxml2::XMLComment::ParseDeep ( char *  p, StrPair *  endTag  )

virtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 915 of file tinyxml2.cpp.

ShallowClone()

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.

Definition at line 927 of file tinyxml2.cpp.

ShallowEqual()

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.

Definition at line 937 of file tinyxml2.cpp.

ToComment() [1/2]

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

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 832 of file tinyxml2.h.

ToComment() [2/2]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 835 of file tinyxml2.h.

Friends And Related Symbol Documentation

XMLDocument

friend class XMLDocument

friend

Definition at line 830 of file tinyxml2.h.

---

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

• G:/work/subversion/scol-technologies/trunk/scol/plugins/sXml/include/tinyxml2.h
• G:/work/subversion/scol-technologies/trunk/scol/plugins/sXml/src/tinyxml2.cpp