TiXmlDeclaration Class Reference

#include <tinyxml.hh>

Inheritance diagram for TiXmlDeclaration:

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.

Definition at line 1133 of file tinyxml.hh.

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.
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.
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
Print this declaration to a FILE stream.
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) const
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void StreamOut (TIXML_OSTREAM *out, int depth) const

Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration ( ) [inline]

Construct an empty declaration.

Definition at line 1137 of file tinyxml.hh.

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 )

virtual TiXmlDeclaration::~TiXmlDeclaration ( ) [inline, virtual]

Definition at line 1154 of file tinyxml.hh.

Member Function Documentation

virtual TiXmlNode* TiXmlDeclaration::Clone ( ) const [virtual]

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

void TiXmlDeclaration::CopyTo ( TiXmlDeclaration * target ) const [protected]

const char* TiXmlDeclaration::Encoding ( ) const [inline]

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

Definition at line 1159 of file tinyxml.hh.

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

virtual const char* TiXmlDeclaration::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)			`[virtual]`

Implements TiXmlBase.

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

Print this declaration to a FILE stream.

Implements TiXmlBase.

const char* TiXmlDeclaration::Standalone ( ) const [inline]

Is this a standalone document?

Definition at line 1161 of file tinyxml.hh.

virtual void TiXmlDeclaration::StreamIn	(	TIXML_ISTREAM *	in,
		TIXML_STRING *	tag
	)			`[protected, virtual]`

Implements TiXmlNode.

virtual void TiXmlDeclaration::StreamOut	(	TIXML_OSTREAM *	out,
		int	depth
	)			const `[protected, virtual]`

Implements TiXmlBase.

const char* TiXmlDeclaration::Version ( ) const [inline]

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

Definition at line 1157 of file tinyxml.hh.

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

/home/tetron/hack/vos/libs/vos/vutil/tinyxml.hh

[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]