Класс QXmlFormatter

Класс QXmlFormatter является реализацией класса QXmlSerializer для преобразования выходных данных XQuery в форматированный XML. Подробнее...

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

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

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

Переопределённые открытые функции

• 15 открытых функций, унаследованных от QXmlSerializer

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

Класс QXmlFormatter является реализацией класса QXmlSerializer для преобразования выходных данных XQuery в форматированный XML.

QXmlFormatter является подклассом QXmlSerializer, который форматирует выходной XML, чтобы его было проще читать человеку.

QXmlSerializer выводит XML без добавления ненужных пробелов. В частности, он не добавляет новые строки и отступы. Для того, чтобы выходной XML был легче читать, QXmlFormatter добавляет новые строки и отступы, добавляя, удаляя и изменяя узлы последовательности, которые состоят только из пробелов. Он также изменяет пробелы в других местах, где они не важны; например, между атрибутами и в прологе документа.

Например, где базовый класс QXmlSerializer выведет это:

<a><b/><c/><p>Some Text</p></a>

QXmlFormatter выведет это:

<a>
   <b/>
   <c/>
   <p>Some Text</p>
</a>

Если вам нужно просто сериализовать свой XML в удобочитаемом формате, используйте QXmlFormatter как есть. Уровень отступа по умолчанию составляет 4 пробела, но вы можете установить своё значение отступа с помощью setIndentationDepth().

Новые строки и отступы, добавленные QXmlFormatter, подходят для общих форматов, таких как XHTML, SVG или Docbook, где пробелы не имеют значения. Однако, если ваш XML будет использоваться в качестве входных данных, где пробелы имеют значение, вам необходимо написать свой собственный подкласс QXmlSerializer или QAbstractXmlReceiver.

Обратите внимание, что использование QXmlFormatter вместо QXmlSerializer увеличит вычислительную нагрузку и размер документа из-за вставки пробелов.

Также обратите внимание, что стиль отступов, используемый QXmlFormatter, остаётся слабо определённым и может измениться в будущих версиях Qt. Если требуется определённый стиль отступов, то либо используйте базовый класс QXmlSerializer непосредственно, либо напишите свой собственный подкласс QXmlSerializer или QAbstractXmlReceiver. В качестве альтернативы, вы можете создать подкласс QXmlFormatter и переопределить обратные вызовы в нём.

QXmlQuery query;
query.setQuery("doc('index.html')/html/body/p[1]");

QXmlFormatter formatter(query, myOutputDevice);
formatter.setIndentationDepth(2);
query.evaluateTo(&formatter);

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

QXmlFormatter::QXmlFormatter(const QXmlQuery &query, QIODevice *outputDevice)

Создаёт форматировщик, который использует пул имён и обработчик сообщений в query и записывает результат в outputDevice в виде форматированного XML.

outputDevice передаётся напрямую в конструктор QXmlSerializer.

См. также QXmlSerializer.

[override virtual] void QXmlFormatter::atomicValue(const QVariant &value)

Переопределено из QXmlSerializer::atomicValue().

[override virtual] void QXmlFormatter::attribute(const QXmlName &name, const QStringRef &value)

Переопределено из QXmlSerializer::attribute().

[override virtual] void QXmlFormatter::characters(const QStringRef &value)

Переопределено из QXmlSerializer::characters().

[override virtual] void QXmlFormatter::comment(const QString &value)

Переопределено из QXmlSerializer::comment().

[override virtual] void QXmlFormatter::endDocument()

Переопределено из QXmlSerializer::endDocument().

[override virtual] void QXmlFormatter::endElement()

Переопределено из QXmlSerializer::endElement().

[override virtual] void QXmlFormatter::endOfSequence()

Переопределено из QXmlSerializer::endOfSequence().

int QXmlFormatter::indentationDepth() const

Возвращает количество пробелов, которые QXmlFormatter выведет для каждого уровня отступа. По умолчанию четыре.

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

[override virtual] void QXmlFormatter::processingInstruction(const QXmlName &name, const QString &value)

Переопределено из QXmlSerializer::processingInstruction().

void QXmlFormatter::setIndentationDepth(int depth)

Устанавливает depth в качестве количества пробелов, которое QXmlFormatter выведет для уровня отступа. По умолчанию четыре.

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

[override virtual] void QXmlFormatter::startDocument()

Переопределено из QXmlSerializer::startDocument().

[override virtual] void QXmlFormatter::startElement(const QXmlName &name)

Переопределено из QXmlSerializer::startElement().

[override virtual] void QXmlFormatter::startOfSequence()

Переопределено из QXmlSerializer::startOfSequence().