#include <tinyxml2.h>

Public Member Functions
XMLHandle	FirstChild ()
	Get the first child of this handle.
XMLHandle	FirstChild ()
	Get the first child of this handle.
XMLHandle	FirstChildElement (const char *name=0)
	Get the first child element 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	LastChild ()
	Get the last child of this handle.
XMLHandle	LastChildElement (const char *name=0)
	Get the last child element 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	NextSibling ()
	Get the next sibling of this handle.
XMLHandle	NextSiblingElement (const char *name=0)
	Get the next sibling element of this handle.
XMLHandle	NextSiblingElement (const char *name=0)
	Get the next sibling element of this handle.
XMLHandle &	operator= (const XMLHandle &ref)
	Assignment.
XMLHandle &	operator= (const XMLHandle &ref)
	Assignment.
XMLHandle	PreviousSibling ()
	Get the previous sibling of this handle.
XMLHandle	PreviousSibling ()
	Get the previous sibling of this handle.
XMLHandle	PreviousSiblingElement (const char *name=0)
	Get the previous sibling element 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.
XMLDeclaration *	ToDeclaration ()
	Safe cast to XMLDeclaration. This can return null.
XMLElement *	ToElement ()
	Safe cast to XMLElement. This can return null.
XMLElement *	ToElement ()
	Safe cast to XMLElement. This can return null.
XMLNode *	ToNode ()
	Safe cast to XMLNode. This can return null.
XMLNode *	ToNode ()
	Safe cast to XMLNode. This can return null.
XMLText *	ToText ()
	Safe cast to XMLText. This can return null.
XMLText *	ToText ()
	Safe cast to XMLText. This can return null.
XMLUnknown *	ToUnknown ()
	Safe cast to XMLUnknown. This can return null.
XMLUnknown *	ToUnknown ()
	Safe cast to XMLUnknown. This can return null.
	XMLHandle (const XMLHandle &ref)
	Copy constructor.
	XMLHandle (const XMLHandle &ref)
	Copy constructor.
	XMLHandle (XMLNode &node)
	Create a handle from a node.
	XMLHandle (XMLNode &node)
	Create a handle from a node.
	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 any node (at any depth of the tree.) This can be a null pointer.

Private Attributes
XMLNode *	_node

Detailed Description

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 2052 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLHandle() [1/6]

tinyxml2::XMLHandle::XMLHandle ( XMLNode * node )

inlineexplicit

Create a handle from any node (at any depth of the tree.) This can be a null pointer.

Definition at line 2056 of file tinyxml2.h.

◆ XMLHandle() [2/6]

tinyxml2::XMLHandle::XMLHandle ( XMLNode & node )

inlineexplicit

Create a handle from a node.

Definition at line 2059 of file tinyxml2.h.

◆ XMLHandle() [3/6]

tinyxml2::XMLHandle::XMLHandle ( const XMLHandle & ref )

inline

Copy constructor.

Definition at line 2062 of file tinyxml2.h.

◆ XMLHandle() [4/6]

tinyxml2::XMLHandle::XMLHandle ( XMLNode * node )

inlineexplicit

Create a handle from any node (at any depth of the tree.) This can be a null pointer.

Definition at line 2056 of file tinyxml2.h.

◆ XMLHandle() [5/6]

tinyxml2::XMLHandle::XMLHandle ( XMLNode & node )

inlineexplicit

Create a handle from a node.

Definition at line 2059 of file tinyxml2.h.

◆ XMLHandle() [6/6]

tinyxml2::XMLHandle::XMLHandle ( const XMLHandle & ref )

inline

Copy constructor.

Definition at line 2062 of file tinyxml2.h.

Member Function Documentation

◆ FirstChild() [1/2]

XMLHandle tinyxml2::XMLHandle::FirstChild ( )

inline

Get the first child of this handle.

Definition at line 2071 of file tinyxml2.h.

◆ FirstChild() [2/2]

XMLHandle tinyxml2::XMLHandle::FirstChild ( )

inline

Get the first child of this handle.

Definition at line 2071 of file tinyxml2.h.

◆ FirstChildElement() [1/2]

XMLHandle tinyxml2::XMLHandle::FirstChildElement ( const char * name = 0 )

inline

Get the first child element of this handle.

Definition at line 2075 of file tinyxml2.h.

◆ FirstChildElement() [2/2]

XMLHandle tinyxml2::XMLHandle::FirstChildElement ( const char * name = 0 )

inline

Get the first child element of this handle.

Definition at line 2075 of file tinyxml2.h.

◆ LastChild() [1/2]

XMLHandle tinyxml2::XMLHandle::LastChild ( )

inline

Get the last child of this handle.

Definition at line 2079 of file tinyxml2.h.

◆ LastChild() [2/2]

XMLHandle tinyxml2::XMLHandle::LastChild ( )

inline

Get the last child of this handle.

Definition at line 2079 of file tinyxml2.h.

◆ LastChildElement() [1/2]

XMLHandle tinyxml2::XMLHandle::LastChildElement ( const char * name = 0 )

inline

Get the last child element of this handle.

Definition at line 2083 of file tinyxml2.h.

◆ LastChildElement() [2/2]

XMLHandle tinyxml2::XMLHandle::LastChildElement ( const char * name = 0 )

inline

Get the last child element of this handle.

Definition at line 2083 of file tinyxml2.h.

◆ NextSibling() [1/2]

XMLHandle tinyxml2::XMLHandle::NextSibling ( )

inline

Get the next sibling of this handle.

Definition at line 2095 of file tinyxml2.h.

