#include <tinyxml.h>
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 () |
TiXmlNode * | Parent () const |
TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlNode * | FirstChild (const char *value) const |
The first child of this node with the matching 'value'. Will be null if none found. | |
TiXmlNode * | LastChild () const |
TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | IterateChildren (TiXmlNode *previous) const |
TiXmlNode * | IterateChildren (const char *value, TiXmlNode *previous) const |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
bool | RemoveChild (TiXmlNode *removeThis) |
TiXmlNode * | PreviousSibling () const |
TiXmlNode * | PreviousSibling (const char *) const |
TiXmlNode * | NextSibling () const |
TiXmlNode * | NextSibling (const char *) const |
TiXmlElement * | NextSiblingElement () const |
TiXmlElement * | NextSiblingElement (const char *) const |
TiXmlElement * | FirstChildElement () const |
TiXmlElement * | FirstChildElement (const char *value) const |
virtual int | Type () const |
TiXmlDocument * | GetDocument () const |
bool | NoChildren () const |
TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlComment * | ToComment () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlText * | ToText () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlDeclaration * | ToDeclaration () const |
Cast to a more defined type. Will return null not of the requested type. | |
virtual TiXmlNode * | Clone () const =0 |
void | SetUserData (void *user) |
void * | GetUserData () |
![]() | |
virtual void | Print (FILE *cfile, int depth) const =0 |
int | Row () const |
int | Column () const |
See Row() | |
Protected Member Functions | |
TiXmlNode (NodeType type) | |
TiXmlNode * | Identify (const char *start) |
void | CopyToClone (TiXmlNode *target) const |
TIXML_STRING | SValue () const |
![]() | |
virtual void | StreamOut (TIXML_OSTREAM *) const =0 |
virtual const char * | Parse (const char *p, TiXmlParsingData *data)=0 |
Protected Attributes | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
void * | userData |
![]() | |
TiXmlCursor | location |
Friends | |
class | TiXmlDocument |
class | TiXmlElement |
TIXML_OSTREAM & | operator<< (TIXML_OSTREAM &out, const TiXmlNode &base) |
Additional Inherited Members | |
![]() | |
static void | SetCondenseWhiteSpace (bool condense) |
static bool | IsWhiteSpaceCondensed () |
![]() | |
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 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 const char * | errorString [TIXML_ERROR_STRING_COUNT] |
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.
enum TiXmlNode::NodeType |
The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)
TiXmlDocument * TiXmlNode::GetDocument | ( | ) | const |
Return a pointer to the Document this node lives in. Returns null if not in a document.
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.
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.
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.
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.
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.
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.
Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.
|
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
|
inlinevirtual |
Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.
|
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.