Класс QTextFrame

Класс QTextFrame представляет собой фрейм в QTextDocument. Подробнее...

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

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

Типы публичного доступа

Функции публичного доступа

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

Фреймы текста обеспечивают структуру для текста в документе. Они используются в качестве универсальных контейнеров для других элементов документа. Фреймы обычно создаются с помощью QTextCursor::insertFrame().

Фреймы могут использоваться для создания иерархических структур в богатых текстовых документах. Каждый документ имеет корневой фрейм (QTextDocument::rootFrame()), и каждый фрейм под корневым фреймом имеет родительский фрейм и (возможно, пустой) список дочерних фреймов. Родительский фрейм можно найти с помощью parentFrame(), а функция childFrames() предоставляет список дочерних фреймов.

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

Фрейм также имеет формат (указанный с помощью QTextFrameFormat), который можно установить с помощью setFormat() и прочитать с помощью format().

Можно получить текстовые курсоры, указывающие на первую и последнюю допустимые позиции курсора внутри фрейма; для этого используются функции firstCursorPosition() и lastCursorPosition(). Область фрейма в документе можно найти с помощью firstPosition() и lastPosition().

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

См. также QTextCursor и QTextDocument.

Документация по типам членов

typedef QTextFrame::Iterator

Синоним Qt-стиля для QTextFrame::iterator.

Документация по функциям членов

QTextFrame::QTextFrame(QTextDocument *document)

Создаёт новый пустой фрейм для текстового документа document.

[virtual] QTextFrame::~QTextFrame()

Уничтожает фрейм текста.

Предупреждение: Фреймы текста принадлежат документу, поэтому вы никогда не должны уничтожать их самостоятельно. Для удаления фрейма из документа удалите его содержимое, используя QTextCursor.

QTextFrame::iterator QTextFrame::begin() const

Возвращает итератор, указывающий на первый элемент документа внутри фрейма. Подробнее см. документ STL-style-Iterators.

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

QList<QTextFrame *> QTextFrame::childFrames() const

Возвращает (возможно, пустой) список дочерних фреймов фрейма.

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

QTextFrame::iterator QTextFrame::end() const

Возвращает итератор, указывающий на позицию после последнего элемента документа внутри фрейма. Подробнее см. документ STL-Style Iterators.

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

QTextCursor QTextFrame::firstCursorPosition() const

Возвращает первую позицию курсора внутри фрейма.

См. также lastCursorPosition(), firstPosition() и lastPosition().

int QTextFrame::firstPosition() const

Возвращает первую позицию документа внутри фрейма.

См. также lastPosition(), firstCursorPosition() и lastCursorPosition().

QTextFrameFormat QTextFrame::frameFormat() const

Возвращает формат фрейма.

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

QTextCursor QTextFrame::lastCursorPosition() const

Возвращает последнюю позицию курсора внутри фрейма.

См. также firstCursorPosition(), firstPosition() и lastPosition().

int QTextFrame::lastPosition() const

Возвращает последнюю позицию документа внутри фрейма.

См. также firstPosition(), firstCursorPosition() и lastCursorPosition().

QTextFrame *QTextFrame::parentFrame() const

Возвращает родительский фрейм фрейма. Если фрейм является корневым фреймом документа, возвращает 0.

См. также childFrames() и QTextDocument::rootFrame().

void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

Устанавливает формат фрейма format.

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