- Cal3D 0.11 API Reference -

Public Member Functions | Protected Member Functions | List of all members
cal3d::TiXmlDeclaration Class Reference

In correct XML the declaration is the first entry in the file. More...

#include <tinyxml.h>

Inheritance diagram for cal3d::TiXmlDeclaration:
cal3d::TiXmlNode cal3d::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 empty if none was found.
 
const char * Encoding () const
 Encoding. Will return empty if none was found.
 
const char * Standalone () const
 Is this a standalone document?
 
virtual TiXmlNodeClone () const
 
virtual void Print (FILE *cfile, int depth) const
 All TinyXml classes can print themselves to a filestream. More...
 
- Public Member Functions inherited from cal3d::TiXmlNode
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode. More...
 
void SetValue (const char *_value)
 Changes the value of the node. More...
 
void SetValue (const std::string &_value)
 STL std::string form.
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent () const
 One step up the DOM.
 
TiXmlNodeFirstChild () const
 The first child of this node. 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.
 
TiXmlNodeLastChild () const
 
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild (const std::string &_value) const
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 An alternate way to walk the children of a node. More...
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous) const
 STL std::string form.
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node. More...
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
TiXmlElementNextSiblingElement () const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
 
TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
 
virtual int Type () const
 Query the type (as an enumerated value, above) of this node. More...
 
TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in. More...
 
bool NoChildren () const
 Returns true if this node has no children.
 
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.
 
TiXmlCommentToComment () 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.
 
TiXmlTextToText () 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.
 
void SetUserData (void *user)
 
void * GetUserData ()
 
- Public Member Functions inherited from cal3d::TiXmlBase
int Row () const
 Return the position, in the original source file, of this node or attribute. More...
 
int Column () const
 See Row()
 

Protected Member Functions

virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data)
 
- Protected Member Functions inherited from cal3d::TiXmlNode
 TiXmlNode (NodeType type)
 
TiXmlNodeIdentify (const char *start)
 
void CopyToClone (TiXmlNode *target) const
 
TIXML_STRING SValue () const
 

Additional Inherited Members

- Public Types inherited from cal3d::TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
- Static Public Member Functions inherited from cal3d::TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not. More...
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Protected Types inherited from cal3d::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_STRING_COUNT
}
 
- Static Protected Member Functions inherited from cal3d::TiXmlBase
static const char * SkipWhiteSpace (const char *)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (TIXML_ISTREAM *in, TIXML_STRING *tag)
 
static bool StreamTo (TIXML_ISTREAM *in, int character, TIXML_STRING *tag)
 
static const char * ReadName (const char *p, TIXML_STRING *name)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase)
 
static const char * GetEntity (const char *in, char *value)
 
static const char * GetChar (const char *p, char *_value)
 
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase)
 
- Protected Attributes inherited from cal3d::TiXmlNode
TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
void * userData
 
- Protected Attributes inherited from cal3d::TiXmlBase
TiXmlCursor location
 
- Static Protected Attributes inherited from cal3d::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.

Member Function Documentation

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

All TinyXml classes can print themselves to a filestream.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements cal3d::TiXmlBase.


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

Generated at Wed Nov 26 2014 05:33:20 by The Cal3D Team with Doxygen 1.8.7