TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

Inheritance graph
[legend]
Collaboration diagram for TiXmlDeclaration:

Collaboration graph
[legend]

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 TiXmlNodeClone () 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 TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) const
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.

Definition at line 1120 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlDeclaration::TiXmlDeclaration (  )  [inline]

Construct an empty declaration.

Definition at line 1124 of file tinyxml.h.

Referenced by Clone().

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

Construct.

Definition at line 1448 of file tinyxml.cpp.

References encoding, standalone, and version.

TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration copy  ) 

Definition at line 1472 of file tinyxml.cpp.

References CopyTo().

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

Definition at line 1141 of file tinyxml.h.


Member Function Documentation

void TiXmlDeclaration::operator= ( const TiXmlDeclaration copy  ) 

Definition at line 1479 of file tinyxml.cpp.

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

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

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

Definition at line 1144 of file tinyxml.h.

References version.

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

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

Definition at line 1146 of file tinyxml.h.

References encoding.

Referenced by TiXmlDocument::Parse().

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

Is this a standalone document?

Definition at line 1148 of file tinyxml.h.

References standalone.

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

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

Definition at line 1535 of file tinyxml.cpp.

References CopyTo(), and TiXmlDeclaration().

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

Print this declaration to a FILE stream.

Implements TiXmlBase.

Definition at line 1486 of file tinyxml.cpp.

References encoding, standalone, and version.

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

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.

Definition at line 1157 of file tinyxml.h.

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

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

Reimplemented from TiXmlNode.

Definition at line 1158 of file tinyxml.h.

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

Definition at line 1525 of file tinyxml.cpp.

References TiXmlNode::CopyTo(), encoding, standalone, and version.

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

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

Implements TiXmlBase.

Definition at line 1499 of file tinyxml.cpp.

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


Member Data Documentation

TIXML_STRING TiXmlDeclaration::version [private]

Definition at line 1170 of file tinyxml.h.

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

TIXML_STRING TiXmlDeclaration::encoding [private]

Definition at line 1171 of file tinyxml.h.

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

TIXML_STRING TiXmlDeclaration::standalone [private]

Definition at line 1172 of file tinyxml.h.

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


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

Generated on Tue May 22 06:00:31 2012 for cpp by  doxygen 1.5.6