openEmbroider  0.1
an open source embroidery software
 All Classes Functions Enumerations
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
TiXmlNode Class Referenceabstract

#include <tinyxml.h>

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

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 

Public Member Functions

const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 
TiXmlNodeParent () const
 
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
 
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 
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)
 
TiXmlNodePreviousSibling () const
 
TiXmlNodePreviousSibling (const char *) const
 
TiXmlNodeNextSibling () const
 
TiXmlNodeNextSibling (const char *) const
 
TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementFirstChildElement () const
 
TiXmlElementFirstChildElement (const char *value) const
 
virtual int Type () const
 
TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 
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 TiXmlBase
virtual void Print (FILE *cfile, int depth) const =0
 
int Row () const
 
int Column () const
 See Row()
 

Protected Member Functions

 TiXmlNode (NodeType type)
 
TiXmlNodeIdentify (const char *start)
 
void CopyToClone (TiXmlNode *target) const
 
TIXML_STRING SValue () const
 
- Protected Member Functions inherited from 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 TiXmlBase
TiXmlCursor location
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 
- 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_STRING_COUNT
}
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *)
 
static bool IsWhiteSpace (int c)
 
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 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

TiXmlDocument * TiXmlNode::GetDocument ( ) const

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

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


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