Структура документа Rich Text

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

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

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

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

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

Документы Rich Text

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

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

QTextDocument *newDocument = new QTextDocument;

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

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

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

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

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

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

Получить корневой фрейм можно следующим образом:

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

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

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

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

Основными структурными блоками в документах являются QTextBlock и QTextFrame. Блоки сами содержат фрагменты Rich Text (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();
    }

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

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

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