Класс QDomDocument

Класс QDomDocument представляет собой XML-документ. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Примечание: Все функции в этом классе являются перевходными.

Открытые функции

Подробное описание

Класс QDomDocument представляет весь XML-документ. По сути, он является корнем дерева документа и предоставляет основной доступ к данным документа.

Поскольку элементы, текстовые узлы, комментарии, инструкции обработки и т.д. не могут существовать вне контекста документа, класс документа также содержит фабричные функции, необходимые для создания этих объектов. У созданных объектов узлов есть функция ownerDocument(), которая связывает их с документом, в контексте которого они были созданы. Классы DOM, которые чаще всего будут использоваться, это QDomNode, QDomDocument, QDomElement и QDomText.

Разбор XML представлен внутренне деревом объектов, к которым можно получить доступ с помощью различных классов QDom. Все классы QDom только ссылаются на объекты во внутреннем дереве. Внутренние объекты в дереве DOM будут удалены, как только будет удален последний объект QDom, ссылающийся на них, или сам QDomDocument.

Создание элементов, текстовых узлов и т.д. выполняется с помощью различных фабричных функций, предоставляемых в этом классе. Использование конструкторов по умолчанию классов QDom приведет только к пустым объектам, которые нельзя использовать или вставлять в документ.

Класс QDomDocument имеет несколько функций для создания данных документа, например, createElement(), createTextNode(), createComment(), createCDATASection(), createProcessingInstruction(), createAttribute() и createEntityReference(). Некоторые из этих функций имеют версии, поддерживающие пространства имен, т.е. createElementNS() и createAttributeNS(). Функция createDocumentFragment() используется для хранения частей документа; это полезно для манипулирования сложными документами.

Весь контент документа устанавливается с помощью setContent(). Эта функция анализирует переданную строку как XML-документ и создает дерево DOM, представляющее документ. Корневой элемент доступен с помощью documentElement(). Текстовое представление документа можно получить с помощью toString().

Примечание: Дерево DOM может занимать много памяти, если XML-документ большой. Для таких документов классы QXmlStreamReader или QXmlQuery могут быть лучшими решениями.

Возможна вставка узла из другого документа в документ с помощью importNode().

Вы можете получить список всех элементов с определенным тегом с помощью elementsByTagName() или elementsByTagNameNS().

Классы QDom обычно используются следующим образом:

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

После того, как doc и elem выйдут из области видимости, всё внутреннее дерево, представляющее XML-документ, будет удалено.

Для создания документа с помощью DOM используйте код, подобный этому:

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

Дополнительную информацию об объектной модели документа см. в спецификациях Уровня 1 и Ядра уровня 2 объектной модели документа (DOM).

См. также Пример закладок DOM и Пример простой модели DOM.

Документация функций-членов

QDomDocument::QDomDocument(const QDomDocument &x)

Создаёт копию x.

Данные копии разделяются (поверхностная копия): изменение одного узла также изменит другой. Если требуется глубокая копия, используйте cloneNode().

QDomDocument::QDomDocument(const QDomDocumentType &doctype)

Создаёт документ с типом документа doctype.

См. также QDomImplementation::createDocumentType().

QDomDocument::QDomDocument(const QString &name)

Создаёт документ и задаёт имя типа документа name.

QDomDocument::QDomDocument()

Создаёт пустой документ.

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

Присваивает x данному документу DOM.

Данные копии разделяются (поверхностная копия): изменение одного узла также изменит другой. Если требуется глубокая копия, используйте cloneNode().

QDomDocument::~QDomDocument()

Уничтожает объект и освобождает его ресурсы.

QDomAttr QDomDocument::createAttribute(const QString &name)

Создаёт новый атрибут с именем name, который можно вставить в элемент, например, с помощью QDomElement::setAttributeNode().

Если name не является допустимым именем XML, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также createAttributeNS().

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

Создаёт новый атрибут с поддержкой пространства имён, который можно вставить в элемент. Имя атрибута — qName, а URI пространства имён — nsURI. Эта функция также устанавливает QDomNode::prefix() и QDomNode::localName() в соответствующие значения (в зависимости от qName).

Если qName не является допустимым именем XML, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также createAttribute().

QDomCDATASection QDomDocument::createCDATASection(const QString &value)

Создаёт новый фрагмент CDATA для строки value, который можно вставить в документ, например, с помощью QDomNode::appendChild().

Если value содержит символы, которые нельзя сохранить во фрагменте CDATA, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

QDomComment QDomDocument::createComment(const QString &value)

Создаёт новый комментарий для строки value, который можно вставить в документ, например, с помощью QDomNode::appendChild().

