#include <tinyxml2.h>

Inheritance diagram for ttv::xml::XMLComment:

Public Member Functions
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null. More...

virtual const XMLComment *	ToComment () const

virtual bool	Accept (XMLVisitor *visitor) const

virtual XMLNode *	ShallowClone (XMLDocument *document) const

virtual bool	ShallowEqual (const XMLNode *compare) const

const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual const XMLElement *	ToElement () const

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual const XMLText *	ToText () const

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual const XMLDocument *	ToDocument () const

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual const XMLDeclaration *	ToDeclaration () const

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

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. More...

XMLNode *	Parent ()

bool	NoChildren () const
	Returns true if this node has no children. More...

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists. More...

XMLNode *	FirstChild ()

const XMLElement *	FirstChildElement (const char *name=0) const

XMLElement *	FirstChildElement (const char *name=0)

const XMLNode *	LastChild () const
	Get the last child node, or null if none exists. More...

XMLNode *	LastChild ()

const XMLElement *	LastChildElement (const char *name=0) const

XMLElement *	LastChildElement (const char *name=0)

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()

const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name. More...

XMLElement *	PreviousSiblingElement (const char *name=0)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()

const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name. More...

XMLElement *	NextSiblingElement (const char *name=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)

void	SetUserData (void *userData)

void *	GetUserData () const

Protected Member Functions
	XMLComment (XMLDocument *doc)

virtual	~XMLComment ()

char *	ParseDeep (char , StrPair endTag)

Protected Attributes
XMLDocument *	_document

XMLNode *	_parent

StrPair	_value

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_prev

XMLNode *	_next

void *	_userData

Private Member Functions
	XMLComment (const XMLComment &)

XMLComment &	operator= (const XMLComment &)

Friends
class	XMLDocument

Detailed Description

An XML Comment.

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

ttv::xml::XMLComment::XMLComment ( XMLDocument * doc )

protected

◆ ~XMLComment()

virtual ttv::xml::XMLComment::~XMLComment ( )

protectedvirtual

◆ XMLComment() [2/2]

ttv::xml::XMLComment::XMLComment ( const XMLComment & )

private

Member Function Documentation

◆ Accept()

virtual bool ttv::xml::XMLComment::Accept ( XMLVisitor * visitor ) const

virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

XMLPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implements ttv::xml::XMLNode.

◆ DeleteChild()

void ttv::xml::XMLNode::DeleteChild ( XMLNode * node )

inherited

Delete a child of this node.

◆ DeleteChildren()

void ttv::xml::XMLNode::DeleteChildren ( )

inherited

Delete all the children of this node.

◆ FirstChild() [1/2]

const XMLNode* ttv::xml::XMLNode::FirstChild ( ) const

inlineinherited

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

◆ FirstChild() [2/2]

XMLNode* ttv::xml::XMLNode::FirstChild ( )

inlineinherited

◆ FirstChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char * name = 0 ) const

inherited

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

◆ FirstChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::FirstChildElement ( const char * name = 0 )

inlineinherited

◆ GetDocument() [1/2]

const XMLDocument* ttv::xml::XMLNode::GetDocument ( ) const

inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetDocument() [2/2]

XMLDocument* ttv::xml::XMLNode::GetDocument ( )

inlineinherited

Get the XMLDocument that owns this XMLNode.

◆ GetUserData()

void* ttv::xml::XMLNode::GetUserData ( ) const

inlineinherited

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

◆ InsertAfterChild()

XMLNode* ttv::xml::XMLNode::InsertAfterChild	(	XMLNode *	afterThis,
		XMLNode *	addThis
	)

inherited

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

◆ InsertEndChild()

XMLNode* ttv::xml::XMLNode::InsertEndChild ( XMLNode * addThis )

inherited

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ InsertFirstChild()

XMLNode* ttv::xml::XMLNode::InsertFirstChild ( XMLNode * addThis )

inherited

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

◆ LastChild() [1/2]

const XMLNode* ttv::xml::XMLNode::LastChild ( ) const

inlineinherited

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

◆ LastChild() [2/2]

XMLNode* ttv::xml::XMLNode::LastChild ( )

inlineinherited

◆ LastChildElement() [1/2]

const XMLElement* ttv::xml::XMLNode::LastChildElement ( const char * name = 0 ) const

inherited

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

◆ LastChildElement() [2/2]

XMLElement* ttv::xml::XMLNode::LastChildElement ( const char * name = 0 )

inlineinherited

◆ LinkEndChild()

XMLNode* ttv::xml::XMLNode::LinkEndChild ( XMLNode * addThis )

inlineinherited

◆ NextSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::NextSibling ( ) const

inlineinherited

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

◆ NextSibling() [2/2]

XMLNode* ttv::xml::XMLNode::NextSibling ( )

inlineinherited

◆ NextSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char * name = 0 ) const

inherited

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

◆ NextSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::NextSiblingElement ( const char * name = 0 )

inlineinherited

◆ NoChildren()

bool ttv::xml::XMLNode::NoChildren ( ) const

inlineinherited

Returns true if this node has no children.

◆ operator=()

XMLComment& ttv::xml::XMLComment::operator= ( const XMLComment & )

private

◆ Parent() [1/2]

const XMLNode* ttv::xml::XMLNode::Parent ( ) const

inlineinherited

Get the parent of this node on the DOM.

◆ Parent() [2/2]

XMLNode* ttv::xml::XMLNode::Parent ( )

inlineinherited

◆ ParseDeep()

char* ttv::xml::XMLComment::ParseDeep	(	char *	,
		StrPair *	endTag
	)

protectedvirtual

Reimplemented from ttv::xml::XMLNode.

◆ PreviousSibling() [1/2]

const XMLNode* ttv::xml::XMLNode::PreviousSibling ( ) const

inlineinherited

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

◆ PreviousSibling() [2/2]

XMLNode* ttv::xml::XMLNode::PreviousSibling ( )

inlineinherited

◆ PreviousSiblingElement() [1/2]

const XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char * name = 0 ) const

inherited

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

◆ PreviousSiblingElement() [2/2]

XMLElement* ttv::xml::XMLNode::PreviousSiblingElement ( const char * name = 0 )

inlineinherited

◆ SetUserData()

void ttv::xml::XMLNode::SetUserData ( void * userData )

inlineinherited

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

◆ SetValue()

void ttv::xml::XMLNode::SetValue	(	const char *	val,
		bool	staticMem = `false`
	)

inherited

Set the Value of an XML node.

See also: Value()

◆ ShallowClone()

virtual XMLNode* ttv::xml::XMLComment::ShallowClone ( XMLDocument * document ) const

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.

Implements ttv::xml::XMLNode.

◆ ShallowEqual()

virtual bool ttv::xml::XMLComment::ShallowEqual ( const XMLNode * compare ) const

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.

Implements ttv::xml::XMLNode.

◆ ToComment() [1/2]

virtual XMLComment* ttv::xml::XMLComment::ToComment ( )

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from ttv::xml::XMLNode.

◆ ToComment() [2/2]

virtual const XMLComment* ttv::xml::XMLComment::ToComment ( ) const

inlinevirtual

Reimplemented from ttv::xml::XMLNode.

◆ ToDeclaration() [1/2]

virtual XMLDeclaration* ttv::xml::XMLNode::ToDeclaration ( )

inlinevirtualinherited

Safely cast to a Declaration, or null.

Reimplemented in ttv::xml::XMLDeclaration.

◆ ToDeclaration() [2/2]

virtual const XMLDeclaration* ttv::xml::XMLNode::ToDeclaration ( ) const

inlinevirtualinherited

Reimplemented in ttv::xml::XMLDeclaration.

◆ ToDocument() [1/2]

virtual XMLDocument* ttv::xml::XMLNode::ToDocument ( )

inlinevirtualinherited

Safely cast to a Document, or null.

Reimplemented in ttv::xml::XMLDocument.

◆ ToDocument() [2/2]

virtual const XMLDocument* ttv::xml::XMLNode::ToDocument ( ) const

inlinevirtualinherited

Reimplemented in ttv::xml::XMLDocument.

◆ ToElement() [1/2]

virtual XMLElement* ttv::xml::XMLNode::ToElement ( )

inlinevirtualinherited

Safely cast to an Element, or null.

Reimplemented in ttv::xml::XMLElement.

◆ ToElement() [2/2]

virtual const XMLElement* ttv::xml::XMLNode::ToElement ( ) const

inlinevirtualinherited

Reimplemented in ttv::xml::XMLElement.

◆ ToText() [1/2]

virtual XMLText* ttv::xml::XMLNode::ToText ( )

inlinevirtualinherited

Safely cast to Text, or null.

Reimplemented in ttv::xml::XMLText.

◆ ToText() [2/2]

virtual const XMLText* ttv::xml::XMLNode::ToText ( ) const

inlinevirtualinherited

Reimplemented in ttv::xml::XMLText.

◆ ToUnknown() [1/2]

virtual XMLUnknown* ttv::xml::XMLNode::ToUnknown ( )

inlinevirtualinherited

Safely cast to an Unknown, or null.

Reimplemented in ttv::xml::XMLUnknown.

◆ ToUnknown() [2/2]

virtual const XMLUnknown* ttv::xml::XMLNode::ToUnknown ( ) const

inlinevirtualinherited

Reimplemented in ttv::xml::XMLUnknown.

◆ Value()

const char* ttv::xml::XMLNode::Value ( ) const

inherited

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

Document:   empty (NULL is returned, not an empty string)
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument

friend

Member Data Documentation

◆ _document

XMLDocument* ttv::xml::XMLNode::_document

protectedinherited

◆ _firstChild

XMLNode* ttv::xml::XMLNode::_firstChild

protectedinherited

◆ _lastChild

XMLNode* ttv::xml::XMLNode::_lastChild

protectedinherited

◆ _next

XMLNode* ttv::xml::XMLNode::_next

protectedinherited

◆ _parent

XMLNode* ttv::xml::XMLNode::_parent

protectedinherited

◆ _prev

XMLNode* ttv::xml::XMLNode::_prev

protectedinherited

◆ _userData

void* ttv::xml::XMLNode::_userData

protectedinherited

◆ _value

StrPair ttv::xml::XMLNode::_value

mutableprotectedinherited

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

modules/core/core_common/include/twitchsdk/core/xml/tinyxml2.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

◆ ~XMLComment()

◆ XMLComment() [2/2]

Member Function Documentation

◆ Accept()

◆ DeleteChild()

◆ DeleteChildren()

◆ FirstChild() [1/2]

◆ FirstChild() [2/2]

◆ FirstChildElement() [1/2]

◆ FirstChildElement() [2/2]

◆ GetDocument() [1/2]

◆ GetDocument() [2/2]

◆ GetUserData()

◆ InsertAfterChild()

◆ InsertEndChild()

◆ InsertFirstChild()

◆ LastChild() [1/2]

◆ LastChild() [2/2]

◆ LastChildElement() [1/2]

◆ LastChildElement() [2/2]

◆ LinkEndChild()

◆ NextSibling() [1/2]

◆ NextSibling() [2/2]

◆ NextSiblingElement() [1/2]

◆ NextSiblingElement() [2/2]

◆ NoChildren()

◆ operator=()

◆ Parent() [1/2]

◆ Parent() [2/2]

◆ ParseDeep()

◆ PreviousSibling() [1/2]

◆ PreviousSibling() [2/2]

◆ PreviousSiblingElement() [1/2]

◆ PreviousSiblingElement() [2/2]

◆ SetUserData()

◆ SetValue()

◆ ShallowClone()

◆ ShallowEqual()

◆ ToComment() [1/2]

◆ ToComment() [2/2]

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ ToText() [1/2]

◆ ToText() [2/2]

◆ ToUnknown() [1/2]

◆ ToUnknown() [2/2]

◆ Value()

Friends And Related Function Documentation

◆ XMLDocument

Member Data Documentation

◆ _document

◆ _firstChild

◆ _lastChild

◆ _next

◆ _parent

◆ _prev

◆ _userData

◆ _value