TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

TiXmlNode TiXmlBase

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, TIXML_STRING *str) const
virtual void Print (FILE *cfile, int depth) const
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.
virtual bool Accept (TiXmlVisitor *visitor) const

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) const
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)

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 (  )  [inline]

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  ) 

virtual ~TiXmlDeclaration (  )  [inline, virtual]

Member Function Documentation

void operator= ( const TiXmlDeclaration &  copy  ) 

const char* Version (  )  const [inline]

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

const char* Encoding (  )  const [inline]

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

const char* Standalone (  )  const [inline]

Is this a standalone document?

TiXmlNode * Clone (  )  const [virtual]

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

void Print ( FILE *  cfile,
int  depth,
TIXML_STRING *  str 
) const [virtual]

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

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

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

Implements TiXmlBase.

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

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

Reimplemented from TiXmlNode.

virtual TiXmlDeclaration* ToDeclaration (  )  [inline, virtual]

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

Reimplemented from TiXmlNode.

bool Accept ( TiXmlVisitor *  visitor  )  const [virtual]

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

void CopyTo ( TiXmlDeclaration *  target  )  const [protected]

void StreamIn ( std::istream *  in,
TIXML_STRING *  tag 
) [protected, virtual]

Implements TiXmlNode.

Member Data Documentation

TIXML_STRING version [private]

TIXML_STRING encoding [private]

TIXML_STRING standalone [private]

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