Класс QTextLayout

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

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

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

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

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

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

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

Он предлагает множество функций, ожидаемых от современного движка выравнивания текста, включая обработку Unicode, перенос слов и позиционирование курсора. Он также может создавать и отображать независимые от устройства макеты, что важно для приложений 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

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

QTextLayout::QTextLayout()

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

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

QTextLayout::QTextLayout(const QString &text)

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

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

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

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

QTextLayout::~QTextLayout()

Удаляет макет.

void QTextLayout::beginLayout()

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

Предупреждение: Это приведет к обновлению макета, поэтому все существующие объекты QTextLine, которые ссылаются на предыдущее содержимое, должны быть удалены.

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

QRectF QTextLayout::boundingRect() const

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

bool QTextLayout::cacheEnabled() const

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

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

void QTextLayout::clearFormats()

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

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

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

void QTextLayout::clearLayout()

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

Предупреждение: Это приведет к обновлению макета, поэтому все существующие объекты QTextLine, которые ссылаются на предыдущее содержимое, должны быть удалены.

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

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 QVector<QTextLayout::FormatRange> &selections = QVector<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().

QVector<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 меньше нуля, она будет охватывать всю строку с начальной позиции.

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

См. также 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

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

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

См. также 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 QVector<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().