Класс QFontMetricsF

Класс QFontMetricsF предоставляет информацию о метриках шрифта. Подробнее...

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

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

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

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

Класс QFontMetricsF предоставляет информацию о метриках шрифта.

QFontMetricsF функции вычисляют размер символов и строк для заданного шрифта. Вы можете создать объект QFontMetricsF с существующим объектом QFont, чтобы получить метрики для этого шрифта. Если шрифт будет изменён позже, объект метрик шрифта не будет обновлён.

После создания объект предоставляет функции для доступа к отдельным метрикам шрифта, его символов и строк, отрисованных этим шрифтом.

Несколько функций работают со шрифтом: ascent(), descent(), height(), leading() и lineSpacing() возвращают основные свойства размера шрифта. Функции underlinePos(), overlinePos(), strikeOutPos() и lineWidth() возвращают свойства линии, которая подчеркивает, перечеркивает или зачёркивает символы. Эти функции выполняют быстрый доступ.

Существуют также функции, которые работают с набором глифов в шрифте: minLeftBearing(), minRightBearing() и maxWidth(). Они по необходимости медленнее, и мы рекомендуем избегать их, если это возможно.

Для каждого символа можно получить его ширину, leftBearing() и rightBearing(), и определить, содержится ли он в шрифте с помощью inFont(). Также символ можно рассматривать как строку и использовать функции для строк.

Функции для строк включают width(), чтобы вернуть ширину строки в пикселях (или пунктах для принтера), boundingRect(), чтобы вернуть прямоугольник, достаточно большой, чтобы содержать отрисованную строку, и size(), чтобы вернуть размер этого прямоугольника.

Пример:

QFont font("times", 24);
QFontMetricsF fm(font);
qreal pixelsWide = fm.horizontalAdvance("What's the width of this text?");
qreal pixelsHigh = fm.height();

См. также QFont, QFontInfo и QFontDatabase.

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

QFontMetricsF::QFontMetricsF(const QFont &font)

Создаёт объект метрик шрифта для font.

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

Объект метрик шрифта хранит информацию о шрифте, переданном в конструктор в момент его создания, и не обновляется, если атрибуты шрифта изменятся позже.

Используйте QFontMetricsF(const QFont &, QPaintDevice *) для получения метрик шрифта, совместимых с определённым устройством рисования.

QFontMetricsF::QFontMetricsF(const QFont &font, QPaintDevice *paintdevice)

Создаёт объект метрик шрифта для font и paintdevice.

Метрики шрифта будут совместимы с переданным paintdevice. Если paintdevice равен 0, метрики будут совместимы с экраном, т.е. метрики, которые вы получите, если используете шрифт для рисования текста на виджетах или пиксельмапах, а не на QPicture или QPrinter.

Объект метрик шрифта хранит информацию о шрифте, переданном в конструктор во время его создания, и не обновляется, если атрибуты шрифта изменяются позже.

QFontMetricsF::QFontMetricsF(const QFontMetrics &fontMetrics)

Создаёт объект метрик шрифта с плавающей точкой по заданному объекту метрик fontMetrics.

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

QFontMetricsF::QFontMetricsF(const QFontMetricsF &fm)

Создаёт копию fm.

QFontMetricsF::~QFontMetricsF()

Уничтожает объект метрик шрифта и освобождает все выделенные ресурсы.

qreal QFontMetricsF::ascent() const

Возвращает восходящую высоту шрифта.

Восходящая высота шрифта — это расстояние от базовой линии до самой высокой позиции, достигаемой символами. На практике некоторые дизайнеры шрифтов нарушают это правило, например, когда они размещают более одного акцента сверху символа или для адаптации необычного символа в экзотическом языке, поэтому возможно (хотя и редко), что это значение окажется слишком маленьким.

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

qreal QFontMetricsF::averageCharWidth() const

Возвращает среднюю ширину глифов в шрифте.

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

QRectF QFontMetricsF::boundingRect(const QString &text) const

Возвращает прямоугольник, охватывающий символы в строке, заданной text. Охватывающий прямоугольник всегда включает по крайней мере все пиксели, которые текст занимал бы при отрисовке в точке (0, 0).

