#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

Public Member Functions
	TiXmlDeclaration ()
	Construct an empty declaration.

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

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

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

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

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

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

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

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

virtual TiXmlDeclaration *	ToDeclaration ()
	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 std::string &	ValueStr () const

void	SetValue (const char *_value)

void	SetValue (const std::string &_value)
	STL std::string form.

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

TiXmlNode *	Parent ()
	One step up the DOM.

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

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.

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

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

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

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

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

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

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

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

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

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

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.

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

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

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

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

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

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

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

const TiXmlElement *	NextSiblingElement () const

const TiXmlElement *	NextSiblingElement (const char *) const

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

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

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

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

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

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

int	Type () const

const TiXmlDocument *	GetDocument () const

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 TiXmlText *	ToText () 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 TiXmlText *	ToText ()
	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.

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType

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

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

Protected Attributes inherited from TiXmlBase
void *	userData
	Field containing a generic user pointer.

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.

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

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.

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

tinyxml.h
tinyxml.cc
tinyxmlparser.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation