Xml Scol plugin
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
tinyxml2::XMLNode Class Referenceabstract

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLNode:
tinyxml2::XMLComment tinyxml2::XMLDeclaration tinyxml2::XMLDocument tinyxml2::XMLElement tinyxml2::XMLText tinyxml2::XMLUnknown

Public Member Functions

const XMLDocument * GetDocument () const
 Get the XMLDocument that owns this XMLNode.
 
XMLDocument * GetDocument ()
 Get the XMLDocument that owns this XMLNode.
 
virtual XMLElement * ToElement ()
 Safely cast to an Element, or null.
 
virtual XMLText * ToText ()
 Safely cast to Text, or null.
 
virtual XMLComment * ToComment ()
 Safely cast to a Comment, or null.
 
virtual XMLDocument * ToDocument ()
 Safely cast to a Document, or null.
 
virtual XMLDeclaration * ToDeclaration ()
 Safely cast to a Declaration, or null.
 
virtual XMLUnknown * ToUnknown ()
 Safely cast to an Unknown, or null.
 
virtual const XMLElement * ToElement () const
 
virtual const XMLText * ToText () const
 
virtual const XMLComment * ToComment () const
 
virtual const XMLDocument * ToDocument () const
 
virtual const XMLDeclaration * ToDeclaration () const
 
virtual const XMLUnknown * ToUnknown () const
 
const char * Value () const
 
void SetValue (const char *val, bool staticMem=false)
 
const XMLNode * Parent () const
 Get the parent of this node on the DOM.
 
XMLNode * Parent ()
 
bool NoChildren () const
 Returns true if this node has no children.
 
const XMLNode * FirstChild () const
 Get the first child node, or null if none exists.
 
XMLNode * FirstChild ()
 
const XMLElement * FirstChildElement (const char *value=0) const
 
XMLElement * FirstChildElement (const char *value=0)
 
const XMLNode * LastChild () const
 Get the last child node, or null if none exists.
 
XMLNode * LastChild ()
 
const XMLElement * LastChildElement (const char *value=0) const
 
XMLElement * LastChildElement (const char *value=0)
 
const XMLNode * PreviousSibling () const
 Get the previous (left) sibling node of this node.
 
XMLNode * PreviousSibling ()
 
const XMLElement * PreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an opitionally supplied name.
 
XMLElement * PreviousSiblingElement (const char *value=0)
 
const XMLNode * NextSibling () const
 Get the next (right) sibling node of this node.
 
XMLNode * NextSibling ()
 
const XMLElement * NextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an opitionally supplied name.
 
XMLElement * NextSiblingElement (const char *value=0)
 
XMLNode * InsertEndChild (XMLNode *addThis)
 
XMLNode * LinkEndChild (XMLNode *addThis)
 
XMLNode * InsertFirstChild (XMLNode *addThis)
 
XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void DeleteChildren ()
 
void DeleteChild (XMLNode *node)
 
virtual XMLNode * ShallowClone (XMLDocument *document) const =0
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual bool Accept (XMLVisitor *visitor) const =0
 
virtual char * ParseDeep (char *, StrPair *)
 

Protected Member Functions

 XMLNode (XMLDocument *)
 
 XMLNode (const XMLNode &)
 
XMLNode & operator= (const XMLNode &)
 

Protected Attributes

XMLDocument * _document
 
XMLNode * _parent
 
StrPair _value
 
XMLNode * _firstChild
 
XMLNode * _lastChild
 
XMLNode * _prev
 
XMLNode * _next
 

Friends

class XMLDocument
 
class XMLElement
 

Detailed Description

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

    A Document can contain:     Element (container or leaf)
                                                Comment (leaf)
                                                Unknown (leaf)
                                                Declaration( leaf )

    An Element can contain:     Element (container or leaf)
                                                Text    (leaf)
                                                Attributes (not on tree)
                                                Comment (leaf)
                                                Unknown (leaf)

Definition at line 523 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLNode()

tinyxml2::XMLNode::XMLNode ( XMLDocument *  doc)
protected

Definition at line 585 of file tinyxml2.cpp.

◆ ~XMLNode()

tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual

Definition at line 594 of file tinyxml2.cpp.

Member Function Documentation

◆ Accept()

virtual bool tinyxml2::XMLNode::Accept ( XMLVisitor *  visitor) const
pure virtual

Accept a hierarchical visit of 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 tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, tinyxml2::XMLElement, and tinyxml2::XMLDocument.

◆ DeleteChild()

void tinyxml2::XMLNode::DeleteChild ( XMLNode *  node)

Delete a child of this node.

Definition at line 646 of file tinyxml2.cpp.

◆ DeleteChildren()

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 614 of file tinyxml2.cpp.

◆ FirstChild() [1/2]

XMLNode * tinyxml2::XMLNode::FirstChild ( )
inline

Definition at line 619 of file tinyxml2.h.

◆ FirstChild() [2/2]

const XMLNode * tinyxml2::XMLNode::FirstChild ( ) const
inline

Get the first child node, or null if none exists.

Definition at line 615 of file tinyxml2.h.

◆ FirstChildElement() [1/2]

XMLElement * tinyxml2::XMLNode::FirstChildElement ( const char *  value = 0)
inline

Definition at line 628 of file tinyxml2.h.

◆ FirstChildElement() [2/2]

const XMLElement * tinyxml2::XMLNode::FirstChildElement ( const char *  value = 0) const

Get the first child element, or optionally the first child element with the specified name.

Definition at line 722 of file tinyxml2.cpp.

◆ GetDocument() [1/2]

XMLDocument * tinyxml2::XMLNode::GetDocument ( )
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 534 of file tinyxml2.h.

◆ GetDocument() [2/2]

const XMLDocument * tinyxml2::XMLNode::GetDocument ( ) const
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 530 of file tinyxml2.h.

◆ InsertAfterChild()

XMLNode * tinyxml2::XMLNode::InsertAfterChild ( XMLNode *  afterThis,
XMLNode *  addThis 
)

Add a node after the specified child node.

Definition at line 700 of file tinyxml2.cpp.

◆ InsertEndChild()

XMLNode * tinyxml2::XMLNode::InsertEndChild ( XMLNode *  addThis)

Add a child node as the last (right) child.

Definition at line 653 of file tinyxml2.cpp.

◆ InsertFirstChild()

XMLNode * tinyxml2::XMLNode::InsertFirstChild ( XMLNode *  addThis)

Add a child node as the first (left) child.

Definition at line 676 of file tinyxml2.cpp.

◆ LastChild() [1/2]

XMLNode * tinyxml2::XMLNode::LastChild ( )
inline

Definition at line 637 of file tinyxml2.h.

◆ LastChild() [2/2]

const XMLNode * tinyxml2::XMLNode::LastChild ( ) const
inline

Get the last child node, or null if none exists.

Definition at line 633 of file tinyxml2.h.

◆ LastChildElement() [1/2]

XMLElement * tinyxml2::XMLNode::LastChildElement ( const char *  value = 0)
inline

Definition at line 646 of file tinyxml2.h.

◆ LastChildElement() [2/2]

const XMLElement * tinyxml2::XMLNode::LastChildElement ( const char *  value = 0) const

Get the last child element or optionally the last child element with the specified name.

Definition at line 736 of file tinyxml2.cpp.

◆ LinkEndChild()

XMLNode * tinyxml2::XMLNode::LinkEndChild ( XMLNode *  addThis)
inline

Definition at line 687 of file tinyxml2.h.

◆ NextSibling() [1/2]

XMLNode * tinyxml2::XMLNode::NextSibling ( )
inline

Definition at line 671 of file tinyxml2.h.

◆ NextSibling() [2/2]

const XMLNode * tinyxml2::XMLNode::NextSibling ( ) const
inline

Get the next (right) sibling node of this node.

Definition at line 667 of file tinyxml2.h.

◆ NextSiblingElement() [1/2]

XMLElement * tinyxml2::XMLNode::NextSiblingElement ( const char *  value = 0)
inline

Definition at line 678 of file tinyxml2.h.

◆ NextSiblingElement() [2/2]

const XMLElement * tinyxml2::XMLNode::NextSiblingElement ( const char *  value = 0) const

Get the next (right) sibling element of this node, with an opitionally supplied name.

Definition at line 750 of file tinyxml2.cpp.

◆ NoChildren()

bool tinyxml2::XMLNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 610 of file tinyxml2.h.

◆ Parent() [1/2]

XMLNode * tinyxml2::XMLNode::Parent ( )
inline

Definition at line 605 of file tinyxml2.h.

◆ Parent() [2/2]

const XMLNode * tinyxml2::XMLNode::Parent ( ) const
inline

Get the parent of this node on the DOM.

Definition at line 601 of file tinyxml2.h.

◆ ParseDeep()

char * tinyxml2::XMLNode::ParseDeep ( char *  p,
StrPair *  parentEnd 
)
virtual

Definition at line 774 of file tinyxml2.cpp.

◆ PreviousSibling() [1/2]

XMLNode * tinyxml2::XMLNode::PreviousSibling ( )
inline

Definition at line 655 of file tinyxml2.h.

◆ PreviousSibling() [2/2]

const XMLNode * tinyxml2::XMLNode::PreviousSibling ( ) const
inline

