TiXmlDeclaration Class Reference

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

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

[legend]Collaboration diagram for TiXmlDeclaration:

[legend]List of all members.

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)
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.
Protected Member Functions
void	CopyTo (TiXmlDeclaration *target) const
virtual void	StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void	StreamOut (TIXML_OSTREAM *out) const
Private Attributes
TIXML_STRING	version
TIXML_STRING	encoding
TIXML_STRING	standalone

---

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.

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]

---

Member Function Documentation

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.

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

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

Implements TiXmlBase.

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?

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

Implements TiXmlNode.

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

Implements TiXmlBase.

virtual TiXmlDeclaration* TiXmlDeclaration::ToDeclaration (   )  [inline, virtual]

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

virtual const TiXmlDeclaration* TiXmlDeclaration::ToDeclaration (   )  const [inline, virtual]

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.

---

Member Data Documentation

TIXML_STRING TiXmlDeclaration::encoding [private]

TIXML_STRING TiXmlDeclaration::standalone [private]

TIXML_STRING TiXmlDeclaration::version [private]

---

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

• tinyxml.h
• tinyxml.cpp
• tinyxmlparser.cpp

---