Структура документа с форматированным текстом

Текстовые документы представлены классом QTextDocument, который содержит информацию о внутренней структуре документа, его структуре и отслеживает изменения для обеспечения возможностей отмены/повторной операции.

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

Новые элементы создаются и вставляются в документ программно с помощью QTextCursor или с помощью виджета редактора, такого как QTextEdit. Элементам можно присваивать определенный формат при их создании; в противном случае они принимают текущий формат курсора для элемента.

Основная структура «Верхний уровень» документа может быть заполнен так, как показано. Каждый документ всегда содержит корневой фрейм, и он всегда содержит по крайней мере один текстовый блок. Для документов с текстовым содержимым корневой фрейм обычно содержит последовательность блоков и других элементов. Последовательности фреймов и таблиц всегда разделяются текстовыми блоками в документе, даже если текстовые блоки не содержат информации. Это гарантирует, что новые элементы всегда можно вставлять между существующими структурами.

В этой главе мы рассмотрим каждый из структурных элементов, используемых в документе с форматированным текстом, определим их особенности и области применения, а также покажем, как просмотреть их содержимое. Редактирование документов описано в разделе Интерфейс QTextCursor.

Документы с форматированным текстом

Объекты QTextDocument содержат всю информацию, необходимую для создания документов с форматированным текстом. К текстовым документам можно получить доступ двумя взаимодополняющими способами: как линейный буфер для использования редакторами и как иерархия объектов, полезная для движков макета. В иерархической модели документа объекты обычно соответствуют визуальным элементам, таким как фреймы, таблицы и списки. На более низком уровне эти элементы описывают свойства, такие как стиль текста и выравнивание. Линейное представление документа используется для редактирования и манипулирования содержимым документа.

Хотя QTextEdit упрощает отображение и редактирование форматированного текста, документы также могут использоваться независимо от любого виджета редактора, например:

QTextDocument *newDocument = new QTextDocument;

Или они могут быть извлечены из существующего редактора:

QTextEdit *editor = new QTextEdit;
QTextDocument *editorDocument = editor->document();

Эта гибкость позволяет приложениям обрабатывать несколько документов с форматированным текстом без накладных расходов на множество виджетов редакторов или необходимости хранения документов в каком-либо промежуточном формате.

Пустой документ содержит корневой фрейм, который сам содержит один пустой текстовый блок. Фреймы обеспечивают логическое разделение частей документа, но также имеют свойства, определяющие, как они будут отображаться при рендеринге. Таблица — это специализированный тип фрейма, состоящий из ряда ячеек, расположенных в строках и столбцах, каждая из которых может содержать дальнейшую структуру и текст. Таблицы обеспечивают возможности управления и макета, позволяющие создавать гибкие конфигурации ячеек.

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

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

Мы получаем корневой фрейм следующим образом:

    QTextDocument *textDocument;
    QTextFrame *root = textDocument->rootFrame();

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

Элементы документа

Документы с форматированным текстом обычно состоят из таких общих элементов, как абзацы, фреймы, таблицы и списки. В QTextDocument они представлены классами QTextBlock, QTextFrame, QTextTable и QTextList. В отличие от других элементов документа, изображения представлены специально отформатированными фрагментами текста. Это позволяет размещать их в формате, встроенном в окружающий текст.

Основные структурные строительные блоки в документах — QTextBlock и QTextFrame. Сами блоки содержат фрагменты форматированного текста (QTextFragment), но они напрямую не влияют на общую структуру документа.

Элементы, которые могут группировать другие элементы документа, обычно являются подклассами QTextObject и делятся на две категории: элементы, которые группируют текстовые блоки, являются подклассами QTextBlockGroup, а элементы, которые группируют фреймы и другие элементы, являются подклассами QTextFrame.

Текстовые блоки

Текстовые блоки предоставляются классом QTextBlock.

Текстовые блоки объединяют фрагменты текста с различными форматами символов и используются для представления абзацев в документе. Каждый блок обычно содержит ряд фрагментов текста с различными стилями. Фрагменты создаются при вставке текста в документ, и больше фрагментов добавляется при редактировании документа. Документ разбивает, объединяет и удаляет фрагменты для эффективного представления различных стилей текста в блоке.

Фрагменты в данном блоке можно просмотреть, используя итератор QTextBlock::iterator для обхода внутренней структуры блока:

    QTextBlock::iterator it;
    for (it = currentBlock.begin(); !(it.atEnd()); ++it) {
        QTextFragment currentFragment = it.fragment();
        if (currentFragment.isValid())
            processFragment(currentFragment);
    }

Блоки также используются для представления элементов списка. В результате блоки могут определять свои собственные форматы символов, которые содержат информацию о декорациях на уровне блока, такие как тип маркеров, используемых для элементов списка. Форматирование самого блока описывается классом QTextBlockFormat и описывает такие свойства, как выравнивание текста, отступы и цвет фона.

Хотя данный документ может содержать сложные структуры, после получения ссылки на действительный блок в документе мы можем перемещаться между каждым текстовым блоком в порядке их записи:

    QTextBlock currentBlock = textDocument->begin();

    while (currentBlock.isValid()) {
        processBlock(currentBlock);
        currentBlock = currentBlock.next();
    }

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

