RTT::marsh::TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlDeclaration:

[legend]

List of all members.

Public Member Functions
virtual TiXmlNode *	Clone () const
	Creates a copy of this Declaration and returns it.
const char *	Encoding () const
	Encoding. Will return an empty string if none was found.
void	operator= (const TiXmlDeclaration &copy)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
	Print this declaration to a FILE stream.
const char *	Standalone () const
	Is this a standalone document?
	TiXmlDeclaration (const TiXmlDeclaration &copy)
	TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
	Construct.
	TiXmlDeclaration ()
	Construct an empty declaration.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.
const char *	Version () const
	Version. Will return an empty string if none was found.
virtual	~TiXmlDeclaration ()
Protected Member Functions
void	CopyTo (TiXmlDeclaration *target) const
virtual void	StreamOut (TIXML_OSTREAM *out) const
Private Attributes
TIXML_STRING	encoding
TIXML_STRING	standalone
TIXML_STRING	version

---

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 1160 of file tinyxml.h.

---

Constructor & Destructor Documentation

RTT::marsh::TiXmlDeclaration::TiXmlDeclaration

(

)

[inline]

Construct an empty declaration.

Definition at line 1164 of file tinyxml.h.

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

Construct.

Definition at line 1487 of file tinyxml.cpp.

RTT::marsh::TiXmlDeclaration::TiXmlDeclaration

(

const TiXmlDeclaration &

copy

)

Definition at line 1511 of file tinyxml.cpp.

virtual RTT::marsh::TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

Definition at line 1181 of file tinyxml.h.

---

Member Function Documentation

TiXmlNode * RTT::marsh::TiXmlDeclaration::Clone

(

)

const [virtual]

Creates a copy of this Declaration and returns it.

Implements RTT::marsh::TiXmlNode.

Definition at line 1574 of file tinyxml.cpp.

void RTT::marsh::TiXmlDeclaration::CopyTo

(

TiXmlDeclaration *

target

)

const [protected]

Definition at line 1564 of file tinyxml.cpp.

const char* RTT::marsh::TiXmlDeclaration::Encoding

(

)

const [inline]

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

Definition at line 1186 of file tinyxml.h.

void RTT::marsh::TiXmlDeclaration::operator=

(

const TiXmlDeclaration &

copy

)

Definition at line 1518 of file tinyxml.cpp.

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

Implements RTT::marsh::TiXmlBase.

Definition at line 1554 of file tinyxmlparser.cpp.

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

Print this declaration to a FILE stream.

Implements RTT::marsh::TiXmlBase.

Definition at line 1525 of file tinyxml.cpp.

const char* RTT::marsh::TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

Definition at line 1188 of file tinyxml.h.

void RTT::marsh::TiXmlDeclaration::StreamOut

(

TIXML_OSTREAM *

out

)

const [protected, virtual]

Implements RTT::marsh::TiXmlBase.

Definition at line 1538 of file tinyxml.cpp.

virtual TiXmlDeclaration* RTT::marsh::TiXmlDeclaration::ToDeclaration

(

)

[inline, virtual]

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1198 of file tinyxml.h.

virtual const TiXmlDeclaration* RTT::marsh::TiXmlDeclaration::ToDeclaration

(

)

const [inline, virtual]

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1197 of file tinyxml.h.

const char* RTT::marsh::TiXmlDeclaration::Version

(

)

const [inline]

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

Definition at line 1184 of file tinyxml.h.

---

Member Data Documentation

TIXML_STRING RTT::marsh::TiXmlDeclaration::encoding [private]

Definition at line 1211 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlDeclaration::standalone [private]

Definition at line 1212 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlDeclaration::version [private]

Definition at line 1210 of file tinyxml.h.

---

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

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