tinyxml2::XMLDeclaration Class Reference

#include "tinyxml2.h"

Inheritance diagram for tinyxml2::XMLDeclaration:

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

Protected Member Functions
	XMLDeclaration (XMLDocument *doc)
	XMLDeclaration (const XMLDeclaration &)
virtual	~XMLDeclaration ()
XMLDeclaration &	operator= (const XMLDeclaration &)
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)
	XMLNode (const XMLNode &)
virtual	~XMLNode ()
XMLNode &	operator= (const XMLNode &)

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document
XMLNode *	_firstChild
XMLNode *	_lastChild
XMLNode *	_next
XMLNode *	_parent
XMLNode *	_prev
StrPair	_value

Detailed Description

In correct XML the declaration is the first entry in the file.

    <?xml version="1.0" standalone="yes"?>

TinyXML-2 will happily read or write files without a declaration, however.

The text of the declaration isn't interpreted. It is parsed and written as a string.

Constructor & Destructor Documentation

XMLDeclaration() [1/2]

tinyxml2::XMLDeclaration::XMLDeclaration ( XMLDocument *  doc )

protected

~XMLDeclaration()

virtual tinyxml2::XMLDeclaration::~XMLDeclaration ( )

protectedvirtual

XMLDeclaration() [2/2]

tinyxml2::XMLDeclaration::XMLDeclaration ( const XMLDeclaration &  )

protected

Member Function Documentation

Accept()

virtual bool tinyxml2::XMLDeclaration::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:

• http://www.saxproject.org/
• http://c2.com/cgi/wiki?HierarchicalVisitorPattern

Which are both good references for "visiting".

An example of using Accept():

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

Implements tinyxml2::XMLNode.

operator=()

XMLDeclaration& tinyxml2::XMLDeclaration::operator= ( const XMLDeclaration &  )

protected

ParseDeep()

char* tinyxml2::XMLDeclaration::ParseDeep ( char *  , StrPair *  endTag  )

virtual

Reimplemented from tinyxml2::XMLNode.

ShallowClone()

virtual XMLNode* tinyxml2::XMLDeclaration::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 tinyxml2::XMLNode.

ShallowEqual()

virtual bool tinyxml2::XMLDeclaration::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 tinyxml2::XMLNode.

ToDeclaration() [1/2]

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

virtual

Safely cast to a Declaration, or null.

Reimplemented from tinyxml2::XMLNode.

ToDeclaration() [2/2]

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

virtual

Reimplemented from tinyxml2::XMLNode.

Friends And Related Function Documentation

XMLDocument

friend class XMLDocument

friend

---

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

• /build/master-contrib_docs-lin64/opencv_contrib/modules/datasets/include/opencv2/datasets/tinyxml2/tinyxml2.h