Класс QTextLayout

Класс QTextLayout используется для вывода и отрисовки текста. Подробнее...

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

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

Открытые типы

Открытые функции

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

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

Класс имеет довольно низкоуровневый API, и если вы не собираетесь реализовывать собственную отрисовку текста для какого-то специализированного виджета, вам, вероятно, не нужно его использовать напрямую.

QTextLayout можно использовать с обычным и форматированным текстом.

QTextLayout можно использовать для создания последовательности объектов QTextLine с заданными ширинами и размещать их независимо на экране. После завершения компоновки эти строки можно отобразить на устройстве рисования.

Текст для компоновки можно предоставить в конструкторе или установить с помощью setText().

Компоновка может рассматриваться как последовательность объектов QTextLine; используйте createLine() для создания экземпляра QTextLine и lineAt() или lineForTextPosition() для получения созданных строк.

Вот фрагмент кода, демонстрирующий этап компоновки:

int leading = fontMetrics.leading();
qreal height = 0;
textLayout.setCacheEnabled(true);
textLayout.beginLayout();
while (1) {
    QTextLine line = textLayout.createLine();
    if (!line.isValid())
        break;

    line.setLineWidth(lineWidth);
    height += leading;
    line.setPosition(QPointF(0, height));
    height += line.height();
}
textLayout.endLayout();

Затем текст можно отобразить, вызвав функцию draw() компоновки:

QPainter painter(this);
textLayout.draw(&painter, QPoint(0, 0));

Для заданной позиции в тексте можно найти допустимую позицию курсора с помощью isValidCursorPosition(), nextCursorPosition() и previousCursorPosition().

Сам QTextLayout можно позиционировать с помощью setPosition; у него есть boundingRect, а также minimumWidth() и maximumWidth().

См. также QStaticText.

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

enum QTextLayout::CursorMode

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

[since 5.13] QTextLayout::QTextLayout(const QString &text, const QFont &font, const QPaintDevice *paintdevice = nullptr)

Создаёт макет текста для заданного text с указанным font.

Все метрики и вычисления макета будут выполнены относительно устройства отрисовки paintdevice. Если paintdevice nullptr, вычисления будут выполнены в метриках экрана.

Эта функция была добавлена в Qt 5.13.

QTextLayout::QTextLayout(const QString &text)

Создаёт макет текста для заданного text.

QTextLayout::QTextLayout()

Создаёт пустой макет текста.

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

QTextLayout::~QTextLayout()

Уничтожает макет.

void QTextLayout::beginLayout()

Начинает процесс формирования макета.

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

QRectF QTextLayout::boundingRect() const

Самый маленький прямоугольник, содержащий все строки в макете.

bool QTextLayout::cacheEnabled() const

Возвращает true, если вся информация о макете кэшируется; в противном случае возвращает false.

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

[since 5.6] void QTextLayout::clearFormats()

Очищает список дополнительных форматов, поддерживаемых макетом текста.

Эта функция была добавлена в Qt 5.6.

См. также formats() и setFormats().

void QTextLayout::clearLayout()

Очищает информацию о строках в макете. После вызова этой функции, lineCount() возвращает 0.

QTextLine QTextLayout::createLine()

Возвращает новую строку текста для форматирования, если в макете есть текст; в противном случае возвращает недействительную строку.

Макет текста создаёт новый объект строки, который начинается после последней строки в макете или в начале, если макет пустой. Макет сохраняет внутренний курсор, и каждая строка заполняется текстом с позиции курсора и далее, когда вызывается функция QTextLine::setLineWidth().

После вызова QTextLine::setLineWidth() можно создать и заполнить новую строку текстом. Повторение этого процесса сформирует весь блок текста, содержащийся в QTextLayout. Если больше нет текста для вставки в макет, возвращаемая QTextLine будет недействительной (isValid() вернёт false).

Qt::CursorMoveStyle QTextLayout::cursorMoveStyle() const

Стиль перемещения курсора в данном QTextLayout. По умолчанию используется Qt::LogicalMoveStyle.

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

void QTextLayout::draw(QPainter *p, const QPointF &pos, const QList<QTextLayout::FormatRange> &selections = QList<FormatRange>(), const QRectF &clip = QRectF()) const

Отрисовывает весь макет на рисовальщике p в позиции, заданной pos. Отображаемый макет включает указанные selections и ограничен прямоугольником, заданным clip.

void QTextLayout::drawCursor(QPainter *painter, const QPointF &position, int cursorPosition, int width) const

Отрисовывает курсор текста с текущим цветом и указанной width в заданной position с использованием указанного painter. Соответствующая позиция в тексте задаётся cursorPosition.

void QTextLayout::drawCursor(QPainter *painter, const QPointF &position, int cursorPosition) const

Это перегруженная функция.

Отрисовывает курсор текста с текущим цветом в заданной position с использованием указанного painter. Соответствующая позиция в тексте задаётся cursorPosition.

void QTextLayout::endLayout()

Завершает процесс формирования макета.

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

QFont QTextLayout::font() const

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

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

[since 5.6] QList<QTextLayout::FormatRange> QTextLayout::formats() const

Возвращает список дополнительных форматов, поддерживаемых макетом текста.

Эта функция была добавлена в Qt 5.6.

См. также setFormats() и clearFormats().

QList<QGlyphRun> QTextLayout::glyphRuns(int from = -1, int length = -1) const

