#include <tinyxml2.h>
Public Member Functions | |
| XMLHandle | FirstChild () |
| Get the first child of this handle. | |
| XMLHandle | FirstChildElement (const char *name=0) |
| Get the first child element of this handle. | |
| XMLHandle | LastChild () |
| Get the last child of this handle. | |
| XMLHandle | LastChildElement (const char *name=0) |
| Get the last child element of this handle. | |
| XMLHandle | NextSibling () |
| Get the next sibling of this handle. | |
| XMLHandle | NextSiblingElement (const char *name=0) |
| Get the next sibling element of this handle. | |
| XMLHandle & | operator= (const XMLHandle &ref) |
| Assignment. | |
| XMLHandle | PreviousSibling () |
| Get the previous sibling of this handle. | |
| XMLHandle | PreviousSiblingElement (const char *name=0) |
| Get the previous sibling element of this handle. | |
| XMLDeclaration * | ToDeclaration () |
| Safe cast to XMLDeclaration. This can return null. | |
| XMLElement * | ToElement () |
| Safe cast to XMLElement. This can return null. | |
| XMLNode * | ToNode () |
| Safe cast to XMLNode. This can return null. | |
| XMLText * | ToText () |
| Safe cast to XMLText. This can return null. | |
| XMLUnknown * | ToUnknown () |
| Safe cast to XMLUnknown. This can return null. | |
| XMLHandle (XMLNode *node) | |
| Create a handle from any node (at any depth of the tree.) This can be a null pointer. | |
| XMLHandle (XMLNode &node) | |
| Create a handle from a node. | |
| XMLHandle (const XMLHandle &ref) | |
| Copy constructor. | |
Private Attributes | |
| XMLNode * | _node |
A XMLHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2 DOM structure. It is a separate utility class.
Take an example:
<Document> <Element attributeA = "valueA"> <Child attributeB = "value1" /> <Child attributeB = "value2" /> </Element> </Document>
Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a *lot* of code that looks like:
XMLElement* root = document.FirstChildElement( "Document" );
if ( root )
{
XMLElement* element = root->FirstChildElement( "Element" );
if ( element )
{
XMLElement* child = element->FirstChildElement( "Child" );
if ( child )
{
XMLElement* child2 = child->NextSiblingElement( "Child" );
if ( child2 )
{
// Finally do something useful.
And that doesn't even cover "else" cases. XMLHandle addresses the verbosity of such code. A XMLHandle checks for null pointers so it is perfectly safe and correct to use:
XMLHandle docHandle( &document );
XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
if ( child2 )
{
// do something useful
Which is MUCH more concise and useful.
It is also safe to copy handles - internally they are nothing more than node pointers.
XMLHandle handleCopy = handle;
See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Definition at line 1987 of file tinyxml2.h.
| tinyxml2::XMLHandle::XMLHandle | ( | XMLNode * | node | ) | [inline] |
Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Definition at line 1991 of file tinyxml2.h.
| tinyxml2::XMLHandle::XMLHandle | ( | XMLNode & | node | ) | [inline] |
Create a handle from a node.
Definition at line 1994 of file tinyxml2.h.
| tinyxml2::XMLHandle::XMLHandle | ( | const XMLHandle & | ref | ) | [inline] |
Copy constructor.
Definition at line 1997 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::FirstChild | ( | ) | [inline] |
Get the first child of this handle.
Definition at line 2006 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::FirstChildElement | ( | const char * | name = 0 | ) | [inline] |
Get the first child element of this handle.
Definition at line 2010 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::LastChild | ( | ) | [inline] |
Get the last child of this handle.
Definition at line 2014 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::LastChildElement | ( | const char * | name = 0 | ) | [inline] |
Get the last child element of this handle.
Definition at line 2018 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::NextSibling | ( | ) | [inline] |
Get the next sibling of this handle.
Definition at line 2030 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::NextSiblingElement | ( | const char * | name = 0 | ) | [inline] |
Get the next sibling element of this handle.
Definition at line 2034 of file tinyxml2.h.
Assignment.
Definition at line 2000 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::PreviousSibling | ( | ) | [inline] |
Get the previous sibling of this handle.
Definition at line 2022 of file tinyxml2.h.
| XMLHandle tinyxml2::XMLHandle::PreviousSiblingElement | ( | const char * | name = 0 | ) | [inline] |
Get the previous sibling element of this handle.
Definition at line 2026 of file tinyxml2.h.
| XMLDeclaration* tinyxml2::XMLHandle::ToDeclaration | ( | ) | [inline] |
Safe cast to XMLDeclaration. This can return null.
Definition at line 2055 of file tinyxml2.h.
| XMLElement* tinyxml2::XMLHandle::ToElement | ( | ) | [inline] |
Safe cast to XMLElement. This can return null.
Definition at line 2043 of file tinyxml2.h.
| XMLNode* tinyxml2::XMLHandle::ToNode | ( | ) | [inline] |
Safe cast to XMLNode. This can return null.
Definition at line 2039 of file tinyxml2.h.
| XMLText* tinyxml2::XMLHandle::ToText | ( | ) | [inline] |
Safe cast to XMLText. This can return null.
Definition at line 2047 of file tinyxml2.h.
| XMLUnknown* tinyxml2::XMLHandle::ToUnknown | ( | ) | [inline] |
Safe cast to XMLUnknown. This can return null.
Definition at line 2051 of file tinyxml2.h.
XMLNode* tinyxml2::XMLHandle::_node [private] |
Definition at line 2060 of file tinyxml2.h.