QTextBlock предоставляет операторы сравнения, которые облегчают манипуляции с блоками: operator==() и operator!=() используются для проверки, являются ли два блока одинаковыми, а operator<() используется для определения того, какой из них встречается первым в документе.

Фреймы

Фреймы предоставляются классом QTextFrame.

Текстовые фреймы группируют блоки текста и дочерние фреймы, создавая структуры документа, которые больше, чем абзацы. Формат фрейма определяет, как он отображается и позиционируется на странице. Фреймы либо вставляются в текстовый поток, либо плавают слева или справа от страницы. Каждый документ содержит корневой фрейм, который содержит все другие элементы документа. В результате все фреймы, кроме корневого фрейма, имеют родительский фрейм.

Поскольку текстовые блоки используются для разделения других элементов документа, каждый фрейм всегда будет содержать по крайней мере один текстовый блок и ноль или более дочерних фреймов. Мы можем просмотреть содержимое фрейма, используя итератор QTextFrame::iterator для обхода дочерних элементов фрейма:

    QDomElement frameElement = ...

    QTextFrame::iterator it;
    for (it = frame->begin(); !(it.atEnd()); ++it) {

        QTextFrame *childFrame = it.currentFrame();
        QTextBlock childBlock = it.currentBlock();

        if (childFrame)
            processFrame(frameElement, childFrame);
        else if (childBlock.isValid())
            processBlock(frameElement, childBlock);
    }

Обратите внимание, что итератор выбирает и фреймы, и блоки, поэтому необходимо проверить, к чему он относится. Это позволяет нам перемещаться по структуре документа по фреймам, но при необходимости по-прежнему получать доступ к текстовым блокам. Классы QTextBlock::iterator и QTextFrame::iterator могут использоваться взаимодополняющим образом для извлечения необходимой структуры из документа.

Таблицы

Таблицы предоставляются классом QTextTable.

Таблицы представляют собой коллекции ячеек, расположенных в строках и столбцах. Каждая ячейка таблицы — это элемент документа со своим собственным форматом символов, но она также может содержать другие элементы, такие как фреймы и текстовые блоки. Ячейки таблицы автоматически создаются при построении таблицы или при добавлении дополнительных строк или столбцов. Их также можно перемещать между таблицами.

QTextTable является подклассом QTextFrame, поэтому таблицы рассматриваются как фреймы в структуре документа. Для каждого фрейма, который мы встречаем в документе, мы можем проверить, представляет ли он собой таблицу, и обработать его по-разному:

    QDomElement frameElement = ...

    QTextFrame::iterator it;
    for (it = frame->begin(); !(it.atEnd()); ++it) {

        QTextFrame *childFrame = it.currentFrame();
        QTextBlock childBlock = it.currentBlock();

        if (childFrame) {
            QTextTable *childTable = qobject_cast<QTextTable*>(childFrame);

            if (childTable)
                processTable(frameElement, childTable);
            else
                processFrame(frameElement, childFrame);

        } else if (childBlock.isValid())
            processBlock(frameElement, childBlock);
    }

Ячейки в существующей таблице можно просмотреть, перебирая строки и столбцы.

    for (int row = 0; row < table->rows(); ++row) {
        for (int column = 0; column < table->columns(); ++column) {
            QTextTableCell tableCell = table->cellAt(row, column);
            processTableCell(tableCell);
        }
    }

Списки

Списки предоставляются классом QTextList.

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

Мы можем обратиться к каждому элементу списка по его индексу в списке:

    for (int index = 0; index < list->count(); ++index) {
        QTextBlock listItem = list->item(index);
        processListItem(listItem);
    }

Поскольку QTextList является подклассом QTextBlockGroup, он не группирует элементы списка как дочерние элементы, а вместо этого предоставляет различные функции для их управления. Это означает, что любой текстовый блок, который мы найдем при обходе документа, может фактически являться элементом списка. Мы можем гарантировать, что элементы списка правильно идентифицируются, используя следующий код:

    QTextFrame::iterator it;
    for (it = frame->begin(); !(it.atEnd()); ++it) {

        QTextBlock block = it.currentBlock();

        if (block.isValid()) {

            QTextList *list = block.textList();

            if (list) {
                int index = list->itemNumber(block);
                processListItem(list, index);
            }
        }
    }

Изображения

Изображения в QTextDocument представлены фрагментами текста, которые ссылаются на внешние изображения через механизм ресурсов. Изображения создаются с помощью интерфейса курсора и могут быть изменены позже путем изменения формата символов фрагмента текста изображения:

    if (fragment.isValid()) {
        QTextImageFormat newImageFormat = fragment.charFormat().toImageFormat();

        if (newImageFormat.isValid()) {
            newImageFormat.setName(":/images/newimage.png");
            QTextCursor helper = cursor;

            helper.setPosition(fragment.position());
            helper.setPosition(fragment.position() + fragment.length(),
                                QTextCursor::KeepAnchor);
            helper.setCharFormat(newImageFormat);
        }
    }

Фрагмент, представляющий изображение, можно найти, перебирая фрагменты в текстовом блоке, который содержит изображение.