#include <tinyxml.h>

Inheritance diagram for TiXmlComment:

Collaboration diagram for TiXmlComment:

Public Member Functions
	TiXmlComment ()
	Constructs an empty comment.

	TiXmlComment (const char *_value)
	Construct a comment from text.

	TiXmlComment (const TiXmlComment &)

TiXmlComment &	operator= (const TiXmlComment &base)

virtual TiXmlNode *	Clone () const
	Returns a copy of this Comment.

virtual void	Print (FILE *cfile, int depth) const

virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)

virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null not of the requested type.

virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null not of the requested type.

virtual bool	Accept (TiXmlVisitor *visitor) const

Public Member Functions inherited from TiXmlNode
const char *	Value () const

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)

void	Clear ()
	Delete all the children of this node. Does not affect 'this'.

TiXmlNode *	Parent ()
	One step up the DOM.

const TiXmlNode *	Parent () const

const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.

TiXmlNode *	FirstChild ()

const TiXmlNode *	FirstChild (const char *value) const

TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found.

const TiXmlNode *	LastChild () const

TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.

const TiXmlNode *	LastChild (const char *value) const

TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children.

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

TiXmlNode *	IterateChildren (const TiXmlNode *previous)

const TiXmlNode *	IterateChildren (const char value, const TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode *	IterateChildren (const char _value, const TiXmlNode previous)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.

const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling ()

const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling (const char *_prev)

const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.

TiXmlNode *	NextSibling ()

const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.

TiXmlNode *	NextSibling (const char *_next)

const TiXmlElement *	NextSiblingElement () const

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement ()

const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement (const char *_value)

int	Type () const

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

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

virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.

Public Member Functions inherited from TiXmlBase
int	Row () const

int	Column () const
	See Row()

void	SetUserData (void *user)
	Set a pointer to arbitrary user data.

void *	GetUserData ()
	Get a pointer to arbitrary user data.

const void *	GetUserData () const
	Get a pointer to arbitrary user data.

Protected Member Functions
void	CopyTo (TiXmlComment *target) const

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }

Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT }

Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

static const char *	ReadName (const char p, TIXML_STRING name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, TIXML_STRING text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

Protected Attributes inherited from TiXmlNode
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer.

Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Detailed Description

An XML comment.

Definition at line 1162 of file tinyxml.h.

Member Function Documentation

bool TiXmlComment::Accept ( TiXmlVisitor * visitor ) const

virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 1314 of file tinyxml.cpp.

 {
      return visitor->Visit( *this );
 }

void TiXmlComment::Print	(	FILE *	cfile,
		int	depth
	)		const

virtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 1297 of file tinyxml.cpp.

 {
      assert( cfile );
      for ( int i=0; i<depth; i++ )
      {
           fprintf( cfile,  "    " );
      }
      fprintf( cfile, "<!--%s-->", value.c_str() );
 }

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

C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxml.h
C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxml.cpp
C:/Users/Brig/Documents/ShapeWorksStudio/src/TinyXML/tinyxmlparser.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation