TiXmlDeclaration Class Reference
[XML objects]

#include <TinyXML.h>

Inherits TiXmlNode.

---

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.

Public Member Functions
	TiXmlDeclaration ()
	Construct an empty declaration.
	TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
	Construct.
virtual	~TiXmlDeclaration ()
const char *	Version () const
	Version. Will return empty if none was found.
const char *	Encoding () const
	Encoding. Will return empty if none was found.
const char *	Standalone () const
	Is this a standalone document?
virtual TiXmlNode *	Clone () const
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream.
Protected Member Functions
virtual void	StreamOut (TiXmlOutStream *out) const
virtual const char *	Parse (const char *p, TiXmlParsingData *data)
Private Member Functions
	TiXmlDeclaration (const TiXmlDeclaration &copy)
void	operator= (const TiXmlDeclaration &copy)
Private Attributes
TiXmlString	version
TiXmlString	encoding
TiXmlString	standalone

---

Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration

(

)

[inline]

Construct an empty declaration.

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

Construct.

virtual TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

TiXmlDeclaration::TiXmlDeclaration

(

const TiXmlDeclaration &

copy

)

[private]

---

Member Function Documentation

const char* TiXmlDeclaration::Version

(

)

const [inline]

Version. Will return empty if none was found.

const char* TiXmlDeclaration::Encoding

(

)

const [inline]

Encoding. Will return empty if none was found.

const char* TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

virtual TiXmlNode* TiXmlDeclaration::Clone

(

)

const [virtual]

Implements TiXmlNode.

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

All TinyXml classes can print themselves to a filestream.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

virtual void TiXmlDeclaration::StreamOut

(

TiXmlOutStream *

out

)

const [protected, virtual]

Implements TiXmlBase.

virtual const char* TiXmlDeclaration::Parse	(	const char *	p,
		TiXmlParsingData *	data
	)			[protected, virtual]

Implements TiXmlBase.

void TiXmlDeclaration::operator=

(

const TiXmlDeclaration &

copy

)

[private]

---

Field Documentation

TiXmlString TiXmlDeclaration::version [private]

Referenced by Version().

TiXmlString TiXmlDeclaration::encoding [private]

Referenced by Encoding().

TiXmlString TiXmlDeclaration::standalone [private]

Referenced by Standalone().

---

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

• Common/TinyXML/TinyXML.h