tinyxml2::XMLHandle class

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: @verbatim @endverbatim 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: @verbatim 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. @endverbatim 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: @verbatim XMLHandle docHandle( &document ); XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement(); if ( child2 ) { // do something useful @endverbatim Which is MUCH more concise and useful. It is also safe to copy handles - internally they are nothing more than node pointers. @verbatim XMLHandle handleCopy = handle; @endverbatim See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.

Syntax

Show:

Summary

Declaration

from tinyxml2.h:2052

class TINYXML2_LIB XMLHandle { public: explicit XMLHandle( XMLNode* node ) : _node( node ) { } explicit XMLHandle( XMLNode& node ) : _node( &node ) { } XMLHandle( const XMLHandle& ref ) : _node( ref._node ) { } XMLHandle& operator=( const XMLHandle& ref ) { _node = ref._node; return *this; } XMLHandle FirstChild() { return XMLHandle( _node ? _node->FirstChild() : 0 ); } XMLHandle FirstChildElement( const char* name = 0 ) { return XMLHandle( _node ? _node->FirstChildElement( name ) : 0 ); } XMLHandle LastChild() { return XMLHandle( _node ? _node->LastChild() : 0 ); } XMLHandle LastChildElement( const char* name = 0 ) { return XMLHandle( _node ? _node->LastChildElement( name ) : 0 ); } XMLHandle PreviousSibling() { return XMLHandle( _node ? _node->PreviousSibling() : 0 ); } XMLHandle PreviousSiblingElement( const char* name = 0 ) { return XMLHandle( _node ? _node->PreviousSiblingElement( name ) : 0 ); } XMLHandle NextSibling() { return XMLHandle( _node ? _node->NextSibling() : 0 ); } XMLHandle NextSiblingElement( const char* name = 0 ) { return XMLHandle( _node ? _node->NextSiblingElement( name ) : 0 ); } XMLNode* ToNode() { return _node; } XMLElement* ToElement() { return ( _node ? _node->ToElement() : 0 ); } XMLText* ToText() { return ( _node ? _node->ToText() : 0 ); } XMLUnknown* ToUnknown() { return ( _node ? _node->ToUnknown() : 0 ); } XMLDeclaration* ToDeclaration() { return ( _node ? _node->ToDeclaration() : 0 ); } private: XMLNode* _node; };