Класс QXmlFormatter

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

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

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

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

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

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

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

Класс 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.

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

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

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

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

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

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

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

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

[virtual] void QXmlFormatter::endDocument()

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

[virtual] void QXmlFormatter::endElement()

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

[virtual] void QXmlFormatter::endOfSequence()

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

int QXmlFormatter::indentationDepth() const

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

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

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

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

void QXmlFormatter::setIndentationDepth(int depth)

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

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

[virtual] void QXmlFormatter::startDocument()

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

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

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

[virtual] void QXmlFormatter::startOfSequence()

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