#include <tinyxml.h>
Inheritance diagram for TiXmlNode:
Public Types | |
| DOCUMENT | |
| ELEMENT | |
| COMMENT | |
| UNKNOWN | |
| TEXT | |
| DECLARATION | |
| TYPECOUNT | |
| enum | NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT } |
| The types of XML nodes supported by TinyXml. More... | |
Public Member Functions | |
| virtual | ~TiXmlNode () |
| const char * | Value () const |
| The meaning of 'value' changes for the specific type of TiXmlNode. | |
| void | SetValue (const char *_value) |
| Changes the value of the node. | |
| void | SetValue (const std::string &value) |
| STL std::string form. | |
| void | Clear () |
| Delete all the children of this node. Does not affect 'this'. | |
| TiXmlNode * | Parent () const |
| One step up the DOM. | |
| 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 |
| The last child of this node. Will be null if there are no children. | |
| TiXmlNode * | FirstChild (const std::string &value) const |
| The last child of this node matching 'value'. Will be null if there are no children. STL std::string form. | |
| TiXmlNode * | LastChild (const std::string &value) const |
| STL std::string form. | |
| TiXmlNode * | IterateChildren (TiXmlNode *previous) const |
| An alternate way to walk the children of a node. | |
| TiXmlNode * | IterateChildren (const char *value, TiXmlNode *previous) const |
| This flavor of IterateChildren searches for children with a particular 'value'. | |
| TiXmlNode * | IterateChildren (const std::string &value, TiXmlNode *previous) const |
| STL std::string form. | |
| TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
| Add a new node related to this. | |
| TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
| Add a new node related to this. | |
| TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
| Add a new node related to this. | |
| TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
| Add a new node related to this. | |
| TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
| Replace a child of this node. | |
| bool | RemoveChild (TiXmlNode *removeThis) |
| Delete a child of this node. | |
| TiXmlNode * | PreviousSibling () const |
| Navigate to a sibling node. | |
| TiXmlNode * | PreviousSibling (const char *) const |
| Navigate to a sibling node. | |
| TiXmlNode * | PreviousSibling (const std::string &value) const |
| STL std::string form. | |
| TiXmlNode * | NextSibling (const std::string &value) const |
| STL std::string form. | |
| TiXmlNode * | NextSibling () const |
| Navigate to a sibling node. | |
| TiXmlNode * | NextSibling (const char *) const |
| Navigate to a sibling node with the given 'value'. | |
| TiXmlElement * | NextSiblingElement () const |
| Convenience function to get through elements. | |
| TiXmlElement * | NextSiblingElement (const char *) const |
| Convenience function to get through elements. | |
| TiXmlElement * | NextSiblingElement (const std::string &value) const |
| STL std::string form. | |
| TiXmlElement * | FirstChildElement () const |
| Convenience function to get through elements. | |
| TiXmlElement * | FirstChildElement (const char *value) const |
| Convenience function to get through elements. | |
| TiXmlElement * | FirstChildElement (const std::string &value) const |
| STL std::string form. | |
| virtual int | Type () const |
| Query the type (as an enumerated value, above) of this node. | |
| TiXmlDocument * | GetDocument () const |
| Return a pointer to the Document this node lives in. | |
| bool | NoChildren () const |
| Returns true if this node has no children. | |
| 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 () |
Protected Member Functions | |
| TiXmlNode (NodeType type) | |
| virtual void | StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)=0 |
| TiXmlNode * | Identify (const char *start) |
| void | CopyToClone (TiXmlNode *target) const |
| TIXML_STRING | SValue () const |
Protected Attributes | |
| TiXmlNode * | parent |
| NodeType | type |
| TiXmlNode * | firstChild |
| TiXmlNode * | lastChild |
| TIXML_STRING | value |
| TiXmlNode * | prev |
| TiXmlNode * | next |
| void * | userData |
Friends | |
| class | TiXmlDocument |
| class | TiXmlElement |
| std::istream & | operator>> (std::istream &in, TiXmlNode &base) |
| An input stream operator, for every class. | |
| std::ostream & | operator<< (std::ostream &out, const TiXmlNode &base) |
| An output stream operator, for every class. | |
(Except for attributes, which are contained in elements.) 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 |
| virtual TiXmlNode::~TiXmlNode | ( | ) | [virtual] |
| TiXmlNode::TiXmlNode | ( | NodeType | type | ) | [protected] |
| void TiXmlNode::Clear | ( | ) |
Delete all the children of this node. Does not affect 'this'.
| virtual TiXmlNode* TiXmlNode::Clone | ( | ) | const [pure virtual] |
Implemented in TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.
| void TiXmlNode::CopyToClone | ( | TiXmlNode * | target | ) | const [inline, protected] |
| TiXmlNode* 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.
| TiXmlNode* TiXmlNode::FirstChild | ( | const char * | value | ) | const |
The first child of this node with the matching 'value'. Will be null if none found.
| TiXmlNode* TiXmlNode::FirstChild | ( | ) | const [inline] |
The first child of this node. Will be null if there are no children.
| TiXmlElement* TiXmlNode::FirstChildElement | ( | const std::string & | value | ) | const [inline] |
STL std::string form.
| TiXmlElement* TiXmlNode::FirstChildElement | ( | const char * | value | ) | const |
Convenience function to get through elements.
| TiXmlElement* TiXmlNode::FirstChildElement | ( | ) | const |
Convenience function to get through elements.
| TiXmlDocument* TiXmlNode::GetDocument | ( | ) | const |
Return a pointer to the Document this node lives in.
Returns null if not in a document.
| void* TiXmlNode::GetUserData | ( | ) | [inline] |
| TiXmlNode* TiXmlNode::Identify | ( | const char * | start | ) | [protected] |
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.
| TiXmlNode* TiXmlNode::IterateChildren | ( | const std::string & | value, | |
| TiXmlNode * | previous | |||
| ) | const [inline] |
STL std::string form.
This flavor of IterateChildren searches for children with a particular 'value'.
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::LastChild | ( | const std::string & | value | ) | const [inline] |
STL std::string form.
| TiXmlNode* TiXmlNode::LastChild | ( | const char * | value | ) | const |
The last child of this node. Will be null if there are no children.
| TiXmlNode* TiXmlNode::LastChild | ( | ) | const [inline] |
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.
| TiXmlNode* TiXmlNode::NextSibling | ( | const char * | ) | const |
Navigate to a sibling node with the given 'value'.
| TiXmlNode* TiXmlNode::NextSibling | ( | ) | const [inline] |
Navigate to a sibling node.
| TiXmlNode* TiXmlNode::NextSibling | ( | const std::string & | value | ) | const [inline] |
STL std::string form.
| TiXmlElement* TiXmlNode::NextSiblingElement | ( | const std::string & | value | ) | const [inline] |
STL std::string form.
| TiXmlElement* TiXmlNode::NextSiblingElement | ( | const char * | ) | 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 |
Convenience function to get through elements.
Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.
| bool TiXmlNode::NoChildren | ( | ) | const [inline] |
Returns true if this node has no children.
| TiXmlNode* TiXmlNode::Parent | ( | ) | const [inline] |
One step up the DOM.
| TiXmlNode* TiXmlNode::PreviousSibling | ( | const std::string & | value | ) | const [inline] |
STL std::string form.
| TiXmlNode* TiXmlNode::PreviousSibling | ( | const char * | ) | const |
Navigate to a sibling node.
| TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | const [inline] |
Navigate to a sibling node.
| bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) |
Delete a child of this node.
Replace a child of this node.
Returns a pointer to the new object or NULL if an error occured.
| void TiXmlNode::SetUserData | ( | void * | user | ) | [inline] |
| void TiXmlNode::SetValue | ( | const std::string & | value | ) | [inline] |
STL std::string form.
| 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 void TiXmlNode::StreamIn | ( | TIXML_ISTREAM * | in, | |
| TIXML_STRING * | tag | |||
| ) | [protected, pure virtual] |
Implemented in TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.
| TIXML_STRING TiXmlNode::SValue | ( | ) | const [inline, protected] |
| TiXmlComment* TiXmlNode::ToComment | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| TiXmlDocument* TiXmlNode::ToDocument | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| TiXmlElement* TiXmlNode::ToElement | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| TiXmlText* TiXmlNode::ToText | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | const [inline] |
Cast to a more defined type. Will return null not of the requested type.
| virtual int TiXmlNode::Type | ( | ) | const [inline, virtual] |
Query the type (as an enumerated value, above) of this node.
| 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.
| 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.
| 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.
friend class TiXmlDocument [friend] |
Reimplemented from TiXmlBase.
friend class TiXmlElement [friend] |
TiXmlNode* TiXmlNode::firstChild [protected] |
TiXmlNode* TiXmlNode::lastChild [protected] |
TiXmlNode* TiXmlNode::next [protected] |
TiXmlNode* TiXmlNode::parent [protected] |
TiXmlNode* TiXmlNode::prev [protected] |
NodeType TiXmlNode::type [protected] |
void* TiXmlNode::userData [protected] |
TIXML_STRING TiXmlNode::value [protected] |
1.4.7