DataDirector API
Public Member Functions | List of all members
TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlDeclaration ()
 Construct an empty declaration.
 
 TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
 Construct.
 
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.
 
- Public Member Functions inherited from TiXmlNode
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNode * Parent ()
 One step up the DOM.
 
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.
 
const TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNode * FirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children.
 
TiXmlNode * LastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
 
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
 
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
 
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
 
const TiXmlNode * NextSibling () const
 Navigate to a sibling node.
 
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
const TiXmlElement * NextSiblingElement () const
 
const TiXmlElement * NextSiblingElement (const char *) const
 
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
 
const TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements.
 
virtual int Type () const
 
const TiXmlDocument * GetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children.
 
const TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlText * ToText () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlText * ToText ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDeclaration * ToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 See Row()
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Protected Attributes inherited from TiXmlBase
void * userData
 Field containing a generic user pointer.
 

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.


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