ddc
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDeclaration:
Inheritance graph
[legend]
Collaboration diagram for TiXmlDeclaration:
Collaboration graph
[legend]

Public Member Functions

 TiXmlDeclaration ()
 Construct an empty declaration. More...
 
 TiXmlDeclaration (const char *_version, const char *_encoding, const char *_standalone)
 Construct. More...
 
 TiXmlDeclaration (const TiXmlDeclaration &copy)
 
void operator= (const TiXmlDeclaration &copy)
 
virtual ~TiXmlDeclaration ()
 
const char * Version () const
 Version. Will return an empty string if none was found. More...
 
const char * Encoding () const
 Encoding. Will return an empty string if none was found. More...
 
const char * Standalone () const
 Is this a standalone document? More...
 
virtual TiXmlNode * Clone () const
 Creates a copy of this Declaration and returns it. More...
 
virtual void Print (FILE *cfile, int depth) const
 Print this declaration to a FILE stream. More...
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNode * Parent () const
 One step up the DOM. More...
 
TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
TiXmlNode * LastChild () const
 
TiXmlNode * LastChild (const char *value) const
 The last child of this node. Will be null if there are no children. More...
 
TiXmlNode * IterateChildren (TiXmlNode *previous) const
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNode * IterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
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. More...
 
TiXmlNode * PreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNode * NextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlElement * NextSiblingElement () const
 
TiXmlElement * NextSiblingElement (const char *) const
 
TiXmlElement * FirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements. More...
 
virtual int Type () const
 
TiXmlDocument * GetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlText * ToText () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) const
 
virtual void StreamOut (TiXmlOutStream *out) const
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNode * Identify (const char *start, TiXmlEncoding encoding)
 
const TiXmlString & SValue () const
 

Private Attributes

TiXmlString version
 
TiXmlString encoding
 
TiXmlString standalone
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Protected 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_STRING_COUNT
}
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static const char * ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TiXmlString *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 TiXmlString &str, TiXmlOutStream *out)
 
static void PutString (const TiXmlString &str, TiXmlString *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 TiXmlNode
TiXmlNode * parent
 
NodeType type
 
TiXmlNode * firstChild
 
TiXmlNode * lastChild
 
TiXmlString value
 
TiXmlNode * prev
 
TiXmlNode * next
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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.

Constructor & Destructor Documentation

◆ TiXmlDeclaration() [1/3]

TiXmlDeclaration::TiXmlDeclaration ( )
inline

Construct an empty declaration.

Referenced by Clone(), and TiXmlDeclaration().

Here is the caller graph for this function:

◆ TiXmlDeclaration() [2/3]

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

Construct.

References TiXmlNode::DECLARATION, encoding, standalone, TiXmlDeclaration(), TiXmlNode::TiXmlNode(), and version.

Here is the call graph for this function:

◆ TiXmlDeclaration() [3/3]

TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration &  copy)

References CopyTo().

Here is the call graph for this function:

◆ ~TiXmlDeclaration()

virtual TiXmlDeclaration::~TiXmlDeclaration ( )
inlinevirtual

Member Function Documentation

◆ operator=()

void TiXmlDeclaration::operator= ( const TiXmlDeclaration &  copy)

References TiXmlNode::Clear(), and CopyTo().

Here is the call graph for this function:

◆ Version()

const char* TiXmlDeclaration::Version ( ) const
inline

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

◆ Encoding()

const char* TiXmlDeclaration::Encoding ( ) const
inline

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

Referenced by TiXmlDocument::Parse().

Here is the caller graph for this function:

◆ Standalone()

const char* TiXmlDeclaration::Standalone ( ) const
inline

Is this a standalone document?

References TIXML_OSTREAM, and TIXML_STRING.

◆ Clone()

TiXmlNode * TiXmlDeclaration::Clone ( void  ) const
virtual

Creates a copy of this Declaration and returns it.

Implements TiXmlNode.

References CopyTo(), and TiXmlDeclaration().

Here is the call graph for this function:

◆ Print()

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

Print this declaration to a FILE stream.

Implements TiXmlBase.

References TiXmlString::c_str(), TiXmlString::empty(), encoding, standalone, and version.

Here is the call graph for this function:

◆ Parse()

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

Implements TiXmlBase.

References TiXmlParsingData::Cursor(), TiXmlNode::GetDocument(), TiXmlBase::IsWhiteSpace(), TiXmlBase::location, TiXmlAttribute::Parse(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_DECLARATION, and TiXmlAttribute::Value().

Here is the call graph for this function:

◆ CopyTo()

void TiXmlDeclaration::CopyTo ( TiXmlDeclaration *  target) const
protected

References TiXmlNode::CopyTo(), encoding, standalone, and version.

Referenced by Clone(), TiXmlUnknown::Clone(), operator=(), and TiXmlDeclaration().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StreamOut()

void TiXmlDeclaration::StreamOut ( TiXmlOutStream *  out) const
protectedvirtual

Implements TiXmlBase.

References TiXmlString::empty(), encoding, TiXmlBase::PutString(), standalone, and version.

Here is the call graph for this function:

Member Data Documentation

◆ version

TiXmlString TiXmlDeclaration::version
private

Referenced by CopyTo(), Print(), StreamOut(), and TiXmlDeclaration().

◆ encoding

TiXmlString TiXmlDeclaration::encoding
private

Referenced by CopyTo(), Print(), StreamOut(), and TiXmlDeclaration().

◆ standalone

TiXmlString TiXmlDeclaration::standalone
private

Referenced by CopyTo(), Print(), StreamOut(), and TiXmlDeclaration().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13