QDomDocument Class

The QDomDocument class represents an XML document. More...

Header:	#include <QDomDocument>
qmake:	QT += xml
Inherits:	QDomNode

List of all members, including inherited members

Note: All functions in this class are reentrant.

Public Functions

	QDomDocument(const QDomDocument &x)
	QDomDocument(const QDomDocumentType &doctype)
	QDomDocument(const QString &name)
	QDomDocument()
QDomDocument &	operator=(const QDomDocument &x)
	~QDomDocument()
QDomAttr	createAttribute(const QString &name)
QDomAttr	createAttributeNS(const QString &nsURI, const QString &qName)
QDomCDATASection	createCDATASection(const QString &value)
QDomComment	createComment(const QString &value)
QDomDocumentFragment	createDocumentFragment()
QDomElement	createElement(const QString &tagName)
QDomElement	createElementNS(const QString &nsURI, const QString &qName)
QDomEntityReference	createEntityReference(const QString &name)
QDomProcessingInstruction	createProcessingInstruction(const QString &target, const QString &data)
QDomText	createTextNode(const QString &value)
QDomDocumentType	doctype() const
QDomElement	documentElement() const
QDomElement	elementById(const QString &elementId)
QDomNodeList	elementsByTagName(const QString &tagname) const
QDomNodeList	elementsByTagNameNS(const QString &nsURI, const QString &localName)
QDomImplementation	implementation() const
QDomNode	importNode(const QDomNode &importedNode, bool deep)
QDomNode::NodeType	nodeType() const
bool	setContent(const QByteArray &data, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(const QString &text, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(QIODevice *dev, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(QXmlInputSource *source, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(const QByteArray &buffer, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(const QString &text, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(QIODevice *dev, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
bool	setContent(QXmlInputSource *source, QXmlReader *reader, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)
QByteArray	toByteArray(int indent = 1) const
QString	toString(int indent = 1) const

Detailed Description

The QDomDocument class represents the entire XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc., cannot exist outside the context of a document, the document class also contains the factory functions needed to create these objects. The node objects created have an ownerDocument() function which associates them with the document within whose context they were created. The DOM classes that will be used most often are QDomNode, QDomDocument, QDomElement and QDomText.

The parsed XML is represented internally by a tree of objects that can be accessed using the various QDom classes. All QDom classes only reference objects in the internal tree. The internal objects in the DOM tree will get deleted once the last QDom object referencing them or the QDomDocument itself is deleted.

Creation of elements, text nodes, etc. is done using the various factory functions provided in this class. Using the default constructors of the QDom classes will only result in empty objects that cannot be manipulated or inserted into the Document.

The QDomDocument class has several functions for creating document data, for example, createElement(), createTextNode(), createComment(), createCDATASection(), createProcessingInstruction(), createAttribute() and createEntityReference(). Some of these functions have versions that support namespaces, i.e. createElementNS() and createAttributeNS(). The createDocumentFragment() function is used to hold parts of the document; this is useful for manipulating for complex documents.

The entire content of the document is set with setContent(). This function parses the string it is passed as an XML document and creates the DOM tree that represents the document. The root element is available using documentElement(). The textual representation of the document can be obtained using toString().

Note: The DOM tree might end up reserving a lot of memory if the XML document is big. For such documents, the QXmlStreamReader or the QXmlQuery classes might be better solutions.

It is possible to insert a node from another document into the document using importNode().

You can obtain a list of all the elements that have a particular tag with elementsByTagName() or with elementsByTagNameNS().

The QDom classes are typically used as follows:

QDomDocument doc("mydocument");
QFile file("mydocument.xml");
if (!file.open(QIODevice::ReadOnly))
    return;
if (!doc.setContent(&file)) {
    file.close();
    return;
}
file.close();

// print out the element names of all elements that are direct children
// of the outermost element.
QDomElement docElem = doc.documentElement();

QDomNode n = docElem.firstChild();
while(!n.isNull()) {
    QDomElement e = n.toElement(); // try to convert the node to an element.
    if(!e.isNull()) {
        cout << qPrintable(e.tagName()) << Qt::endl; // the node really is an element.
    }
    n = n.nextSibling();
}

// Here we append a new element to the end of the document
QDomElement elem = doc.createElement("img");
elem.setAttribute("src", "myimage.png");
docElem.appendChild(elem);

Once doc and elem go out of scope, the whole internal tree representing the XML document is deleted.

To create a document using DOM use code like this:

QDomDocument doc("MyML");
QDomElement root = doc.createElement("MyML");
doc.appendChild(root);

QDomElement tag = doc.createElement("Greeting");
root.appendChild(tag);

QDomText t = doc.createTextNode("Hello World");
tag.appendChild(t);

QString xml = doc.toString();

For further information about the Document Object Model see the Document Object Model (DOM) Level 1 and Level 2 Core Specifications.

Member Function Documentation

QDomDocument::QDomDocument(const QDomDocument &x)

Constructs a copy of x.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

QDomDocument::QDomDocument(const QDomDocumentType &doctype)

Creates a document with the document type doctype.

QDomDocument::QDomDocument(const QString &name)

Creates a document and sets the name of the document type to name.

QDomDocument::QDomDocument()

Constructs an empty document.

QDomDocument &QDomDocument::operator=(const QDomDocument &x)

Assigns x to this DOM document.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

QDomDocument::~QDomDocument()

Destroys the object and frees its resources.

QDomAttr QDomDocument::createAttribute(const QString &name)

Creates a new attribute called name that can be inserted into an element, e.g. using QDomElement::setAttributeNode().

If name is not a valid XML name, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also createAttributeNS().

QDomAttr QDomDocument::createAttributeNS(const QString &nsURI, const QString &qName)

Creates a new attribute with namespace support that can be inserted into an element. The name of the attribute is qName and the namespace URI is nsURI. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on qName).

If qName is not a valid XML name, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also createAttribute().

QDomCDATASection QDomDocument::createCDATASection(const QString &value)

Creates a new CDATA section for the string value that can be inserted into the document, e.g. using QDomNode::appendChild().

If value contains characters which cannot be stored in a CDATA section, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter().

QDomComment QDomDocument::createComment(const QString &value)

Creates a new comment for the string value that can be inserted into the document, e.g. using QDomNode::appendChild().

If value contains characters which cannot be stored in an XML comment, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter().

QDomDocumentFragment QDomDocument::createDocumentFragment()

Creates a new document fragment, that can be used to hold parts of the document, e.g. when doing complex manipulations of the document tree.

QDomElement QDomDocument::createElement(const QString &tagName)

Creates a new element called tagName that can be inserted into the DOM tree, e.g. using QDomNode::appendChild().

If tagName is not a valid XML name, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

QDomElement QDomDocument::createElementNS(const QString &nsURI, const QString &qName)

Creates a new element with namespace support that can be inserted into the DOM tree. The name of the element is qName and the namespace URI is nsURI. This function also sets QDomNode::prefix() and QDomNode::localName() to appropriate values (depending on qName).

If qName is an empty string, returns a null element regardless of whether the invalid data policy is set.

See also createElement().

QDomEntityReference QDomDocument::createEntityReference(const QString &name)

Creates a new entity reference called name that can be inserted into the document, e.g. using QDomNode::appendChild().

If name is not a valid XML name, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter().

QDomProcessingInstruction QDomDocument::createProcessingInstruction(const QString &target, const QString &data)

Creates a new processing instruction that can be inserted into the document, e.g. using QDomNode::appendChild(). This function sets the target for the processing instruction to target and the data to data.

If target is not a valid XML name, or data if contains characters which cannot appear in a processing instruction, the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter().

QDomText QDomDocument::createTextNode(const QString &value)

Creates a text node for the string value that can be inserted into the document tree, e.g. using QDomNode::appendChild().

If value contains characters which cannot be stored as character data of an XML document (even in the form of character references), the behavior of this function is governed by QDomImplementation::InvalidDataPolicy.

See also QDomNode::appendChild(), QDomNode::insertBefore(), and QDomNode::insertAfter().

QDomDocumentType QDomDocument::doctype() const

Returns the document type of this document.

QDomElement QDomDocument::documentElement() const

Returns the root element of the document.

QDomElement QDomDocument::elementById(const QString &elementId)

Returns the element whose ID is equal to elementId. If no element with the ID was found, this function returns a null element.

Since the QDomClasses do not know which attributes are element IDs, this function returns always a null element. This may change in a future version.

QDomNodeList QDomDocument::elementsByTagName(const QString &tagname) const

Returns a QDomNodeList, that contains all the elements in the document with the name tagname. The order of the node list is the order they are encountered in a preorder traversal of the element tree.

See also elementsByTagNameNS() and QDomElement::elementsByTagName().

QDomNodeList QDomDocument::elementsByTagNameNS(const QString &nsURI, const QString &localName)

Returns a QDomNodeList that contains all the elements in the document with the local name localName and a namespace URI of nsURI. The order of the node list is the order they are encountered in a preorder traversal of the element tree.

See also elementsByTagName() and QDomElement::elementsByTagNameNS().

QDomImplementation QDomDocument::implementation() const

Returns a QDomImplementation object.

QDomNode QDomDocument::importNode(const QDomNode &importedNode, bool deep)

Imports the node importedNode from another document to this document. importedNode remains in the original document; this function creates a copy that can be used within this document.

This function returns the imported node that belongs to this document. The returned node has no parent. It is not possible to import QDomDocument and QDomDocumentType nodes. In those cases this function returns a null node.

If importedNode is a null node, a null node is returned.

If deep is true, this function imports not only the node importedNode but its whole subtree; if it is false, only the importedNode is imported. The argument deep has no effect on QDomAttr and QDomEntityReference nodes, since the descendants of QDomAttr nodes are always imported and those of QDomEntityReference nodes are never imported.

The behavior of this function is slightly different depending on the node types:

Node Type	Behavior
QDomAttr	The owner element is set to 0 and the specified flag is set to true in the generated attribute. The whole subtree of importedNode is always imported for attribute nodes: deep has no effect.
QDomDocument	Document nodes cannot be imported.
QDomDocumentFragment	If deep is true, this function imports the whole document fragment; otherwise it only generates an empty document fragment.
QDomDocumentType	Document type nodes cannot be imported.
QDomElement	Attributes for which QDomAttr::specified() is true are also imported, other attributes are not imported. If deep is true, this function also imports the subtree of importedNode; otherwise it imports only the element node (and some attributes, see above).
QDomEntity	Entity nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2.
QDomEntityReference	Descendants of entity reference nodes are never imported: deep has no effect.
QDomNotation	Notation nodes can be imported, but at the moment there is no way to use them since the document type is read-only in DOM level 2.
QDomProcessingInstruction	The target and value of the processing instruction is copied to the new node.
QDomText	The text is copied to the new node.
QDomCDATASection	The text is copied to the new node.
QDomComment	The text is copied to the new node.

QDomNode::NodeType QDomDocument::nodeType() const

Returns DocumentNode.

bool QDomDocument::setContent(const QByteArray &data, bool namespaceProcessing, QString **errorMsg* = nullptr, int **errorLine* = nullptr, int **errorColumn* = nullptr)

This function parses the XML document from the byte array data and sets it as the content of the document. It tries to detect the encoding of the document as required by the XML specification.

If namespaceProcessing is true, the parser recognizes namespaces in the XML file and sets the prefix name, local name and namespace URI to appropriate values. If namespaceProcessing is false, the parser does no namespace processing when it reads the XML file.

If a parse error occurs, this function returns false and the error message is placed in *errorMsg, the line number in *errorLine and the column number in *errorColumn (unless the associated pointer is set to 0); otherwise this function returns true. The various error messages are described in the QXmlParseException class documentation. Note that, if you want to display these error messages to your application's users, they will be displayed in English unless they are explicitly translated.

If namespaceProcessing is true, the function QDomNode::prefix() returns a string for all elements and attributes. It returns an empty string if the element or attribute has no prefix.

Text nodes consisting only of whitespace are stripped and won't appear in the QDomDocument. If this behavior is not desired, one can use the setContent() overload that allows a QXmlReader to be supplied.

If namespaceProcessing is false, the functions QDomNode::prefix(), QDomNode::localName() and QDomNode::namespaceURI() return an empty string.

Entity references are handled as follows:

References to internal general entities and character entities occurring in the content are included. The result is a QDomText node with the references replaced by their corresponding entity values.
References to parameter entities occurring in the internal subset are included. The result is a QDomDocumentType node which contains entity and notation declarations with the references replaced by their corresponding entity values.
Any general parsed entity reference which is not defined in the internal subset and which occurs in the content is represented as a QDomEntityReference node.
Any parsed entity reference which is not defined in the internal subset and which occurs outside of the content is replaced with an empty string.
Any unparsed entity reference is replaced with an empty string.