Возвращает индексы глифов и позиции всех глифов, соответствующих length символам, начиная с позиции from в данном QTextLayout. Это ресурсоёмкая функция, и её не следует вызывать в контексте, требующем высокой производительности.

Если from меньше нуля, то выполняется для первого символа в макете. Если length меньше нуля, оно охватывает всю строку с начальной позиции.

См. также draw() и QPainter::drawGlyphRun().

bool QTextLayout::isValidCursorPosition(int pos) const

/ Возвращает true, если позиция pos — валидная позиция курсора.

В контексте Юникода некоторые позиции в тексте не являются валидными позициями курсора, поскольку позиция находится внутри суррогата Юникода или кластера графем.

Кластер графем — это последовательность двух или более символов Юникода, которые образуют один неделимый объект на экране. Например, латинская буква `Ä' может быть представлена в Юникоде двумя символами, `A' (0x41) и комбинирующей диэрезой (0x308). Курсор текста может быть расположен только до или после этих двух символов, а не между ними, так как это не имеет смысла. В индийских языках каждый слог образует кластер графем.

int QTextLayout::leftCursorPosition(int oldPos) const

Возвращает позицию курсора слева от oldPos, рядом с ней. Зависит от визуального расположения символов после переупорядочения в би-направленном порядке.

См. также rightCursorPosition() и previousCursorPosition().

QTextLine QTextLayout::lineAt(int i) const

Возвращает i-ю строку текста в этом макете текста.

См. также lineCount() и lineForTextPosition().

int QTextLayout::lineCount() const

Возвращает количество строк в этом макете текста.

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

QTextLine QTextLayout::lineForTextPosition(int pos) const

Возвращает строку, содержащую позицию курсора, заданную pos.

См. также isValidCursorPosition() и lineAt().

qreal QTextLayout::maximumWidth() const

Максимальная ширина, до которой может быть расширен макет; по сути, это ширина всего текста.

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

qreal QTextLayout::minimumWidth() const

Минимальная ширина, необходимая для макета. Это ширина самой короткой непроверяемой подстроки в макете.

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

int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode = SkipCharacters) const

Возвращает следующую допустимую позицию курсора после oldPos, учитывая заданный режим курсора mode. Возвращает значение oldPos, если oldPos не является допустимой позицией курсора.

См. также isValidCursorPosition() и previousCursorPosition().

QPointF QTextLayout::position() const

Глобальная позиция макета. Она не зависит от ограничивающей рамки и процесса компоновки.

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

int QTextLayout::preeditAreaPosition() const

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

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

QString QTextLayout::preeditAreaText() const

Возвращает текст, вставляемый в макет перед началом редактирования.

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

int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode = SkipCharacters) const

Возвращает первую допустимую позицию курсора перед oldPos, учитывая заданный режим курсора mode. Возвращает значение oldPos, если oldPos не является допустимой позицией курсора.

См. также isValidCursorPosition() и nextCursorPosition().

int QTextLayout::rightCursorPosition(int oldPos) const

Возвращает позицию курсора справа от oldPos, рядом с ним. Зависит от визуальной позиции символов после двунаправленной перестановки.

См. также leftCursorPosition() и nextCursorPosition().

void QTextLayout::setCacheEnabled(bool enable)

Включает кеширование всей информации о макете, если enable равно true; в противном случае отключает кеширование макета. Обычно QTextLayout удаляет большую часть информации о макете после вызова endLayout() для экономии памяти. Однако, если вам нужно отобразить отформатированный текст непосредственно после этого, включение кеширования может значительно ускорить отрисовку.

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

void QTextLayout::setCursorMoveStyle(Qt::CursorMoveStyle style)

Устанавливает визуальный стиль перемещения курсора на заданный style. Если QTextLayout подкрепляется документом, вы можете проигнорировать это и использовать параметр в QTextDocument, этот параметр предназначен для виджетов, таких как QLineEdit или пользовательские виджеты без QTextDocument. Значение по умолчанию — Qt::LogicalMoveStyle.

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

void QTextLayout::setFont(const QFont &font)

Устанавливает шрифт макета на заданный font. Макет становится недействительным и необходимо его повторно откомпоновать.

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

void QTextLayout::setFormats(const QList<QTextLayout::FormatRange> &formats)

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

Эта функция была введена в Qt 5.6.

См. также formats() и clearFormats().

void QTextLayout::setPosition(const QPointF &p)

Перемещает макет текста в точку p.

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

void QTextLayout::setPreeditArea(int position, const QString &text)

Устанавливает position и text области в макете, которая обрабатывается перед редактированием. Макет становится недействительным и необходимо его повторно откомпоновать.

См. также preeditAreaPosition() и preeditAreaText().

void QTextLayout::setText(const QString &string)

Устанавливает текст макета на заданную строку string. Макет становится недействительным и необходимо его повторно откомпоновать.

Обратите внимание, что при использовании этого QTextLayout в качестве части QTextDocument этот метод не будет иметь эффекта.

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

void QTextLayout::setTextOption(const QTextOption &option)

Устанавливает структуру параметров текста, которая управляет процессом компоновки, на заданные option.

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

QString QTextLayout::text() const

Возвращает текст макета.

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

const QTextOption &QTextLayout::textOption() const

Возвращает текущие параметры текста, используемые для управления процессом компоновки.

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