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

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

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

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

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

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

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

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

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

QTextDocument *newDocument = new QTextDocument;

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

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

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

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

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

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

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

    QTextDocument *editorDocument = editor->document();
    QTextFrame *root = editorDocument->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 для обхода элементов фрейма:

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

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

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

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

Таблицы

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

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

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

    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(childTable);
            else
                processFrame(childFrame);

        } else if (childBlock.isValid()) {
            processBlock(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);
        }
    }

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