Logo Search packages:      
Sourcecode: balder2d version File versions  Download package

TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:

TiXmlNode TiXmlBase

List of all members.


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


Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

void Clear ()
 Delete all the children of this node. Does not affect 'this'.
virtual TiXmlNodeClone () const
 Creates a copy of this Declaration and returns it.
int Column () const
 See Row().
const char * Encoding () const
 Encoding. Will return an empty string if none was found.
TiXmlNodeFirstChild (const std::string &_value) const
 The last child of this node matching 'value'. Will be null if there are no children.
TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlDocumentGetDocument () const
void * GetUserData ()
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous) const
 STL std::string form.
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (TiXmlNode *previous) const
TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
TiXmlNodeLastChild () const
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement () const
bool NoChildren () const
 Returns true if this node has no children.
void operator= (const TiXmlDeclaration &copy)
TiXmlNodeParent () const
 One step up the DOM.
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
virtual void Print (FILE *cfile, int depth) const
 Print this declaration to a FILE stream.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
int Row () const
void SetUserData (void *user)
void SetValue (const std::string &_value)
 STL std::string form.
void SetValue (const char *_value)
const char * Standalone () const
 Is this a standalone document?
 TiXmlDeclaration (const TiXmlDeclaration &copy)
 TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
 Construct.
 TiXmlDeclaration (const std::string &_version, const std::string &_encoding, const std::string &_standalone)
 Constructor.
 TiXmlDeclaration ()
 Construct an empty declaration.
TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
virtual int Type () const
const char * Value () const
const char * Version () const
 Version. Will return an empty string if none was found.

Static Public Member Functions

static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void SetCondenseWhiteSpace (bool condense)

Static Public Attributes

static const int utf8ByteTable [256]

Protected Types

enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,
  TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,
  TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_STRING_COUNT
}

Protected Member Functions

void CopyTo (TiXmlNode *target) const
void CopyTo (TiXmlDeclaration *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void StreamOut (TIXML_OSTREAM *out) const
const TIXML_STRING & SValue () const

Static Protected Member Functions

static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool IsWhiteSpace (char c)
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool StreamTo (TIXML_ISTREAM *in, int character, TIXML_STRING *tag)
static bool StreamWhiteSpace (TIXML_ISTREAM *in, TIXML_STRING *tag)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)

Protected Attributes

TiXmlNodefirstChild
TiXmlNodelastChild
TiXmlCursor location
TiXmlNodenext
TiXmlNodeparent
TiXmlNodeprev
NodeType type
void * userData
 Field containing a generic user pointer.
TIXML_STRING value

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]

Private Attributes

TIXML_STRING encoding
TIXML_STRING standalone
TIXML_STRING version

Friends

std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
std::istream & operator>> (std::istream &in, TiXmlNode &base)

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

Generated by  Doxygen 1.6.0   Back to index