XML text. More...

#include <tinyxml.h>

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

virtual	~TiXmlText ()

	TiXmlText (const TiXmlText &copy)

TiXmlText &	operator= (const TiXmlText &base)

virtual void	Print (FILE *cfile, int depth) const
	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. More...

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

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

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

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

virtual bool	Accept (TiXmlVisitor *content) const
	Walk the XML tree visiting this node and all of its children. More...

Public Member Functions inherited from omega::xml::TiXmlNode
virtual	~TiXmlNode ()

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

const TIXML_STRING &	ValueTStr () const

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

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

TiXmlNode *	Parent ()
	One step up the DOM. More...

const TiXmlNode *	Parent () const

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

TiXmlNode *	FirstChild ()

const TiXmlNode *	FirstChild (const char *value) const
	The first child of this node with the matching 'value'. More...

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

const TiXmlNode *	LastChild () const

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

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

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node. More...

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

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

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

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

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

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

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

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

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

TiXmlNode *	PreviousSibling ()

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

TiXmlNode *	PreviousSibling (const char *_prev)

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

TiXmlNode *	NextSibling ()

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

TiXmlNode *	NextSibling (const char *_next)

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

TiXmlElement *	NextSiblingElement ()

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

TiXmlElement *	NextSiblingElement (const char *_next)

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

TiXmlElement *	FirstChildElement ()

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

TiXmlElement *	FirstChildElement (const char *_value)

int	Type () const
	Query the type (as an enumerated value, above) of this node. More...

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

TiXmlDocument *	GetDocument ()

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from omega::xml::TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

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

int	Column () const
	See Row() More...

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

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

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

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

void	CopyTo (TiXmlText *target) const

bool	Blank () const

Protected Member Functions inherited from omega::xml::TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

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

Friends
class	TiXmlElement

Additional Inherited Members
Public Types inherited from omega::xml::TiXmlNode
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from omega::xml::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 omega::xml::TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

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

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string. More...

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

Static Protected Member Functions inherited from omega::xml::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 omega::xml::TiXmlNode
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from omega::xml::TiXmlBase
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer. More...

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

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

Inheritance diagram for omega::xml::TiXmlText:

Constructor & Destructor Documentation

omega::xml::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'

virtual omega::xml::TiXmlText::~TiXmlText ( )

inlinevirtual

omega::xml::TiXmlText::TiXmlText ( const TiXmlText & copy )

inline

Member Function Documentation

virtual bool omega::xml::TiXmlText::Accept ( TiXmlVisitor * content ) const

virtual

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

Implements omega::xml::TiXmlNode.

bool omega::xml::TiXmlText::Blank ( ) const

protected

bool omega::xml::TiXmlText::CDATA ( ) const

inline

Queries whether this represents text using a CDATA section.

virtual TiXmlNode* omega::xml::TiXmlText::Clone ( ) const

protectedvirtual

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

Implements omega::xml::TiXmlNode.

void omega::xml::TiXmlText::CopyTo ( TiXmlText * target ) const

protected

TiXmlText& omega::xml::TiXmlText::operator= ( const TiXmlText & base )

inline

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

virtual

Implements omega::xml::TiXmlBase.

virtual void omega::xml::TiXmlText::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 omega::xml::TiXmlBase.

void omega::xml::TiXmlText::SetCDATA ( bool _cdata )

inline

Turns on or off a CDATA representation of text.

virtual const TiXmlText* omega::xml::TiXmlText::ToText ( ) const

inlinevirtual

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

Reimplemented from omega::xml::TiXmlNode.

virtual TiXmlText* omega::xml::TiXmlText::ToText ( )

inlinevirtual

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

Reimplemented from omega::xml::TiXmlNode.

Friends And Related Function Documentation

friend class TiXmlElement

friend

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

C:/dev/omegalib/release/src/omicron/include/omicron/xml/tinyxml.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation