Public Member Functions | Protected Member Functions | Private Attributes
TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool Accept (TiXmlVisitor *visitor) const
virtual TiXmlNodeClone () 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, TIXML_STRING *str) const
virtual void Print (FILE *cfile, int depth) const
const char * Standalone () const
 Is this a standalone document?
 TiXmlDeclaration ()
 Construct an empty declaration.
 TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
 Construct.
 TiXmlDeclaration (const TiXmlDeclaration &copy)
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.
const char * Version () const
 Version. Will return an empty string if none was found.
virtual ~TiXmlDeclaration ()

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) 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 1395 of file tinyxml.h.


Constructor & Destructor Documentation

Construct an empty declaration.

Definition at line 1398 of file tinyxml.h.

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

Construct.

Definition at line 1165 of file tinyxml.cpp.

Definition at line 1185 of file tinyxml.cpp.

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

Definition at line 1416 of file tinyxml.h.


Member Function Documentation

bool TiXmlDeclaration::Accept ( TiXmlVisitor visitor) const [virtual]

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

Implements TiXmlNode.

Definition at line 1242 of file tinyxml.cpp.

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

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

Definition at line 1246 of file tinyxml.cpp.

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

Definition at line 1234 of file tinyxml.cpp.

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

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

Definition at line 1424 of file tinyxml.h.

void TiXmlDeclaration::operator= ( const TiXmlDeclaration copy)

Definition at line 1190 of file tinyxml.cpp.

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

Implements TiXmlBase.

Definition at line 1434 of file tinyxmlparser.cpp.

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

Definition at line 1195 of file tinyxml.cpp.

virtual void TiXmlDeclaration::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.

Definition at line 1436 of file tinyxml.h.

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

Is this a standalone document?

Definition at line 1428 of file tinyxml.h.

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

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

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

Definition at line 1420 of file tinyxml.h.


Member Data Documentation

Definition at line 1463 of file tinyxml.h.

Definition at line 1464 of file tinyxml.h.

Definition at line 1462 of file tinyxml.h.


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


appl
Author(s): petercai
autogenerated on Tue Jan 7 2014 11:02:30