Public Member Functions | Protected Member Functions | Private Attributes | List of all members
RTT::marsh::TiXmlDeclaration Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlDeclaration:
Inheritance graph
[legend]

Public Member Functions

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

Protected Member Functions

void CopyTo (TiXmlDeclaration *target) const
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
- Protected Member Functions inherited from RTT::marsh::TiXmlNode
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
 TiXmlNode (NodeType _type)
 

Private Attributes

TIXML_STRING encoding
 
TIXML_STRING standalone
 
TIXML_STRING version
 

Additional Inherited Members

- Public Types inherited from RTT::marsh::TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Public Types inherited from RTT::marsh::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_STRING_COUNT
}
 
- Static Public Member Functions inherited from RTT::marsh::TiXmlBase
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void SetCondenseWhiteSpace (bool condense)
 
- Static Public Attributes inherited from RTT::marsh::TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from RTT::marsh::TiXmlBase
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 bool IsWhiteSpace (int c)
 
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *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 StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
- Protected Attributes inherited from RTT::marsh::TiXmlNode
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TiXmlNodenext
 
TiXmlNodeparent
 
TiXmlNodeprev
 
NodeType type
 
TIXML_STRING value
 
- Protected Attributes inherited from RTT::marsh::TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from RTT::marsh::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.

Definition at line 1160 of file tinyxml.h.

Constructor & Destructor Documentation

RTT::marsh::TiXmlDeclaration::TiXmlDeclaration ( )
inline

Construct an empty declaration.

Definition at line 1164 of file tinyxml.h.

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

Construct.

Definition at line 1487 of file tinyxml.cpp.

RTT::marsh::TiXmlDeclaration::TiXmlDeclaration ( const TiXmlDeclaration copy)

Definition at line 1511 of file tinyxml.cpp.

virtual RTT::marsh::TiXmlDeclaration::~TiXmlDeclaration ( )
inlinevirtual

Definition at line 1181 of file tinyxml.h.

Member Function Documentation

TiXmlNode * RTT::marsh::TiXmlDeclaration::Clone ( ) const
virtual

Creates a copy of this Declaration and returns it.

Implements RTT::marsh::TiXmlNode.

Definition at line 1574 of file tinyxml.cpp.

void RTT::marsh::TiXmlDeclaration::CopyTo ( TiXmlDeclaration target) const
protected

Definition at line 1564 of file tinyxml.cpp.

const char* RTT::marsh::TiXmlDeclaration::Encoding ( ) const
inline

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

Definition at line 1186 of file tinyxml.h.

void RTT::marsh::TiXmlDeclaration::operator= ( const TiXmlDeclaration copy)

Definition at line 1518 of file tinyxml.cpp.

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

Implements RTT::marsh::TiXmlBase.

Definition at line 1554 of file tinyxmlparser.cpp.

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

Print this declaration to a FILE stream.

Implements RTT::marsh::TiXmlBase.

Definition at line 1525 of file tinyxml.cpp.

const char* RTT::marsh::TiXmlDeclaration::Standalone ( ) const
inline

Is this a standalone document?

Definition at line 1188 of file tinyxml.h.

void RTT::marsh::TiXmlDeclaration::StreamOut ( TIXML_OSTREAM out) const
protectedvirtual

Implements RTT::marsh::TiXmlBase.

Definition at line 1538 of file tinyxml.cpp.

virtual const TiXmlDeclaration* RTT::marsh::TiXmlDeclaration::ToDeclaration ( ) const
inlinevirtual

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1197 of file tinyxml.h.

virtual TiXmlDeclaration* RTT::marsh::TiXmlDeclaration::ToDeclaration ( )
inlinevirtual

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

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1198 of file tinyxml.h.

const char* RTT::marsh::TiXmlDeclaration::Version ( ) const
inline

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

Definition at line 1184 of file tinyxml.h.

Member Data Documentation

TIXML_STRING RTT::marsh::TiXmlDeclaration::encoding
private

Definition at line 1211 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlDeclaration::standalone
private

Definition at line 1212 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlDeclaration::version
private

Definition at line 1210 of file tinyxml.h.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:45