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]

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.
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	StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void	StreamOut (TIXML_OSTREAM *out) const
virtual const char *	Parse (const char *p)
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.

Definition at line 806 of file tinyxml.h.

---

Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration

(

)

[inline]

Construct an empty declaration.

Definition at line 810 of file tinyxml.h.

Referenced by Clone().

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

Constructor.

Definition at line 814 of file tinyxml.h.

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

Construct.

Definition at line 972 of file tinyxml.cpp.

References encoding, standalone, and version.

virtual TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

Definition at line 831 of file tinyxml.h.

---

Member Function Documentation

TiXmlNode * TiXmlDeclaration::Clone

(

)

const [virtual]

Implements TiXmlNode.

Definition at line 1021 of file tinyxml.cpp.

References TiXmlNode::CopyToClone(), encoding, standalone, TiXmlDeclaration(), and version.

const char* TiXmlDeclaration::Encoding

(

)

const [inline]

Encoding. Will return empty if none was found.

Definition at line 836 of file tinyxml.h.

const char * TiXmlDeclaration::Parse

(

const char *

p

)

[protected, virtual]

Implements TiXmlBase.

Definition at line 898 of file tinyxmlparser.cpp.

References encoding, TiXmlNode::GetDocument(), TiXmlAttribute::Parse(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), standalone, TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_DECLARATION, TiXmlAttribute::Value(), and version.

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.

Definition at line 983 of file tinyxml.cpp.

References encoding, standalone, and version.

const char* TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

Definition at line 838 of file tinyxml.h.

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

Implements TiXmlNode.

Definition at line 882 of file tinyxmlparser.cpp.

void TiXmlDeclaration::StreamOut

(

TIXML_OSTREAM *

out

)

const [protected, virtual]

Implements TiXmlBase.

Definition at line 996 of file tinyxml.cpp.

References encoding, TiXmlBase::PutString(), standalone, and version.

const char* TiXmlDeclaration::Version

(

)

const [inline]

Version. Will return empty if none was found.

Definition at line 834 of file tinyxml.h.

---

Field Documentation

TIXML_STRING TiXmlDeclaration::encoding [private]

Definition at line 859 of file tinyxml.h.

Referenced by Clone(), Parse(), Print(), StreamOut(), and TiXmlDeclaration().

TIXML_STRING TiXmlDeclaration::standalone [private]

Definition at line 860 of file tinyxml.h.

Referenced by Clone(), Parse(), Print(), StreamOut(), and TiXmlDeclaration().

TIXML_STRING TiXmlDeclaration::version [private]

Definition at line 858 of file tinyxml.h.

Referenced by Clone(), Parse(), Print(), StreamOut(), and TiXmlDeclaration().

---

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

• applications/sofa/gui/qt/viewer/qtogre/tinyxml.h
• applications/sofa/gui/qt/viewer/qtogre/tinyxml.cpp
• applications/sofa/gui/qt/viewer/qtogre/tinyxmlparser.cpp