- Cal3D 0.11 API Reference -

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
cal3d::TiXmlNode Class Referenceabstract

The parent class for everything in the Document Object Model. More...

#include <tinyxml.h>

Inheritance diagram for cal3d::TiXmlNode:
cal3d::TiXmlBase cal3d::TiXmlComment cal3d::TiXmlDeclaration cal3d::TiXmlDocument cal3d::TiXmlElement cal3d::TiXmlText cal3d::TiXmlUnknown

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 

Public Member Functions

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.
 
virtual TiXmlNodeClone () const =0
 
void SetUserData (void *user)
 
void * GetUserData ()
 
- Public Member Functions inherited from cal3d::TiXmlBase
virtual void Print (FILE *cfile, int depth) const =0
 All TinyXml classes can print themselves to a filestream. More...
 
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

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

Protected Attributes

TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
void * userData
 
- Protected Attributes inherited from cal3d::TiXmlBase
TiXmlCursor location
 

Friends

class TiXmlDocument
 
class TiXmlElement
 
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 An input stream operator, for every class. More...
 
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
 An output stream operator, for every class. More...
 
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.
 

Additional Inherited Members

- 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)
 
- Static Protected Attributes inherited from cal3d::TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

The parent class for everything in the Document Object Model.

(Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Member Enumeration Documentation

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Member Function Documentation

TiXmlNode* cal3d::TiXmlNode::FirstChild ( const std::string &  _value) const
inline

The last child of this node matching 'value'. Will be null if there are no children.

STL std::string form.

TiXmlDocument * cal3d::TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

TiXmlNode * cal3d::TiXmlNode::InsertAfterChild ( TiXmlNode afterThis,
const TiXmlNode addThis 
)

Add a new node related to this.

Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode * cal3d::TiXmlNode::InsertBeforeChild ( TiXmlNode beforeThis,
const TiXmlNode addThis 
)

Add a new node related to this.

Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode * cal3d::TiXmlNode::InsertEndChild ( const TiXmlNode addThis)

Add a new node related to this.

Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode * cal3d::TiXmlNode::IterateChildren ( TiXmlNode previous) const

An alternate way to walk the children of a node.

One way to iterate over nodes is:

    for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

    child = 0;
    while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

TiXmlNode * cal3d::TiXmlNode::LinkEndChild ( TiXmlNode addThis)

Add a new node related to this.

Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also
InsertEndChild
TiXmlElement * cal3d::TiXmlNode::NextSiblingElement ( ) const

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement * cal3d::TiXmlNode::NextSiblingElement ( const char *  _value) const

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlNode * cal3d::TiXmlNode::ReplaceChild ( TiXmlNode replaceThis,
const TiXmlNode withThis 
)

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occured.

void cal3d::TiXmlNode::SetValue ( const char *  _value)
inline

Changes the value of the node.

Defined as:

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string
virtual int cal3d::TiXmlNode::Type ( ) const
inlinevirtual

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

const char* cal3d::TiXmlNode::Value ( ) const
inline

The meaning of 'value' changes for the specific type of TiXmlNode.

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

The subclasses will wrap this function.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const TiXmlNode base 
)
friend

An output stream operator, for every class.

Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

std::istream& operator>> ( std::istream &  in,
TiXmlNode base 
)
friend

An input stream operator, for every class.

Tolerant of newlines and formatting, but doesn't expect them.


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

Generated at Thu Sep 4 2014 00:32:53 by The Cal3D Team with Doxygen 1.8.7