Crazy Eddies GUI System  0.6.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CEGUITinyXML::TiXmlNode Class Referenceabstract

Inherits CEGUITinyXML::TiXmlBase.

Inherited by CEGUITinyXML::TiXmlComment, CEGUITinyXML::TiXmlDeclaration, CEGUITinyXML::TiXmlDocument, CEGUITinyXML::TiXmlElement, CEGUITinyXML::TiXmlText, and CEGUITinyXML::TiXmlUnknown.

+ Collaboration diagram for CEGUITinyXML::TiXmlNode:

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Public Types inherited from CEGUITinyXML::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
}
 

Public Member Functions

const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
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.
 
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'.
 
TiXmlNodeIterateChildren (const char *value, 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)
 Delete a child of this node.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const char *)
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
TiXmlNodeNextSibling (const char *)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *)
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const char *value)
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
 
virtual TiXmlNodeClone () const =0
 
- Public Member Functions inherited from CEGUITinyXML::TiXmlBase
virtual void Print (FILE *cfile, int depth) const =0
 
int Row () const
 
int Column () const
 See Row()
 
void SetUserData (void *user)
 
void * GetUserData ()
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
 

Protected Member Functions

 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from CEGUITinyXML::TiXmlBase
virtual void StreamOut (TIXML_OSTREAM *) const =0
 

Protected Attributes

TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
- Protected Attributes inherited from CEGUITinyXML::TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer.
 

Friends

class TiXmlDocument
 
class TiXmlElement
 
TIXML_OSTREAM & operator<< (TIXML_OSTREAM &out, const TiXmlNode &base)
 

Additional Inherited Members

- Static Public Member Functions inherited from CEGUITinyXML::TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Static Public Attributes inherited from CEGUITinyXML::TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from CEGUITinyXML::TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
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 * 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 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, 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)
 
- Static Protected Attributes inherited from CEGUITinyXML::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

virtual TiXmlNode* CEGUITinyXML::TiXmlNode::Clone ( ) const
pure virtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implemented in CEGUITinyXML::TiXmlDocument, CEGUITinyXML::TiXmlUnknown, CEGUITinyXML::TiXmlDeclaration, CEGUITinyXML::TiXmlText, CEGUITinyXML::TiXmlComment, and CEGUITinyXML::TiXmlElement.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

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

Return a pointer to the Document this node lives in. Returns null if not in a document.

References ToDocument().

Referenced by LinkEndChild(), and CEGUITinyXML::TiXmlElement::SetAttribute().

TiXmlNode * CEGUITinyXML::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.

References Clone().

TiXmlNode * CEGUITinyXML::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.

References Clone().

TiXmlNode * CEGUITinyXML::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.

References Clone(), and LinkEndChild().

const TiXmlNode * CEGUITinyXML::TiXmlNode::IterateChildren ( const 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.

References FirstChild(), and NextSibling().

TiXmlNode * CEGUITinyXML::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

References GetDocument().

Referenced by InsertEndChild(), and CEGUITinyXML::TiXmlDocument::Parse().

const TiXmlElement * CEGUITinyXML::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.

References NextSibling(), and ToElement().

Referenced by CEGUITinyXML::TiXmlHandle::ChildElement().

const TiXmlElement * CEGUITinyXML::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.

References NextSibling(), and ToElement().

TiXmlNode * CEGUITinyXML::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.

References Clone().

void CEGUITinyXML::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

Referenced by CEGUITinyXML::TiXmlText::TiXmlText().

int CEGUITinyXML::TiXmlNode::Type ( ) const
inline

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

const char* CEGUITinyXML::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.

Referenced by CEGUITinyXML::TiXmlElement::Clone(), FirstChild(), CEGUITinyXML::TiXmlElement::GetText(), LastChild(), NextSibling(), and PreviousSibling().