TinyXML - Tinyxml2 — ContextQMD

| TinyXML-2 10.0.0 |

Searching...

No Matches

tinyxml2
XMLDocument

Public Member Functions | List of all members

tinyxml2::XMLDocument Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLDocument:

Public Member Functions

Detailed Description

A Document binds together all the functionality. It can be saved, loaded, and printed to the screen. All Nodes are connected and allocated to a Document. If the Document is deleted, all its Nodes are also deleted.

Member Function Documentation

◆Accept()

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

◆DeepCopy()

Copies this document to a target document. The target will be completely cleared before the copy. If you want to copy a sub-tree, see XMLNode::DeepClone().

NOTE: that the 'target' must be non-null.

◆DeleteNode()

Delete a node associated with this document. It will be unlinked from the DOM.

◆ErrorStr()

| const char * tinyxml2::XMLDocument::ErrorStr | ( | | ) | const |

Returns a "long form" error description. A hopefully helpful diagnostic with location, line number, and/or additional info.

◆HasBOM()

| bool tinyxml2::XMLDocument::HasBOM | ( | | ) | const |

| inline |

Returns true if this document has a leading Byte Order Mark of UTF8.

◆LoadFile() [1/2]

Load an XML file from disk. Returns XML_SUCCESS (0) on success, or an errorID.

◆LoadFile() [2/2]

| XMLError tinyxml2::XMLDocument::LoadFile | ( | FILE * | | ) | |

Load an XML file from disk. You are responsible for providing and closing the FILE*.

NOTE: The file should be opened as binary ("rb") not text in order for TinyXML-2 to correctly do newline normalization.

Returns XML_SUCCESS (0) on success, or an errorID.

◆NewComment()

Create a new Comment associated with this Document. The memory for the Comment is managed by the Document.

◆NewDeclaration()

Create a new Declaration associated with this Document. The memory for the object is managed by the Document.

If the 'text' param is null, the standard declaration is used.:

<?xml version="1.0" encoding="UTF-8"?>

◆NewElement()

Create a new Element associated with this Document. The memory for the Element is managed by the Document.

◆NewText()

Create a new Text associated with this Document. The memory for the Text is managed by the Document.

◆NewUnknown()

Create a new Unknown associated with this Document. The memory for the object is managed by the Document.

◆Parse()

Parse an XML file from a character string. Returns XML_SUCCESS (0) on success, or an errorID.

You may optionally pass in the 'nBytes', which is the number of bytes which will be parsed. If not specified, TinyXML-2 will assume 'xml' points to a null terminated string.

◆Print()

Print the Document. If the Printer is not provided, it will print to stdout. If you provide Printer, this can print to a file:

XMLPrinter printer( fp );
doc.Print( &printer );

Or you can use a printer to print to memory:

XMLPrinter printer;
doc.Print( &printer );
// printer.CStr() has a const char* to the XML

◆RootElement()

| XMLElement * tinyxml2::XMLDocument::RootElement | ( | | ) | |

| inline |

Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().

◆SaveFile() [1/2]

Save the XML file to disk. Returns XML_SUCCESS (0) on success, or an errorID.

◆SaveFile() [2/2]

Save the XML file to disk. You are responsible for providing and closing the FILE*.

Returns XML_SUCCESS (0) on success, or an errorID.

◆SetBOM()

| inline |

Sets whether to write the BOM when writing the file.

◆ShallowClone()

| inlineoverridevirtual |

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()

| inlineoverridevirtual |

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.

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

tinyxml2.h

Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0