Note

This class or function is not reentrant .

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.

See also

QDomNode::namespaceURI() QDomNode::localName() QDomNode::prefix() QString::isNull() QString::isEmpty()

Definition at line 6887 of file qdom.cpp .

Referenced by QDBusXmlParser::QDBusXmlParser() , and setContent() .

6888 {
6889 if (! impl )
6890 impl = new QDomDocumentPrivate ();
6891 QBuffer buf;
6892 buf. setData (data);
6893 QXmlInputSource source(&buf);
6894 return IMPL ->setContent(&source, namespaceProcessing, errorMsg, errorLine, errorColumn);
6895 }
QBuffer::setData
void setData(const QByteArray &data)
Sets the contents of the internal buffer to be data.
Definition: qbuffer.cpp:315
QBuffer
The QBuffer class provides a QIODevice interface for a QByteArray.
Definition: qbuffer.h:57
QDomNode::impl
QDomNodePrivate * impl
Definition: qdom.h:243
IMPL
#define IMPL
Definition: qdom.cpp:6666
QXmlInputSource
The QXmlInputSource class provides the input data for the QXmlReader subclasses.
Definition: qxml.h:158
QDomDocumentPrivate
Definition: qdom.cpp:504
This function reads the XML document from the string text , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Since text is already a Unicode string, no encoding detection is done.
Definition at line 6823 of file qdom.cpp .
6824 {
6825 if (! impl )
6826 impl = new QDomDocumentPrivate ();
6827 QXmlInputSource source;
6828 source. setData (text);
6829 return IMPL ->setContent(&source, namespaceProcessing, errorMsg, errorLine, errorColumn);
6830 }
QXmlInputSource::setData
virtual void setData(const QString &dat)
Sets the data of the input source to dat.
Definition: qxml.cpp:1509
QDomNode::impl
QDomNodePrivate * impl
Definition: qdom.h:243
IMPL
#define IMPL
Definition: qdom.cpp:6666
QXmlInputSource
The QXmlInputSource class provides the input data for the QXmlReader subclasses.
Definition: qxml.h:158
QDomDocumentPrivate
Definition: qdom.cpp:504
This function reads the XML document from the IO device dev , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 6906 of file qdom.cpp .
6907 {
6908 if (! impl )
6909 impl = new QDomDocumentPrivate ();
6910 QXmlInputSource source(dev);
6911 return IMPL ->setContent(&source, namespaceProcessing, errorMsg, errorLine, errorColumn);
6912 }
QDomNode::impl
QDomNodePrivate * impl
Definition: qdom.h:243
IMPL
#define IMPL
Definition: qdom.cpp:6666
QXmlInputSource
The QXmlInputSource class provides the input data for the QXmlReader subclasses.
Definition: qxml.h:158
QDomDocumentPrivate
Definition: qdom.cpp:504
This function reads the XML document from the QXmlInputSource source , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Since
4.5
Definition at line 6925 of file qdom.cpp .
6926 {
6927 if (! impl )
6928 impl = new QDomDocumentPrivate ();
6929 QXmlSimpleReader reader;
6930 initializeReader (reader, namespaceProcessing);
6931 return IMPL ->setContent(source, &reader, errorMsg, errorLine, errorColumn);
6932 }
QXmlSimpleReader
The QXmlSimpleReader class provides an implementation of a simple XML parser.
Definition: qxml.h:241
QDomNode::impl
QDomNodePrivate * impl
Definition: qdom.h:243
IMPL
#define IMPL
Definition: qdom.cpp:6666
initializeReader
static void initializeReader(QXmlSimpleReader &reader, bool namespaceProcessing)
Definition: qdom.cpp:6360
QDomDocumentPrivate
Definition: qdom.cpp:504
This function reads the XML document from the byte array buffer , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
No namespace processing is performed.
Definition at line 6964 of file qdom.cpp .
6965 {
6966 return setContent (buffer, false , errorMsg, errorLine, errorColumn);
6967 }
QDomDocument::setContent
bool setContent(const QByteArray &text, bool namespaceProcessing, QString *errorMsg=0, int *errorLine=0, int *errorColumn=0)
Definition: qdom.cpp:6887
This function reads the XML document from the string text , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Since text is already a Unicode string, no encoding detection is performed.
No namespace processing is performed either.
Definition at line 6947 of file qdom.cpp .
6948 {
6949 return setContent (text, false , errorMsg, errorLine, errorColumn);
6950 }
QDomDocument::setContent
bool setContent(const QByteArray &text, bool namespaceProcessing, QString *errorMsg=0, int *errorLine=0, int *errorColumn=0)
Definition: qdom.cpp:6887
This function reads the XML document from the IO device dev , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
No namespace processing is performed.
Definition at line 6980 of file qdom.cpp .
6981 {
6982 return setContent (dev, false , errorMsg, errorLine, errorColumn);
6983 }
QDomDocument::setContent
bool setContent(const QByteArray &text, bool namespaceProcessing, QString *errorMsg=0, int *errorLine=0, int *errorColumn=0)
Definition: qdom.cpp:6887
This function reads the XML document from the QXmlInputSource source and parses it with the QXmlReader reader , returning true if the content was successfully parsed; otherwise returns false.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This function doesn't change the features of the reader . If you want to use certain features for parsing you can use this function to set up the reader appropriately.
See also
QXmlSimpleReader
Definition at line 7001 of file qdom.cpp .
7002 {
7003 if (! impl )
7004 impl = new QDomDocumentPrivate ();
7005 return IMPL ->setContent(source, reader, errorMsg, errorLine, errorColumn);
7006 }
QDomNode::impl
QDomNodePrivate * impl
Definition: qdom.h:243
IMPL
#define IMPL
Definition: qdom.cpp:6666
QDomDocumentPrivate
Definition: qdom.cpp:504
Converts the parsed document back to its textual representation and returns a QByteArray containing the data encoded as UTF-8.
This function uses indent as the amount of space to indent subelements.
See also
toString()
Definition at line 7033 of file qdom.cpp .
7034 {
7035 // ### if there is an encoding specified in the xml declaration, this
7036 // encoding declaration should be changed to utf8
7037 return toString (indent). toUtf8 ();
7038 }
QString::toUtf8
QByteArray toUtf8() const Q_REQUIRED_RESULT
Returns a UTF-8 representation of the string as a QByteArray.
Definition: qstring.cpp:4074
QDomDocument::toString
QString toString(int=1) const
Converts the parsed document back to its textual representation.
Definition: qdom.cpp:7016
Converts the parsed document back to its textual representation.
This function uses indent as the amount of space to indent subelements.
If indent is -1, no whitespace at all is added.
Definition at line 7016 of file qdom.cpp .
Referenced by toByteArray() .
7017 {
7018 QString str;
7019 QTextStream s(&str, QIODevice::WriteOnly );
7020 save (s, indent);
7021 return str;
7022 }
QString
The QString class provides a Unicode character string.
Definition: qstring.h:83
QIODevice::WriteOnly
Definition: qiodevice.h:78
QTextStream
The QTextStream class provides a convenient interface for reading and writing text.
Definition: qtextstream.h:73
QDomNode::save
void save(QTextStream &, int) const
Writes the XML representation of the node and all its children to the stream str. ...
Definition: qdom.cpp:2728
Friends and Related Functions
◆ QDomNode
---
The documentation for this class was generated from the following files:
• /src/xml/dom/ qdom.h
• /src/xml/dom/ qdom.cpp