◆ NextSibling() [2/2]

XMLHandle tinyxml2::XMLHandle::NextSibling ( )

inline

Get the next sibling of this handle.

Definition at line 2095 of file tinyxml2.h.

◆ NextSiblingElement() [1/2]

XMLHandle tinyxml2::XMLHandle::NextSiblingElement ( const char * name = 0 )

inline

Get the next sibling element of this handle.

Definition at line 2099 of file tinyxml2.h.

◆ NextSiblingElement() [2/2]

XMLHandle tinyxml2::XMLHandle::NextSiblingElement ( const char * name = 0 )

inline

Get the next sibling element of this handle.

Definition at line 2099 of file tinyxml2.h.

◆ operator=() [1/2]

XMLHandle & tinyxml2::XMLHandle::operator= ( const XMLHandle & ref )

inline

Assignment.

Definition at line 2065 of file tinyxml2.h.

◆ operator=() [2/2]

XMLHandle & tinyxml2::XMLHandle::operator= ( const XMLHandle & ref )

inline

Assignment.

Definition at line 2065 of file tinyxml2.h.

◆ PreviousSibling() [1/2]

XMLHandle tinyxml2::XMLHandle::PreviousSibling ( )

inline

Get the previous sibling of this handle.

Definition at line 2087 of file tinyxml2.h.

◆ PreviousSibling() [2/2]

XMLHandle tinyxml2::XMLHandle::PreviousSibling ( )

inline

Get the previous sibling of this handle.

Definition at line 2087 of file tinyxml2.h.

◆ PreviousSiblingElement() [1/2]

XMLHandle tinyxml2::XMLHandle::PreviousSiblingElement ( const char * name = 0 )

inline

Get the previous sibling element of this handle.

Definition at line 2091 of file tinyxml2.h.

◆ PreviousSiblingElement() [2/2]

XMLHandle tinyxml2::XMLHandle::PreviousSiblingElement ( const char * name = 0 )

inline

Get the previous sibling element of this handle.

Definition at line 2091 of file tinyxml2.h.

◆ ToDeclaration() [1/2]

XMLDeclaration * tinyxml2::XMLHandle::ToDeclaration ( )

inline

Safe cast to XMLDeclaration. This can return null.

Definition at line 2120 of file tinyxml2.h.

◆ ToDeclaration() [2/2]

XMLDeclaration * tinyxml2::XMLHandle::ToDeclaration ( )

inline

Safe cast to XMLDeclaration. This can return null.

Definition at line 2120 of file tinyxml2.h.

◆ ToElement() [1/2]

XMLElement * tinyxml2::XMLHandle::ToElement ( )

inline

Safe cast to XMLElement. This can return null.

Definition at line 2108 of file tinyxml2.h.

◆ ToElement() [2/2]

XMLElement * tinyxml2::XMLHandle::ToElement ( )

inline

Safe cast to XMLElement. This can return null.

Definition at line 2108 of file tinyxml2.h.

◆ ToNode() [1/2]

XMLNode * tinyxml2::XMLHandle::ToNode ( )

inline

Safe cast to XMLNode. This can return null.

Definition at line 2104 of file tinyxml2.h.

◆ ToNode() [2/2]

XMLNode * tinyxml2::XMLHandle::ToNode ( )

inline

Safe cast to XMLNode. This can return null.

Definition at line 2104 of file tinyxml2.h.

◆ ToText() [1/2]

XMLText * tinyxml2::XMLHandle::ToText ( )

inline

Safe cast to XMLText. This can return null.

Definition at line 2112 of file tinyxml2.h.

◆ ToText() [2/2]

XMLText * tinyxml2::XMLHandle::ToText ( )

inline

Safe cast to XMLText. This can return null.

Definition at line 2112 of file tinyxml2.h.

◆ ToUnknown() [1/2]

XMLUnknown * tinyxml2::XMLHandle::ToUnknown ( )

inline

Safe cast to XMLUnknown. This can return null.

Definition at line 2116 of file tinyxml2.h.

◆ ToUnknown() [2/2]

XMLUnknown * tinyxml2::XMLHandle::ToUnknown ( )

inline

Safe cast to XMLUnknown. This can return null.

Definition at line 2116 of file tinyxml2.h.

Member Data Documentation

◆ _node

XMLNode * tinyxml2::XMLHandle::_node

private

Definition at line 2125 of file tinyxml2.h.

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

tinyxml2/tinyxml2.h
XML/tinyxml2.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XMLHandle() [1/6]

◆ XMLHandle() [2/6]

◆ XMLHandle() [3/6]

◆ XMLHandle() [4/6]

◆ XMLHandle() [5/6]

◆ XMLHandle() [6/6]

Member Function Documentation

◆ FirstChild() [1/2]

◆ FirstChild() [2/2]

◆ FirstChildElement() [1/2]

◆ FirstChildElement() [2/2]

◆ LastChild() [1/2]

◆ LastChild() [2/2]

◆ LastChildElement() [1/2]

◆ LastChildElement() [2/2]

◆ NextSibling() [1/2]

◆ NextSibling() [2/2]

◆ NextSiblingElement() [1/2]

◆ NextSiblingElement() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PreviousSibling() [1/2]

◆ PreviousSibling() [2/2]

◆ PreviousSiblingElement() [1/2]

◆ PreviousSiblingElement() [2/2]

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ ToNode() [1/2]

◆ ToNode() [2/2]

◆ ToText() [1/2]

◆ ToText() [2/2]

◆ ToUnknown() [1/2]

◆ ToUnknown() [2/2]

Member Data Documentation

◆ _node