#include <tinyxml.h>
Public Types | |
| enum | NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT } |
Public Member Functions | |
| virtual bool | Accept (TiXmlVisitor *visitor) const =0 |
| void | Clear () |
| Delete all the children of this node. Does not affect 'this'. | |
| virtual TiXmlNode * | Clone () const =0 |
| const TiXmlNode * | FirstChild () const |
| The first child of this node. Will be null if there are no children. | |
| TiXmlNode * | FirstChild () |
| const TiXmlNode * | FirstChild (const char *value) const |
| TiXmlNode * | FirstChild (const char *_value) |
| The first child of this node with the matching 'value'. Will be null if none found. | |
| const TiXmlElement * | FirstChildElement () const |
| Convenience function to get through elements. | |
| TiXmlElement * | FirstChildElement () |
| const TiXmlElement * | FirstChildElement (const char *_value) const |
| Convenience function to get through elements. | |
| TiXmlElement * | FirstChildElement (const char *_value) |
| const TiXmlDocument * | GetDocument () const |
| TiXmlDocument * | GetDocument () |
| TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
| TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
| TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
| const TiXmlNode * | IterateChildren (const TiXmlNode *previous) const |
| TiXmlNode * | IterateChildren (const TiXmlNode *previous) |
| const TiXmlNode * | IterateChildren (const char *value, const TiXmlNode *previous) const |
| This flavor of IterateChildren searches for children with a particular 'value'. | |
| TiXmlNode * | IterateChildren (const char *_value, const TiXmlNode *previous) |
| const TiXmlNode * | LastChild () const |
| TiXmlNode * | LastChild () |
| The last child of this node. Will be null if there are no children. | |
| const TiXmlNode * | LastChild (const char *value) const |
| TiXmlNode * | LastChild (const char *_value) |
| The last child of this node matching 'value'. Will be null if there are no children. | |
| TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
| const TiXmlNode * | NextSibling () const |
| Navigate to a sibling node. | |
| TiXmlNode * | NextSibling () |
| const TiXmlNode * | NextSibling (const char *) const |
| Navigate to a sibling node with the given 'value'. | |
| TiXmlNode * | NextSibling (const char *_next) |
| const TiXmlElement * | NextSiblingElement () const |
| TiXmlElement * | NextSiblingElement () |
| const TiXmlElement * | NextSiblingElement (const char *) const |
| TiXmlElement * | NextSiblingElement (const char *_next) |
| bool | NoChildren () const |
| Returns true if this node has no children. | |
| TiXmlNode * | Parent () |
| One step up the DOM. | |
| const TiXmlNode * | Parent () const |
| const TiXmlNode * | PreviousSibling () const |
| Navigate to a sibling node. | |
| TiXmlNode * | PreviousSibling () |
| const TiXmlNode * | PreviousSibling (const char *) const |
| Navigate to a sibling node. | |
| TiXmlNode * | PreviousSibling (const char *_prev) |
| bool | RemoveChild (TiXmlNode *removeThis) |
| Delete a child of this node. | |
| TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
| void | SetValue (const char *_value) |
| virtual const TiXmlComment * | ToComment () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlComment * | ToComment () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual const TiXmlDeclaration * | ToDeclaration () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlDeclaration * | ToDeclaration () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual const TiXmlDocument * | ToDocument () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlDocument * | ToDocument () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual const TiXmlElement * | ToElement () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlElement * | ToElement () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual const TiXmlText * | ToText () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlText * | ToText () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual const TiXmlUnknown * | ToUnknown () const |
| Cast to a more defined type. Will return null if not of the requested type. | |
| virtual TiXmlUnknown * | ToUnknown () |
| Cast to a more defined type. Will return null if not of the requested type. | |
| int | Type () const |
| const char * | Value () const |
| const TIXML_STRING & | ValueTStr () const |
| virtual | ~TiXmlNode () |
Protected Member Functions | |
| void | CopyTo (TiXmlNode *target) const |
| TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
| TiXmlNode (NodeType _type) | |
Protected Attributes | |
| TiXmlNode * | firstChild |
| TiXmlNode * | lastChild |
| TiXmlNode * | next |
| TiXmlNode * | parent |
| TiXmlNode * | prev |
| NodeType | type |
| TIXML_STRING | value |
Private Member Functions | |
| void | operator= (const TiXmlNode &base) |
| TiXmlNode (const TiXmlNode &) | |
Friends | |
| class | TiXmlDocument |
| class | TiXmlElement |
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
| enum TiXmlNode::NodeType |
Constructor & Destructor Documentation
| TiXmlNode::~TiXmlNode | ( | ) | [virtual] |
Definition at line 122 of file tinyxml.cpp.
| TiXmlNode::TiXmlNode | ( | NodeType | _type | ) | [protected] |
Definition at line 112 of file tinyxml.cpp.
| TiXmlNode::TiXmlNode | ( | const TiXmlNode & | ) | [private] |
Member Function Documentation
| virtual bool TiXmlNode::Accept | ( | TiXmlVisitor * | visitor | ) | const [pure virtual] |
Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.
This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)
The interface has been based on ideas from:
Which are both good references for "visiting".
An example of using Accept():
TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();
Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.
| void TiXmlNode::Clear | ( | ) |
Delete all the children of this node. Does not affect 'this'.
Definition at line 138 of file tinyxml.cpp.
| virtual TiXmlNode* 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 TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.
| void TiXmlNode::CopyTo | ( | TiXmlNode * | target | ) | const [protected] |
Definition at line 133 of file tinyxml.cpp.
| const TiXmlNode* TiXmlNode::FirstChild | ( | ) | const [inline] |
| TiXmlNode* TiXmlNode::FirstChild | ( | ) | [inline] |
| const TiXmlNode * TiXmlNode::FirstChild | ( | const char * | value | ) | const |
The first child of this node with the matching 'value'. Will be null if none found.
Definition at line 297 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::FirstChild | ( | const char * | _value | ) | [inline] |
| const TiXmlElement * TiXmlNode::FirstChildElement | ( | ) | const |
Convenience function to get through elements.
Definition at line 365 of file tinyxml.cpp.
| TiXmlElement* TiXmlNode::FirstChildElement | ( | ) | [inline] |
| const TiXmlElement * TiXmlNode::FirstChildElement | ( | const char * | _value | ) | const |
Convenience function to get through elements.
Definition at line 375 of file tinyxml.cpp.
| TiXmlElement* TiXmlNode::FirstChildElement | ( | const char * | _value | ) | [inline] |
| const TiXmlDocument * TiXmlNode::GetDocument | ( | ) | const |
Return a pointer to the Document this node lives in. Returns null if not in a document.
Definition at line 405 of file tinyxml.cpp.
| TiXmlDocument* TiXmlNode::GetDocument | ( | ) | [inline] |
| TiXmlNode * TiXmlNode::Identify | ( | const char * | start, |
| TiXmlEncoding | encoding | ||
| ) | [protected] |
Definition at line 730 of file tinyxmlparser.cpp.
| 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.
Definition at line 221 of file tinyxml.cpp.
| 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.
Definition at line 192 of file tinyxml.cpp.
| 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.
Definition at line 178 of file tinyxml.cpp.
| const TiXmlNode * 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.
Definition at line 315 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::IterateChildren | ( | const TiXmlNode * | previous | ) | [inline] |
| const TiXmlNode * TiXmlNode::IterateChildren | ( | const char * | value, |
| const TiXmlNode * | previous | ||
| ) | const |
This flavor of IterateChildren searches for children with a particular 'value'.
Definition at line 324 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::IterateChildren | ( | const char * | _value, |
| const TiXmlNode * | previous | ||
| ) | [inline] |
| const TiXmlNode* TiXmlNode::LastChild | ( | ) | const [inline] |
| TiXmlNode* TiXmlNode::LastChild | ( | ) | [inline] |
| const TiXmlNode * TiXmlNode::LastChild | ( | const char * | value | ) | const |
Definition at line 306 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::LastChild | ( | const char * | _value | ) | [inline] |
| 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
Definition at line 152 of file tinyxml.cpp.
| const TiXmlNode* TiXmlNode::NextSibling | ( | ) | const [inline] |
| TiXmlNode* TiXmlNode::NextSibling | ( | ) | [inline] |
| const TiXmlNode * TiXmlNode::NextSibling | ( | const char * | _value | ) | const |
Navigate to a sibling node with the given 'value'.
Definition at line 334 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::NextSibling | ( | const char * | _next | ) | [inline] |
| const 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.
Definition at line 385 of file tinyxml.cpp.
| TiXmlElement* TiXmlNode::NextSiblingElement | ( | ) | [inline] |
| const 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.
Definition at line 395 of file tinyxml.cpp.
| TiXmlElement* TiXmlNode::NextSiblingElement | ( | const char * | _next | ) | [inline] |
| bool TiXmlNode::NoChildren | ( | ) | const [inline] |
| void TiXmlNode::operator= | ( | const TiXmlNode & | base | ) | [private] |
| TiXmlNode* TiXmlNode::Parent | ( | ) | [inline] |
| const TiXmlNode* TiXmlNode::Parent | ( | ) | const [inline] |
| const TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | const [inline] |
| TiXmlNode* TiXmlNode::PreviousSibling | ( | ) | [inline] |
| const TiXmlNode * TiXmlNode::PreviousSibling | ( | const char * | _value | ) | const |
Navigate to a sibling node.
Definition at line 343 of file tinyxml.cpp.
| TiXmlNode* TiXmlNode::PreviousSibling | ( | const char * | _prev | ) | [inline] |
| bool TiXmlNode::RemoveChild | ( | TiXmlNode * | removeThis | ) |
Delete a child of this node.
Definition at line 277 of file tinyxml.cpp.
| 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.
Definition at line 250 of file tinyxml.cpp.
| void TiXmlNode::SetValue | ( | const char * | _value | ) | [inline] |
| virtual const TiXmlComment* TiXmlNode::ToComment | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
| virtual TiXmlComment* TiXmlNode::ToComment | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlComment.
| virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
| virtual TiXmlDeclaration* TiXmlNode::ToDeclaration | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDeclaration.
| virtual const TiXmlDocument* TiXmlNode::ToDocument | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDocument.
| virtual TiXmlDocument* TiXmlNode::ToDocument | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlDocument.
| virtual const TiXmlElement* TiXmlNode::ToElement | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
| virtual TiXmlElement* TiXmlNode::ToElement | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlElement.
| virtual const TiXmlText* TiXmlNode::ToText | ( | ) | const [inline, virtual] |
| virtual TiXmlText* TiXmlNode::ToText | ( | ) | [inline, virtual] |
| virtual const TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
| virtual TiXmlUnknown* TiXmlNode::ToUnknown | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null if not of the requested type.
Reimplemented in TiXmlUnknown.
| int TiXmlNode::Type | ( | ) | const [inline] |
| const char* TiXmlNode::Value | ( | ) | const [inline] |
| const TIXML_STRING& TiXmlNode::ValueTStr | ( | ) | const [inline] |
Friends And Related Function Documentation
friend class TiXmlDocument [friend] |
friend class TiXmlElement [friend] |
Member Data Documentation
TiXmlNode* TiXmlNode::firstChild [protected] |
TiXmlNode* TiXmlNode::lastChild [protected] |
TiXmlNode* TiXmlNode::next [protected] |
TiXmlNode* TiXmlNode::parent [protected] |
TiXmlNode* TiXmlNode::prev [protected] |
NodeType TiXmlNode::type [protected] |
TIXML_STRING TiXmlNode::value [protected] |
The documentation for this class was generated from the following files: