#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDeclaration:

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const override

virtual XMLNode *	ShallowClone (XMLDocument *document) const override

virtual bool	ShallowEqual (const XMLNode *compare) const override

virtual const XMLDeclaration *	ToDeclaration () const override

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

Public Member Functions inherited from tinyxml2::XMLNode
int	ChildElementCount () const

int	ChildElementCount (const char *value) const

XMLNode *	DeepClone (XMLDocument *target) const

void	DeleteChild (XMLNode *node)

void	DeleteChildren ()

XMLNode *	FirstChild ()

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

XMLElement *	FirstChildElement (const char *name=0)

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

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

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

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file. More...

void *	GetUserData () const

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	LastChild ()

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

XMLElement *	LastChildElement (const char *name=0)

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

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	NextSibling ()

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

XMLElement *	NextSiblingElement (const char *name=0)

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

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

XMLNode *	Parent ()

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	PreviousSibling ()

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

XMLElement *	PreviousSiblingElement (const char *name=0)

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

void	SetUserData (void *userData)

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
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr) override

	XMLDeclaration (XMLDocument *doc)

virtual	~XMLDeclaration ()

Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

Private Member Functions
XMLDeclaration &	operator= (const XMLDeclaration &)

	XMLDeclaration (const XMLDeclaration &)

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_next

XMLNode *	_parent

int	_parseLineNum

XMLNode *	_prev

void *	_userData

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.

Definition at line 1073 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLDeclaration() [1/2]

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

explicitprotected

Definition at line 1349 of file tinyxml2.cpp.

◆ ~XMLDeclaration()

tinyxml2::XMLDeclaration::~XMLDeclaration ( )

protectedvirtual

Definition at line 1354 of file tinyxml2.cpp.

◆ XMLDeclaration() [2/2]

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

private

Member Function Documentation

◆ Accept()

bool tinyxml2::XMLDeclaration::Accept ( XMLVisitor * visitor ) const

overridevirtual

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

Definition at line 1390 of file tinyxml2.cpp.

◆ operator=()

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

private

◆ ParseDeep()

char * tinyxml2::XMLDeclaration::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)

overrideprotectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1360 of file tinyxml2.cpp.

◆ ShallowClone()

XMLNode * tinyxml2::XMLDeclaration::ShallowClone ( XMLDocument * document ) const

overridevirtual

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.

Definition at line 1371 of file tinyxml2.cpp.

◆ ShallowEqual()

bool tinyxml2::XMLDeclaration::ShallowEqual ( const XMLNode * compare ) const

overridevirtual

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.

Definition at line 1381 of file tinyxml2.cpp.

◆ ToDeclaration() [1/2]

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

inlineoverridevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1080 of file tinyxml2.h.

◆ ToDeclaration() [2/2]

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

inlineoverridevirtual

Safely cast to a Declaration, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1077 of file tinyxml2.h.

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument

friend

Definition at line 1075 of file tinyxml2.h.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLDeclaration() [1/2]

◆ ~XMLDeclaration()

◆ XMLDeclaration() [2/2]

Member Function Documentation

◆ Accept()

◆ operator=()

◆ ParseDeep()

◆ ShallowClone()

◆ ShallowEqual()

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

Friends And Related Function Documentation

◆ XMLDocument