Get the previous (left) sibling node of this node.

Definition at line 651 of file tinyxml2.h.

◆ PreviousSiblingElement() [1/2]

XMLElement * tinyxml2::XMLNode::PreviousSiblingElement ( const char *  value = 0)
inline

Definition at line 662 of file tinyxml2.h.

◆ PreviousSiblingElement() [2/2]

const XMLElement * tinyxml2::XMLNode::PreviousSiblingElement ( const char *  value = 0) const

Get the previous (left) sibling element of this node, with an opitionally supplied name.

Definition at line 762 of file tinyxml2.cpp.

◆ SetValue()

void tinyxml2::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)

Set the Value of an XML node.

See also
Value()

Definition at line 603 of file tinyxml2.cpp.

◆ ShallowClone()

virtual XMLNode * tinyxml2::XMLNode::ShallowClone ( XMLDocument *  document) const
pure virtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, and tinyxml2::XMLElement.

◆ ShallowEqual()

virtual bool tinyxml2::XMLNode::ShallowEqual ( const XMLNode *  compare) const
pure virtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, and tinyxml2::XMLElement.

◆ ToComment() [1/2]

virtual XMLComment * tinyxml2::XMLNode::ToComment ( )
inlinevirtual

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 547 of file tinyxml2.h.

◆ ToComment() [2/2]

virtual const XMLComment * tinyxml2::XMLNode::ToComment ( ) const
inlinevirtual

Definition at line 569 of file tinyxml2.h.

◆ ToDeclaration() [1/2]

virtual XMLDeclaration * tinyxml2::XMLNode::ToDeclaration ( )
inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 555 of file tinyxml2.h.

◆ ToDeclaration() [2/2]

virtual const XMLDeclaration * tinyxml2::XMLNode::ToDeclaration ( ) const
inlinevirtual

Definition at line 575 of file tinyxml2.h.

◆ ToDocument() [1/2]

virtual XMLDocument * tinyxml2::XMLNode::ToDocument ( )
inlinevirtual

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 551 of file tinyxml2.h.

◆ ToDocument() [2/2]

virtual const XMLDocument * tinyxml2::XMLNode::ToDocument ( ) const
inlinevirtual

Definition at line 572 of file tinyxml2.h.

◆ ToElement() [1/2]

virtual XMLElement * tinyxml2::XMLNode::ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

Definition at line 539 of file tinyxml2.h.

◆ ToElement() [2/2]

virtual const XMLElement * tinyxml2::XMLNode::ToElement ( ) const
inlinevirtual

Definition at line 563 of file tinyxml2.h.

◆ ToText() [1/2]

virtual XMLText * tinyxml2::XMLNode::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

Definition at line 543 of file tinyxml2.h.

◆ ToText() [2/2]

virtual const XMLText * tinyxml2::XMLNode::ToText ( ) const
inlinevirtual

Definition at line 566 of file tinyxml2.h.

◆ ToUnknown() [1/2]

virtual XMLUnknown * tinyxml2::XMLNode::ToUnknown ( )
inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 559 of file tinyxml2.h.

◆ ToUnknown() [2/2]

virtual const XMLUnknown * tinyxml2::XMLNode::ToUnknown ( ) const
inlinevirtual

Definition at line 578 of file tinyxml2.h.

◆ Value()

const char * tinyxml2::XMLNode::Value ( ) const
inline

The meaning of 'value' changes for the specific type. 

Document:       empty
Element:        name of the element
Comment:        the comment text
Unknown:        the tag contents
Text:           the text string

Definition at line 591 of file tinyxml2.h.

Friends And Related Symbol Documentation

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 525 of file tinyxml2.h.

◆ XMLElement

friend class XMLElement
friend

Definition at line 526 of file tinyxml2.h.

Member Data Documentation

◆ _document

XMLDocument* tinyxml2::XMLNode::_document
protected

Definition at line 761 of file tinyxml2.h.

◆ _firstChild

XMLNode* tinyxml2::XMLNode::_firstChild
protected

Definition at line 765 of file tinyxml2.h.

◆ _lastChild

XMLNode* tinyxml2::XMLNode::_lastChild
protected

Definition at line 766 of file tinyxml2.h.

◆ _next

XMLNode* tinyxml2::XMLNode::_next
protected

Definition at line 769 of file tinyxml2.h.

◆ _parent

XMLNode* tinyxml2::XMLNode::_parent
protected

Definition at line 762 of file tinyxml2.h.

◆ _prev

XMLNode* tinyxml2::XMLNode::_prev
protected

Definition at line 768 of file tinyxml2.h.

◆ _value

StrPair tinyxml2::XMLNode::_value
mutableprotected

Definition at line 763 of file tinyxml2.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8