Обратите внимание, что охватывающий прямоугольник может выходить влево от (0, 0), например, для наклонных шрифтов, и что ширина возвращаемого прямоугольника может отличаться от значения, возвращаемого методом width().

Если вам нужно узнать ширину продвижения строки (для выравнивания набора строк друг за другом), используйте horizontalAdvance() вместо этого.

Символы новой строки обрабатываются как обычные символы, а не как разрывы строк.

Высота охватывающего прямоугольника не меньше значения, возвращаемого методом height().

См. также width(), height() и QPainter::boundingRect().

QRectF QFontMetricsF::boundingRect(QChar ch) const

Возвращает охватывающий прямоугольник символа ch относительно самой левой точки на базовой линии.

Обратите внимание, что охватывающий прямоугольник может выходить влево от (0, 0), например, для наклонных шрифтов, и что текст может занимать все пиксели в охватывающем прямоугольнике.

Обратите внимание, что прямоугольник обычно простирается как выше, так и ниже базовой линии.

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

QRectF QFontMetricsF::boundingRect(const QRectF &rect, int flags, const QString &text, int tabStops = 0, int *tabArray = nullptr) const

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

Возвращает охватывающий прямоугольник символов в заданном text. Это набор пикселей, которые текст занимал бы, если бы был ограничен охватывающим прямоугольником, заданным rect.

Аргумент flags представляет собой побитовое ИЛИ следующих флагов:

• Qt::AlignLeft выравнивает по левой границе, за исключением арабского и иврита, где выравнивает по правой.
• Qt::AlignRight выравнивает по правой границе, за исключением арабского и иврита, где выравнивает по левой.
• Qt::AlignJustify выравнивает текст по ширине.
• Qt::AlignHCenter выравнивает по горизонтали по центру.
• Qt::AlignTop выравнивает по верхней границе.
• Qt::AlignBottom выравнивает по нижней границе.
• Qt::AlignVCenter выравнивает по вертикали по центру
• Qt::AlignCenter (== Qt::AlignHCenter | Qt::AlignVCenter)
• Qt::TextSingleLine игнорирует символы новой строки в тексте.
• Qt::TextExpandTabs расширяет табуляцию (см. ниже)
• Qt::TextShowMnemonic интерпретирует "&x" как x; т.е., подчёркнутый.
• Qt::TextWordWrap разрывает текст, чтобы он соответствовал прямоугольнику.

Qt::Horizontal выравнивание по умолчанию равно Qt::AlignLeft, а вертикальное выравнивание — Qt::AlignTop.

Если установлено несколько флагов горизонтального или вертикального выравнивания, результат выравнивания неопределён.

Эти флаги определены в Qt::AlignmentFlag.

Если Qt::TextExpandTabs установлен в flags, используется следующее поведение для интерпретации символов табуляции в тексте:

• Если tabArray не равен null, он задаёт последовательность нуль-терминированных позиций пикселей для табуляции в тексте.
• Если tabStops не равно нулю, оно используется в качестве интервала табуляции (в пикселях).

Обратите внимание, что охватывающий прямоугольник может выходить влево от (0, 0), например, для наклонных шрифтов.

Символы новой строки обрабатываются как разрывы строк.

Несмотря на разную фактическую высоту символов, высота охватывающих прямоугольников "Да" и "да" одинакова.

Охватывающий прямоугольник, возвращаемый этой функцией, несколько больше, чем тот, который вычисляет более простая функция boundingRect(). Эта функция использует максимальные значения отступа влево и вправо, как необходимо для многострочного текста, чтобы выравнивание было правильным. Также для вычисления высоты используются fontHeight() и lineSpacing(), а не высота отдельных символов.

См. также width(), QPainter::boundingRect() и Qt::Alignment.

qreal QFontMetricsF::capHeight() const

Возвращает высоту крышки шрифта.

Высота крышки шрифта — это высота прописных букв над базовой линией. Это конкретно высота прописных букв, которые плоские — например, H или I — в отличие от округлых букв, таких как O, или острых букв, таких как A, которые могут отображаться с избытком.

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

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

qreal QFontMetricsF::descent() const

Возвращает нисходящую высоту шрифта.

Нисходящая высота — это расстояние от базовой линии до самой нижней точки, достигаемой символами. (Обратите внимание, что это отличается от X, который добавляет 1 пиксель.) На практике некоторые дизайнеры шрифтов нарушают это правило, например, чтобы вместить необычный символ в экзотическом языке, поэтому возможно (хотя и редко), что это значение окажется слишком маленьким.

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

QString QFontMetricsF::elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags = 0) const

Если строка text шире, чем width, возвращает усечённую версию строки (т.е., строку с "..." в ней). В противном случае возвращает исходную строку.

Параметр mode указывает, усекается ли текст слева (например, "...тех"), по центру (например, "Tr...ch") или справа (например, "Трол...").

width задаётся в пикселях, а не в символах.

Аргумент flags необязателен и в настоящее время поддерживает только Qt::TextShowMnemonic в качестве значения.

Маркер усечения следует за направлением макета. Например, он будет находиться справа от текста для макетов справа налево, если mode равен Qt::ElideLeft, и слева от текста, если mode равен Qt::ElideRight.

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

qreal QFontMetricsF::height() const

Возвращает высоту шрифта.

Это всегда равно ascent()+descent().

См. также leading() и lineSpacing().

qreal QFontMetricsF::horizontalAdvance(const QString &text, int length = -1) const

Возвращает горизонтальное продвижение в пикселях первых length символов из text. Если length отрицательное (по умолчанию), используется вся строка.

Продвижение — это расстояние, необходимое для отрисовки последующего символа после text.

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

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

qreal QFontMetricsF::horizontalAdvance(QChar ch) const

Это перегруженный метод.

Возвращает горизонтальный отступ символа ch в пикселях. Это расстояние, подходящее для отрисовки последующего символа после ch.

Некоторые метрики описаны на рисунке справа. Центральные тёмные прямоугольники охватывают логическую ширину каждого символа. Внешние светлые прямоугольники охватывают leftBearing() и rightBearing() каждого символа. Обратите внимание, что отступы символа "f" в этом конкретном шрифте оба отрицательные, а отступы символа "o" оба положительные.

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

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

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

bool QFontMetricsF::inFont(QChar ch) const

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

bool QFontMetricsF::inFontUcs4(uint ch) const

Возвращает true если символ, заданный ch, закодированный в UCS-4/UTF-32, является допустимым символом в шрифте; в противном случае возвращает false.

qreal QFontMetricsF::leading() const

Возвращает отступ шрифта.

Это естественный межстрочный интервал.

См. также height() и lineSpacing().

qreal QFontMetricsF::leftBearing(QChar ch) const

Возвращает левый отступ символа ch в шрифте.

Левый отступ — это расстояние вправо от левого пикселя символа до логического начала символа. Это значение отрицательно, если пиксели символа простираются влево от логического начала.

См. width() для графического описания этой метрики.

См. также rightBearing(), minLeftBearing() и width().

qreal QFontMetricsF::lineSpacing() const

Возвращает расстояние от одной базовой линии до следующей.

Это значение всегда равно leading()+height().

См. также height() и leading().

qreal QFontMetricsF::lineWidth() const

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

См. также underlinePos(), overlinePos() и strikeOutPos().

qreal QFontMetricsF::maxWidth() const

Возвращает ширину самого широкого символа в шрифте.

qreal QFontMetricsF::minLeftBearing() const

Возвращает минимальный левый отступ шрифта.

Это наименьший leftBearing(символ) всех символов в шрифте.

Обратите внимание, что эта функция может быть очень медленной, если шрифт большой.

См. также minRightBearing() и leftBearing().

qreal QFontMetricsF::minRightBearing() const

Возвращает минимальный правый отступ шрифта.

Это наименьший rightBearing(символ) всех символов в шрифте.

Обратите внимание, что эта функция может быть очень медленной, если шрифт большой.

См. также minLeftBearing() и rightBearing().

qreal QFontMetricsF::overlinePos() const

