#include <tinyxml.h>

Detailed Description

XML text.

A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCDATA() and query it with CDATA().

Inherits TiXmlNode.

Public Member Functions
	TiXmlText (const char *initValue)
	Constructor for text element.

virtual	~TiXmlText ()

	TiXmlText (const TiXmlText &copy)

void	operator= (const TiXmlText &base)

virtual void	Print (const Ptr< IO::TextWriter > &textWriter, int depth) const
	Write this text object to a FILE stream.

bool	CDATA ()
	Queries whether this represents text using a CDATA section.

void	SetCDATA (bool _cdata)
	Turns on or off a CDATA representation of text.

bool	Raw ()
	Queries whether the text in this node is raw, meaning that it shouldn't be treated by any encoding.

void	SetRaw (bool _raw)
	Turns on or off a raw representation of text.

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

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

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

Public Member Functions inherited from TiXmlNode
virtual	~TiXmlNode ()

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

void	SetValue (const char *_value)
	Changes the value of the node.

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
	The first child of this node with the matching 'value'. Will be null if none found.

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
	An alternate way to walk the children of a node.

TiXmlNode *	IterateChildren (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, TiXmlNode previous)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this.

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this.

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this.

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this.

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node.

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 *)

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 *)

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

TiXmlElement *	NextSiblingElement ()

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

TiXmlElement *	NextSiblingElement (const char *)

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
	Query the type (as an enumerated value, above) of this node.

const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in.

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 TiXmlComment *	ToComment () 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 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 TiXmlComment *	ToComment ()
	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 TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.

Public Member Functions inherited from TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

int	Row () const
	Return the position, in the original source file, of this node or attribute.

int	Column () const
	See Row()

void	SetUserData (void *user)

void *	GetUserData ()

Protected Member Functions
virtual TiXmlNode *	Clone () const
	[internal use] Creates a new Element and returns it.

void	CopyTo (TiXmlText *target) const

virtual void	StreamOut (TIXML_OSTREAM *out) const

bool	Blank () const

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

Private Attributes
bool	cdata

bool	raw

Friends
class	TiXmlElement

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { DOCUMENT , ELEMENT , COMMENT , UNKNOWN , TEXT , DECLARATION , TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0 , TIXML_ERROR , TIXML_ERROR_OPENING_FILE , TIXML_ERROR_OUT_OF_MEMORY , 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_STRING_COUNT }

Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.

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

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 void	PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)

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

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]

Constructor & Destructor Documentation

◆ TiXmlText() [1/2]

TiXmlText::TiXmlText ( const char * initValue )

inline

Constructor for text element.

By default, it is treated as normal, encoded text. If you want it be output as a CDATA text element, set the parameter _cdata to 'true'

◆ ~TiXmlText()

virtual TiXmlText::~TiXmlText ( )

inlinevirtual

◆ TiXmlText() [2/2]

TiXmlText::TiXmlText ( const TiXmlText & copy )

inline

Member Function Documentation

◆ Blank()

bool TiXmlText::Blank ( ) const

protected

◆ CDATA()

bool TiXmlText::CDATA ( )

inline

Queries whether this represents text using a CDATA section.

◆ Clone()

TiXmlNode * TiXmlText::Clone ( ) const

protectedvirtual

[internal use] Creates a new Element and returns it.

Implements TiXmlNode.

◆ CopyTo()

void TiXmlText::CopyTo ( TiXmlText * target ) const

protected

◆ operator=()

void TiXmlText::operator= ( const TiXmlText & base )

inline

◆ Parse()

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

virtual

Implements TiXmlBase.

◆ Print()

void TiXmlText::Print	(	const Ptr< IO::TextWriter > &	textWriter,
		int	depth ) const

virtual

Write this text object to a FILE stream.

Implements TiXmlBase.

◆ Raw()

bool TiXmlText::Raw ( )

inline

Queries whether the text in this node is raw, meaning that it shouldn't be treated by any encoding.

◆ SetCDATA()

void TiXmlText::SetCDATA ( bool _cdata )

inline

Turns on or off a CDATA representation of text.

◆ SetRaw()

void TiXmlText::SetRaw ( bool _raw )

inline

Turns on or off a raw representation of text.

◆ StreamOut()

void TiXmlText::StreamOut ( TIXML_OSTREAM * out ) const

protectedvirtual

Implements TiXmlBase.

◆ ToText() [1/2]

virtual TiXmlText * TiXmlText::ToText ( )

inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

◆ ToText() [2/2]

virtual const TiXmlText * TiXmlText::ToText ( ) const

inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Friends And Related Symbol Documentation

◆ TiXmlElement

friend class TiXmlElement

friend

Member Data Documentation

◆ cdata

bool TiXmlText::cdata

private

◆ raw

bool TiXmlText::raw

private

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

/github/workspace/code/addons/tinyxml/tinyxml.h
/github/workspace/code/addons/tinyxml/tinyxml.cc
/github/workspace/code/addons/tinyxml/tinyxmlparser.cc

Detailed Description

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TiXmlText() [1/2]

◆ ~TiXmlText()

◆ TiXmlText() [2/2]

Member Function Documentation

◆ Blank()

◆ CDATA()

◆ Clone()

◆ CopyTo()

◆ operator=()

◆ Parse()

◆ Print()

◆ Raw()

◆ SetCDATA()

◆ SetRaw()

◆ StreamOut()

◆ ToText() [1/2]

◆ ToText() [2/2]

Friends And Related Symbol Documentation

◆ TiXmlElement

Member Data Documentation

◆ cdata

◆ raw