#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

Collaboration diagram for TiXmlDeclaration:

Public Member Functions
	TiXmlDeclaration ()
	Construct an empty declaration. More...

	TiXmlDeclaration (const std::string &_version, const std::string &_encoding, const std::string &_standalone)
	Constructor. More...

	TiXmlDeclaration (const char _version, const char _encoding, const char *_standalone)
	Construct. More...

	TiXmlDeclaration (const TiXmlDeclaration &copy)

void	operator= (const TiXmlDeclaration &copy)

virtual	~TiXmlDeclaration ()

const char *	Version () const
	Version. Will return an empty string if none was found. More...

const char *	Encoding () const
	Encoding. Will return an empty string if none was found. More...

const char *	Standalone () const
	Is this a standalone document? More...

virtual TiXmlNode *	Clone () const
	Creates a copy of this Declaration and returns it. More...

virtual void	Print (FILE cfile, int depth, TIXML_STRING str) const

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

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

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

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

virtual bool	Accept (TiXmlVisitor *visitor) const

Public Member Functions inherited from TiXmlNode
virtual	~TiXmlNode ()

const char *	Value () const

const std::string &	ValueStr () const

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)

void	SetValue (const std::string &_value)
	STL std::string form. 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

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 *	FirstChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. More...

const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. More...

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

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

const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...

TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. More...

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. 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 *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...

const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...

TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...

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

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...

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)

const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...

TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...

int	Type () const

const TiXmlDocument *	GetDocument () const

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 TiXmlText *	ToText () 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 TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type. More...

Public Member Functions inherited from TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

int	Row () const

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
void	CopyTo (TiXmlDeclaration *target) const

virtual void	StreamIn (std::istream in, TIXML_STRING tag)

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 { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }

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

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 bool	StreamWhiteSpace (std::istream in, TIXML_STRING tag)

static bool	StreamTo (std::istream in, int character, TIXML_STRING tag)

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

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

Detailed Description

In correct XML the declaration is the first entry in the file.

        <?xml version="1.0" standalone="yes"?>

TinyXml will happily read or write files without a declaration, however. There are 3 possible attributes to the declaration: version, encoding, and standalone.

Note: In this version of the code, the attributes are handled as special cases, not generic attributes, simply because there can only be at most 3 and they are always the same.

Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration ( )

inline

Construct an empty declaration.

Referenced by Clone().

TiXmlDeclaration::TiXmlDeclaration	(	const std::string &	_version,
		const std::string &	_encoding,
		const std::string &	_standalone
	)

Constructor.

TiXmlDeclaration::TiXmlDeclaration	(	const char *	_version,
		const char *	_encoding,
		const char *	_standalone
	)

Construct.

TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration & copy )

References CopyTo().

virtual TiXmlDeclaration::~TiXmlDeclaration ( )

inlinevirtual

Member Function Documentation

bool TiXmlDeclaration::Accept ( TiXmlVisitor * visitor ) const

virtual

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

Implements TiXmlNode.

References TiXmlVisitor::Visit().

TiXmlNode * TiXmlDeclaration::Clone ( ) const

virtual

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

References CopyTo(), and TiXmlDeclaration().

void TiXmlDeclaration::CopyTo ( TiXmlDeclaration * target ) const

protected

References TiXmlNode::CopyTo().

Referenced by Clone(), operator=(), and TiXmlDeclaration().

const char* TiXmlDeclaration::Encoding ( ) const

inline

Encoding. Will return an empty string if none was found.

Referenced by TiXmlDocument::Parse().

void TiXmlDeclaration::operator= ( const TiXmlDeclaration & copy )

References TiXmlNode::Clear(), and CopyTo().

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

virtual

Implements TiXmlBase.

References TiXmlNode::GetDocument(), TiXmlBase::IsWhiteSpace(), TiXmlBase::location, TiXmlAttribute::Parse(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_DECLARATION, and TiXmlAttribute::Value().

void TiXmlDeclaration::Print	(	FILE *	cfile,
		int	depth,
		TIXML_STRING *	str
	)		const

virtual

Referenced by Print(), and TiXmlPrinter::Visit().

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

inlinevirtual

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.

References Print().

const char* TiXmlDeclaration::Standalone ( ) const

inline

Is this a standalone document?

void TiXmlDeclaration::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)

protectedvirtual

Implements TiXmlNode.

References c, TiXmlNode::GetDocument(), TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, and TiXmlBase::TIXML_ERROR_EMBEDDED_NULL.

virtual const TiXmlDeclaration* TiXmlDeclaration::ToDeclaration ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

virtual TiXmlDeclaration* TiXmlDeclaration::ToDeclaration ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

const char* TiXmlDeclaration::Version ( ) const

inline

Version. Will return an empty string if none was found.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation