tinyxml Namespace Reference

Classes
class	TiXmlString
class	TiXmlOutStream
struct	TiXmlCursor
class	TiXmlVisitor
	Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept() method, it requires being passed a TiXmlVisitor class to handle callbacks. More...
class	TiXmlBase
	TiXmlBase is a base class for every class in TinyXml. More...
class	TiXmlNode
	The parent class for everything in the Document Object Model. More...
class	TiXmlAttribute
	An attribute is a name-value pair. More...
class	TiXmlAttributeSet
class	TiXmlElement
	The element is a container class. More...
class	TiXmlComment
	An XML comment. More...
class	TiXmlText
	XML text. More...
class	TiXmlDeclaration
	In correct XML the declaration is the first entry in the file. More...
class	TiXmlUnknown
	Any tag that tinyXml doesn't recognize is saved as an unknown. More...
class	TiXmlDocument
	Always the top level node. More...
class	TiXmlHandle
	A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. More...
class	TiXmlPrinter
	Print to memory functionality. More...
class	TiXmlParsingData

Enumerations
enum	{ TIXML_SUCCESS , TIXML_NO_ATTRIBUTE , TIXML_WRONG_TYPE }
enum	TiXmlEncoding { TIXML_ENCODING_UNKNOWN , TIXML_ENCODING_UTF8 , TIXML_ENCODING_LEGACY }

Functions
bool	operator== (const TiXmlString &a, const TiXmlString &b)
bool	operator< (const TiXmlString &a, const TiXmlString &b)
bool	operator!= (const TiXmlString &a, const TiXmlString &b)
bool	operator> (const TiXmlString &a, const TiXmlString &b)
bool	operator<= (const TiXmlString &a, const TiXmlString &b)
bool	operator>= (const TiXmlString &a, const TiXmlString &b)
bool	operator== (const TiXmlString &a, const char *b)
bool	operator== (const char *a, const TiXmlString &b)
bool	operator!= (const TiXmlString &a, const char *b)
bool	operator!= (const char *a, const TiXmlString &b)
TiXmlString	operator+ (const TiXmlString &a, const TiXmlString &b)
TiXmlString	operator+ (const TiXmlString &a, const char *b)
TiXmlString	operator+ (const char *a, const TiXmlString &b)
std::istream &	operator>> (std::istream &in, TiXmlNode &base)
std::ostream &	operator<< (std::ostream &out, const TiXmlNode &base)
std::string &	operator<< (std::string &out, const TiXmlNode &base)

Variables
const int	TIXML_MAJOR_VERSION = 2
const int	TIXML_MINOR_VERSION = 6
const int	TIXML_PATCH_VERSION = 2
const TiXmlEncoding	TIXML_DEFAULT_ENCODING = TIXML_ENCODING_UNKNOWN

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
TIXML_SUCCESS
TIXML_NO_ATTRIBUTE
TIXML_WRONG_TYPE

Definition at line 129 of file tinyxml.h.

TiXmlEncoding

enum TiXmlEncoding

Enumerator
TIXML_ENCODING_UNKNOWN
TIXML_ENCODING_UTF8
TIXML_ENCODING_LEGACY

Definition at line 138 of file tinyxml.h.

Function Documentation

operator==() [1/3]

bool tinyxml::operator== ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 257 of file tinystr.h.

operator<()

bool tinyxml::operator< ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 262 of file tinystr.h.

operator!=() [1/3]

bool tinyxml::operator!= ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 267 of file tinystr.h.

operator>()

bool tinyxml::operator> ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 268 of file tinystr.h.

operator<=()

bool tinyxml::operator<= ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 269 of file tinystr.h.

operator>=()

bool tinyxml::operator>= ( const TiXmlString &  a, const TiXmlString &  b  )

inline

Definition at line 270 of file tinystr.h.

operator==() [2/3]

bool tinyxml::operator== ( const TiXmlString &  a, const char *  b  )

inline

Definition at line 272 of file tinystr.h.

operator==() [3/3]

bool tinyxml::operator== ( const char *  a, const TiXmlString &  b  )

inline

Definition at line 273 of file tinystr.h.

operator!=() [2/3]

bool tinyxml::operator!= ( const TiXmlString &  a, const char *  b  )

inline

Definition at line 274 of file tinystr.h.

operator!=() [3/3]

bool tinyxml::operator!= ( const char *  a, const TiXmlString &  b  )

inline

Definition at line 275 of file tinystr.h.

operator+() [1/3]

TiXmlString tinyxml::operator+	(	const TiXmlString &	a,
		const TiXmlString &	b
	)

operator+() [2/3]

TiXmlString tinyxml::operator+	(	const TiXmlString &	a,
		const char *	b
	)

operator+() [3/3]

TiXmlString tinyxml::operator+	(	const char *	a,
		const TiXmlString &	b
	)

operator>>()

std::istream& tinyxml::operator>>	(	std::istream &	in,
		TiXmlNode &	base
	)

Tolerant of newlines and formatting, but doesn't expect them.

Definition at line 1555 of file tinyxml.cpp.

operator<<() [1/2]

std::ostream& tinyxml::operator<<	(	std::ostream &	out,
		const TiXmlNode &	base
	)

Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

Definition at line 1566 of file tinyxml.cpp.

operator<<() [2/2]

std::string& tinyxml::operator<<	(	std::string &	out,
		const TiXmlNode &	base
	)

Definition at line 1577 of file tinyxml.cpp.

Variable Documentation

TIXML_MAJOR_VERSION

const int TIXML_MAJOR_VERSION = 2

Definition at line 67 of file tinyxml.h.

TIXML_MINOR_VERSION

const int TIXML_MINOR_VERSION = 6

Definition at line 68 of file tinyxml.h.

TIXML_PATCH_VERSION

const int TIXML_PATCH_VERSION = 2

Definition at line 69 of file tinyxml.h.

TIXML_DEFAULT_ENCODING

const TiXmlEncoding TIXML_DEFAULT_ENCODING = TIXML_ENCODING_UNKNOWN

Definition at line 145 of file tinyxml.h.