Если value содержит символы, которые нельзя сохранить в XML-комментарии, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

QDomDocumentFragment QDomDocument::createDocumentFragment()

Создаёт новый фрагмент документа, который можно использовать для хранения частей документа, например, при выполнении сложных манипуляций с древовидной структурой документа.

QDomElement QDomDocument::createElement(const QString &tagName)

Создаёт новый элемент с именем tagName, который можно вставить в дерево DOM, например, с помощью QDomNode::appendChild().

Если tagName не является допустимым именем XML, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также createElementNS(), QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

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

Создаёт новый элемент с поддержкой пространства имён, который можно вставить в дерево DOM. Имя элемента — qName, а URI пространства имён — nsURI. Эта функция также устанавливает QDomNode::prefix() и QDomNode::localName() в соответствующие значения (в зависимости от qName).

Если qName пустая строка, возвращает нулевой элемент независимо от того, установлен ли параметр политики некорректных данных.

См. также createElement().

QDomEntityReference QDomDocument::createEntityReference(const QString &name)

Создаёт новую ссылку на сущность с именем name, которую можно вставить в документ, например, с помощью QDomNode::appendChild().

Если name не является допустимым именем XML, поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

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

Создаёт новую инструкцию обработки, которую можно вставить в документ, например, с помощью QDomNode::appendChild(). Эта функция устанавливает целевой параметр для инструкции обработки в target и данные в data.

Если target не является допустимым именем XML или если data содержит символы, которые не могут появляться в инструкции обработки, поведение функции регулируется QDomImplementation::InvalidDataPolicy.

См. также QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

QDomText QDomDocument::createTextNode(const QString &value)

Создаёт узел текста для строки value, который можно вставить в дерево документа, например, с помощью QDomNode::appendChild().

Если value содержит символы, которые не могут быть сохранены в качестве текстовых данных XML-документа (даже в виде символьных ссылок), поведение этой функции определяется QDomImplementation::InvalidDataPolicy.

См. также QDomNode::appendChild(), QDomNode::insertBefore() и QDomNode::insertAfter().

QDomDocumentType QDomDocument::doctype() const

Возвращает тип документа данного документа.

QDomElement QDomDocument::documentElement() const

Возвращает корневой элемент документа.

QDomElement QDomDocument::elementById(const QString &elementId)

Возвращает элемент, идентификатор которого равен elementId. Если элемент с данным идентификатором не найден, функция возвращает нулевой элемент.

Поскольку классы QDom не знают, какие атрибуты являются идентификаторами элементов, эта функция всегда возвращает нулевой элемент. Это может измениться в будущей версии.

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

Возвращает QDomNodeList, содержащий все элементы в документе с именем tagname. Порядок в списке узлов соответствует порядку, в котором они встречаются при обходе дерева элементов в прямом порядке.

См. также elementsByTagNameNS() и QDomElement::elementsByTagName().

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

Возвращает QDomNodeList, содержащий все элементы в документе с локальным именем localName и URI пространства имён nsURI. Порядок в списке узлов соответствует порядку, в котором они встречаются при обходе дерева элементов в прямом порядке.

См. также elementsByTagName() и QDomElement::elementsByTagNameNS().

QDomImplementation QDomDocument::implementation() const

Возвращает объект QDomImplementation.

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

Импортирует узел importedNode из другого документа в этот документ. importedNode остаётся в исходном документе; эта функция создаёт копию, которую можно использовать в этом документе.

Эта функция возвращает импортированный узел, принадлежащий этому документу. У возвращённого узла нет родителя. Невозможно импортировать узлы QDomDocument и QDomDocumentType. В этих случаях функция возвращает пустой узел.

Если importedNode является пустым узлом, возвращается пустой узел.

Если deep равно true, эта функция импортирует не только узел importedNode, но и всё его поддерево; если false, импортируется только сам importedNode. Аргумент deep не влияет на узлы QDomAttr и QDomEntityReference, так как потомки узлов QDomAttr всегда импортируются, а потомки узлов QDomEntityReference никогда не импортируются.

Поведение этой функции немного отличается в зависимости от типа узла:

См. также QDomElement::setAttribute(), QDomNode::insertBefore(), QDomNode::insertAfter(), QDomNode::replaceChild(), QDomNode::removeChild(), и QDomNode::appendChild().

QDomNode::NodeType QDomDocument::nodeType() const

Возвращает DocumentNode.

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

Эта функция анализирует XML-документ из массива байтов data и устанавливает его как содержимое документа. Она пытается определить кодировку документа в соответствии со спецификацией XML.

