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

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

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