Возвращает расстояние от базовой линии до места, где должна быть нарисована черта сверху.

См. также underlinePos(), strikeOutPos() и lineWidth().

qreal QFontMetricsF::rightBearing(QChar ch) const

Возвращает правый отступ символа ch в шрифте.

Правый отступ — это расстояние влево от правого пикселя символа до логического начала последующего символа. Это значение отрицательно, если пиксели символа простираются вправо за пределы ширины символа.

См. width() для графического описания этой метрики.

См. также leftBearing(), minRightBearing() и width().

QSizeF QFontMetricsF::size(int flags, const QString &text, int tabStops = 0, int *tabArray = nullptr) const

Возвращает размер в пикселях символов в заданном text.

Аргумент flags — это побитовое ИЛИ следующих флагов:

• Qt::TextSingleLine игнорирует символы новой строки.
• Qt::TextExpandTabs расширяет табуляцию (см. ниже)
• Qt::TextShowMnemonic интерпретирует "&x" как x; т.е. подчеркнуто.
• Qt::TextWordWrap разбивает текст, чтобы он поместился в прямоугольник.

Эти флаги определены в перечислении Qt::TextFlag.

Если Qt::TextExpandTabs установлен в flags, используется следующее поведение для интерпретации символов табуляции в тексте:

• Если tabArray не равен нулю, он определяет последовательность позиций в пикселях для табуляций в тексте.
• Если tabStops отличен от нуля, он используется как интервал табуляции (в пикселях).

Символы новой строки обрабатываются как переводы строк.

Примечание: Несмотря на разную фактическую высоту символов, высоты ограничивающих прямоугольников "Yes" и "yes" одинаковы.

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

qreal QFontMetricsF::strikeOutPos() const

Возвращает расстояние от базовой линии до места, где должна быть нарисована линия зачёркивания.

См. также underlinePos(), overlinePos() и lineWidth().

void QFontMetricsF::swap(QFontMetricsF &other)

Меняет местами этот экземпляр метрик шрифта с other. Эта функция очень быстрая и никогда не завершается ошибкой.

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

QRectF QFontMetricsF::tightBoundingRect(const QString &text) const

Возвращает плотный ограничительный прямоугольник вокруг символов в строке, заданной text. Ограничительный прямоугольник всегда охватывает по меньшей мере набор пикселей, которые текст охватывал бы, если бы был нарисован в (0, 0).

Обратите внимание, что ограничительный прямоугольник может простираться влево от (0, 0), например, для наклонного шрифта, и что ширина возвращаемого прямоугольника может отличаться от возвращаемого методом width().

Если вам нужна ширина отступа строки (для выравнивания набора строк рядом друг с другом), используйте horizontalAdvance() вместо этого.

Символы новой строки обрабатываются как обычные символы, а не как разрывы строк.

Предупреждение: Вызов этого метода очень медленный в Windows.

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

См. также width(), height() и boundingRect().

qreal QFontMetricsF::underlinePos() const

Возвращает расстояние от базовой линии до места, где должна быть нарисована черта снизу.

См. также overlinePos(), strikeOutPos() и lineWidth().

qreal QFontMetricsF::xHeight() const

Возвращает высоту 'x' шрифта. Часто, но не всегда, это то же самое, что и высота символа 'x'.

bool QFontMetricsF::operator!=(const QFontMetricsF &other) const

Это перегруженный метод.

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

См. также operator==().

QFontMetricsF &QFontMetricsF::operator=(const QFontMetricsF &fm)

Присваивает метрики шрифта fm этому объекту метрик шрифта.

QFontMetricsF &QFontMetricsF::operator=(const QFontMetrics &other)

Присваивает other этому объекту.

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

QFontMetricsF &QFontMetricsF::operator=(QFontMetricsF &&other)

Перемещающее присваивание other этому экземпляру QFontMetricsF.

bool QFontMetricsF::operator==(const QFontMetricsF &other) const

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

Две метрики шрифта считаются равными, если они были созданы из одного и того же QFont, и устройства отрисовки, для которых они были созданы, считаются совместимыми.