TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

Collaboration diagram for TiXmlDeclaration:

List of all members.

Public Member Functions

• TiXmlDeclaration ()

  Construct an empty declaration.
  

• 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 StreamOut (TiXmlOutStream *out) const

Private Attributes

• TiXmlString version
• TiXmlString encoding
• TiXmlString 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.

Referenced by Clone().

Here is the caller graph for this function:

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

Construct.

References encoding, standalone, and version.

TiXmlDeclaration::TiXmlDeclaration

(

const TiXmlDeclaration &

copy

)

References CopyTo().

Here is the call graph for this function:

virtual TiXmlDeclaration::~TiXmlDeclaration

(

)

[inline, virtual]

---

Member Function Documentation

void TiXmlDeclaration::operator=

(

const TiXmlDeclaration &

copy

)

References TiXmlNode::Clear(), and CopyTo().

Here is the call graph for this function:

const char* TiXmlDeclaration::Version

(

)

const [inline]

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

References TiXmlString::c_str(), and version.

Here is the call graph for this function:

const char* TiXmlDeclaration::Encoding

(

)

const [inline]

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

References TiXmlString::c_str(), and encoding.

Referenced by TiXmlDocument::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

const char* TiXmlDeclaration::Standalone

(

)

const [inline]

Is this a standalone document?

References TiXmlString::c_str(), and standalone.

Here is the call graph for this function:

TiXmlNode * TiXmlDeclaration::Clone

(

)

const [virtual]

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

References CopyTo(), and TiXmlDeclaration().

Here is the call graph for this function:

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

Print this declaration to a FILE stream.

Implements TiXmlBase.

References TiXmlString::c_str(), TiXmlString::empty(), encoding, standalone, and version.

Here is the call graph for this function:

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

Implements TiXmlBase.

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

Here is the call graph for this function:

void TiXmlDeclaration::CopyTo

(

TiXmlDeclaration *

target

)

const [protected]

References encoding, standalone, and version.

Referenced by Clone(), operator=(), and TiXmlDeclaration().

Here is the caller graph for this function:

void TiXmlDeclaration::StreamOut

(

TiXmlOutStream *

out

)

const [protected, virtual]

Implements TiXmlBase.

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

Here is the call graph for this function:

---

Member Data Documentation

TiXmlString TiXmlDeclaration::version [private]

Referenced by CopyTo(), Parse(), Print(), StreamOut(), TiXmlDeclaration(), and Version().

TiXmlString TiXmlDeclaration::encoding [private]

Referenced by CopyTo(), Encoding(), Parse(), Print(), StreamOut(), and TiXmlDeclaration().

TiXmlString TiXmlDeclaration::standalone [private]

Referenced by CopyTo(), Parse(), Print(), Standalone(), StreamOut(), and TiXmlDeclaration().

---

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

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