edelib  2.1.0
Public Member Functions | List of all members
TiXmlDeclaration Class Reference

XML declaration. More...

#include <edelib/TiXml.h>

Inheritance diagram for TiXmlDeclaration:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlDeclaration ()
 
 TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
 
 TiXmlDeclaration (const TiXmlDeclaration &copy)
 
void operator= (const TiXmlDeclaration &copy)
 
const char * Version () const
 
const char * Encoding () const
 
const char * Standalone () const
 
virtual TiXmlNodeClone () const
 
virtual void Print (FILE *cfile, int depth, edelib::String *str) const
 
virtual void Print (FILE *cfile, int depth) const
 
virtual const TiXmlDeclarationToDeclaration () const
 
virtual TiXmlDeclarationToDeclaration ()
 
virtual bool Accept (TiXmlVisitor *visitor) const
 
- Public Member Functions inherited from TiXmlNode
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 
TiXmlNodeParent ()
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 
TiXmlNodeFirstChild (const char *_value)
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 
const TiXmlNodeLastChild (const char *value) const
 
TiXmlNodeLastChild (const char *_value)
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
 
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)
 
const TiXmlNodePreviousSibling () const
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 
TiXmlNodePreviousSibling (const char *_prev)
 
const TiXmlNodeNextSibling () const
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 
TiXmlNodeNextSibling (const char *_next)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *_next)
 
const TiXmlElementFirstChildElement () const
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *_value) const
 
TiXmlElementFirstChildElement (const char *_value)
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 
virtual const TiXmlDocumentToDocument () const
 
virtual const TiXmlElementToElement () const
 
virtual const TiXmlCommentToComment () const
 
virtual const TiXmlUnknownToUnknown () const
 
virtual const TiXmlTextToText () const
 
virtual TiXmlDocumentToDocument ()
 
virtual TiXmlElementToElement ()
 
virtual TiXmlCommentToComment ()
 
virtual TiXmlUnknownToUnknown ()
 
virtual TiXmlTextToText ()
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 
void SetUserData (void *user)
 
void * GetUserData ()
 
const void * GetUserData () const
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Public Types inherited from TiXmlBase
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_PARSING_CDATA,
  TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * ReadName (const char *p, edelib::String *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, edelib::String *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static void PutString (const edelib::String &str, edelib::String *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

XML declaration.

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 char *  _version,
const char *  _encoding,
const char *  _standalone 
)

Constructor

Constructor

Member Function Documentation

virtual bool Accept ( TiXmlVisitor visitor) const
virtual

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

Implements TiXmlNode.

virtual TiXmlNode* Clone ( ) const
virtual

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

const char* Encoding ( ) const
inline

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

void operator= ( const TiXmlDeclaration copy)

Assignement from other TiXmlDeclaration

virtual void Print ( FILE *  cfile,
int  depth,
edelib::String str 
) const
virtual

Print this declaration to a FILE stream.

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

Print this declaration to a FILE stream.

Implements TiXmlBase.

References TiXmlBase::Print().

const char* Standalone ( ) const
inline

Is this a standalone document?

virtual const TiXmlDeclaration* ToDeclaration ( ) const
inlinevirtual

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

Reimplemented from TiXmlNode.

virtual TiXmlDeclaration* ToDeclaration ( )
inlinevirtual

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

Reimplemented from TiXmlNode.

const char* Version ( ) const
inline

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


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