Luiza  v03-01
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 std::string &_version, const std::string &_encoding, const std::string &_standalone)
 Constructor.
 
 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 TiXmlNodeClone () const
 Creates a copy of this Declaration and returns it.
 
virtual void Print (FILE *cfile, int depth) const
 
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.
 
virtual bool Accept (TiXmlVisitor *visitor) const
 
- Public Member Functions inherited from TiXmlNode
const char * Value () const
 
const std::string & ValueStr () const
 
void SetValue (const char *_value)
 
void SetValue (const std::string &_value)
 STL std::string form.
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
const TiXmlNodeFirstChild (const char *value) const
 
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form.
 
const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeLastChild (const std::string &_value)
 STL std::string form.
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.
 
TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form.
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
const TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form.
 
const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form.
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
const TiXmlElementNextSiblingElement () const
 
const TiXmlElementNextSiblingElement (const char *) const
 
const TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
 
TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form.
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
 
const TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
 
TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form.
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children.
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 See Row()
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data.
 
void * GetUserData ()
 Get a pointer to arbitrary user data.
 
const void * GetUserData () const
 Get a pointer to arbitrary user data.
 

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.

Member Function Documentation

bool TiXmlDeclaration::Accept ( TiXmlVisitor visitor) const
virtual

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

Implements TiXmlNode.

References TiXmlVisitor::Visit().

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

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.


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