Spec-Zone.ru › Qt 6.0

Класс QTextFrame

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

Заголовок: #include <QTextFrame>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Наследуется от: QTextObject
Наследует:

QTextTable

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

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

Публичные типы

класс итератор
Итератор

Публичные функции

QTextFrame(QTextDocument *document)
виртуальный ~QTextFrame()
QTextFrame::итератор begin() const
QList<QTextFrame *> childFrames() const
QTextFrame::итератор end() const
QTextCursor firstCursorPosition() const
int firstPosition() const
QTextFrameFormat frameFormat() const
QTextCursor lastCursorPosition() const
int lastPosition() const
QTextFrame * parentFrame() const
void setFrameFormat(const QTextFrameFormat &format)

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

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

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

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

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

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

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

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

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

QTextFrame::Итератор

Синоним стиля Qt для QTextFrame::итератор.

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

QTextFrame::QTextFrame(QTextDocument *document)

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

[virtual] QTextFrame::~QTextFrame()

Удаляет фрейм текста.

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

QTextFrame::итератор QTextFrame::begin() const

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

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

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

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

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

QTextFrame::итератор 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().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.0/qtextframe.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API