Если namespaceProcessing равно true, анализатор распознаёт пространства имён в XML-файле и устанавливает имя префикса, локальное имя и URI пространства имён в соответствующие значения. Если namespaceProcessing равно false, анализатор не обрабатывает пространства имён при чтении XML-файла.

Если возникает ошибка анализа, эта функция возвращает false и сообщение об ошибке размещается в *errorMsg, номер строки — в *errorLine, а номер столбца — в *errorColumn (если соответствующий указатель не равен 0); в противном случае функция возвращает true. Различные сообщения об ошибках описаны в документации класса QXmlParseException. Обратите внимание, что если вы хотите отобразить эти сообщения об ошибках пользователям вашего приложения, они будут отображаться на английском языке, если не будут явно переведены.

Если namespaceProcessing равно true, функция QDomNode::prefix() возвращает строку для всех элементов и атрибутов. Она возвращает пустую строку, если у элемента или атрибута нет префикса.

Узлы текста, состоящие только из пробелов, удаляются и не появятся в QDomDocument. Если это поведение нежелательно, можно использовать перегрузку setContent(), которая позволяет передать QXmlReader.

Если namespaceProcessing равно false, функции QDomNode::prefix(), QDomNode::localName() и QDomNode::namespaceURI() возвращают пустую строку.

Обработка ссылок на сущности выполняется следующим образом:

• Ссылки на внутренние общие сущности и символьные сущности, встречающиеся в содержимом, включаются. Результатом является узел QDomText со ссылками, заменёнными соответствующими значениями сущностей.
• Ссылки на параметрические сущности, встречающиеся во внутренней подсистеме, включаются. Результатом является узел QDomDocumentType, который содержит объявления сущностей и обозначений со ссылками, заменёнными соответствующими значениями сущностей.
• Любая общая ссылка на парсируемую сущность, не определённая во внутренней подсистеме и встречающаяся в содержимом, представляется узлом QDomEntityReference.
• Любая парсируемая ссылка на сущность, которая не определена во внутренней подсистеме и встречается за пределами содержимого, заменяется пустой строкой.
• Любая необработанная ссылка на сущность заменяется пустой строкой.

См. также QDomNode::namespaceURI(), QDomNode::localName(), QDomNode::prefix(), QString::isNull(), и QString::isEmpty().

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

Это перегруженная функция.

Эта функция считывает XML-документ из строки text, возвращая true, если содержимое было успешно проанализировано; в противном случае возвращает false. Так как text уже является строкой Юникода, никакого распознавания кодировки не выполняется.

bool QDomDocument::setContent(QIODevice *dev, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)

Это перегруженная функция.

Эта функция считывает XML-документ из устройства ввода/вывода dev, возвращая true, если содержимое было успешно проанализировано; в противном случае возвращает false.

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

Это перегруженная функция.

Эта функция считывает XML-документ из массива байтов buffer, возвращая true, если содержимое было успешно проанализировано; в противном случае возвращает false.

Обработка пространств имен не выполняется.

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

Это перегруженный метод.

Данный метод считывает XML-документ из строки text, возвращая true, если содержимое успешно обработано; в противном случае возвращает false. Поскольку text уже является строкой Юникода, обнаружение кодировки не выполняется.

Обработка пространств имен также не выполняется.

bool QDomDocument::setContent(QXmlStreamReader *reader, bool namespaceProcessing, QString *errorMsg = nullptr, int *errorLine = nullptr, int *errorColumn = nullptr)

Это перегруженный метод.

Этот метод считывает XML-документ из QXmlStreamReader reader и анализирует его. Возвращает true, если содержимое было успешно обработано; в противном случае возвращает false.

Если namespaceProcessing равно true, анализатор распознает пространства имен в XML-файле и устанавливает имя префикса, локальное имя и URI пространства имен в соответствующие значения. Если namespaceProcessing равно false, анализатор не выполняет обработку пространств имен при чтении XML-файла.

Если произошла ошибка разбора, сообщение об ошибке помещается в *errorMsg, номер строки в *errorLine, а номер столбца в *errorColumn (если соответствующий указатель не равен 0).

Этот метод был представлен в Qt 5.15.

См. также QXmlStreamReader.

QByteArray QDomDocument::toByteArray(int indent = 1) const

Преобразует обработанный документ обратно в текстовое представление и возвращает QByteArray, содержащий данные, закодированные в UTF-8.

Этот метод использует indent в качестве отступа для вложенных элементов.

См. также toString().

QString QDomDocument::toString(int indent = 1) const

Преобразует обработанный документ обратно в текстовое представление.

Этот метод использует indent в качестве отступа для вложенных элементов.

Если indent равно -1, пробелы не добавляются.