Класс QTextCharFormat

Класс QTextCharFormat предоставляет информацию о форматировании символов в QTextDocument. Подробнее...

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

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

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

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

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

Формат символьного шрифта документа задаёт визуальные свойства текста, а также информацию о его роли в гипертекстовом документе.

Используемый шрифт можно установить, передав его в функцию setFont(), и каждый аспект его внешнего вида можно настроить, чтобы получить желаемый эффект. setFontFamilies() и setFontPointSize() определяют семейство шрифта (например, Times) и размер печати; setFontWeight() и setFontItalic() обеспечивают управление стилем шрифта. setFontUnderline(), setFontOverline(), setFontStrikeOut() и setFontFixedPitch() обеспечивают дополнительные эффекты для текста.

Цвет устанавливается с помощью setForeground(). Если текст предназначен для использования в качестве якоря (для гиперссылок), это можно включить с помощью setAnchor(). Функции setAnchorHref() и setAnchorNames() используются для указания информации об адресате гиперссылки и имени якоря.

См. также QTextFormat, QTextBlockFormat, QTextTableFormat и QTextListFormat.

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

[since 5.3] перечисление QTextCharFormat::FontPropertiesInheritanceBehavior

Это перечисление определяет, как функция setFont() должна работать в отношении не установленных свойств шрифта.

Это перечисление было введено или изменено в Qt 5.3.

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

перечисление QTextCharFormat::UnderlineStyle

Это перечисление описывает различные способы рисования подчеркнутого текста.

См. также Qt::PenStyle.

перечисление QTextCharFormat::VerticalAlignment

Это перечисление описывает способы вертикального выравнивания смежных символов.

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

QTextCharFormat::QTextCharFormat()

Создаёт новый объект формата символьного шрифта.

QString QTextCharFormat::anchorHref() const

Возвращает гипертекстовую ссылку формата текста или пустую строку, если она не установлена.

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

QStringList QTextCharFormat::anchorNames() const

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

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

[since 6.0] qreal QTextCharFormat::baselineOffset() const

Возвращает смещение базовой линии в %.

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

См. также setBaselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline() и superScriptBaseline().

QFont QTextCharFormat::font() const

Возвращает шрифт для этого формата символьного шрифта.

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

QFont::Capitalization QTextCharFormat::fontCapitalization() const

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

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

[since 5.13] QVariant QTextCharFormat::fontFamilies() const

Возвращает семейства шрифтов формата текста.

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

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

bool QTextCharFormat::fontFixedPitch() const

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

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

QFont::HintingPreference QTextCharFormat::fontHintingPreference() const

Возвращает предпочтение отображения, установленное для этого формата текста.

См. также setFontHintingPreference(), font() и QFont::hintingPreference().

bool QTextCharFormat::fontItalic() const

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

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

bool QTextCharFormat::fontKerning() const

Возвращает true, если керинг шрифта включён.

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

qreal QTextCharFormat::fontLetterSpacing() const

Возвращает текущий интервал между буквами.

См. также setFontLetterSpacing(), setFontLetterSpacingType(), и fontLetterSpacingType().

[since 5.0] QFont::SpacingType QTextCharFormat::fontLetterSpacingType() const

Возвращает тип интервала между буквами для данного формата.

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

См. также setFontLetterSpacingType(), setFontLetterSpacing(), и fontLetterSpacing().

bool QTextCharFormat::fontOverline() const

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

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

qreal QTextCharFormat::fontPointSize() const

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

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

[since 5.0] int QTextCharFormat::fontStretch() const

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

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

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

bool QTextCharFormat::fontStrikeOut() const

Возвращает true если шрифт текста перечеркнут (имеет горизонтальную линию через него); в противном случае возвращает false.

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

QFont::StyleHint QTextCharFormat::fontStyleHint() const

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

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

[since 5.13] QVariant QTextCharFormat::fontStyleName() const

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

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

См. также setFontStyleName(), font(), и QFont::styleName().

QFont::StyleStrategy QTextCharFormat::fontStyleStrategy() const

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

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

bool QTextCharFormat::fontUnderline() const

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

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

int QTextCharFormat::fontWeight() const

Возвращает начертание шрифта для данного формата.

См. также setFontWeight(), font(), и QFont::Weight.

qreal QTextCharFormat::fontWordSpacing() const

Возвращает текущее значение интервала между словами.

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

bool QTextCharFormat::isAnchor() const

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

См. также setAnchor(), setAnchorHref(), и setAnchorNames().

bool QTextCharFormat::isValid() const

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

void QTextCharFormat::setAnchor(bool anchor)

Если anchor равно true, текст с этим форматом представляет собой ссылку, и отформатирован соответствующим образом; в противном случае текст отформатирован обычным образом. (Ссылки — это гиперссылки, которые часто отображаются подчеркнутыми и другим цветом, отличным от простого текста.)

Способ отображения текста не зависит от того, определена ли у формата действительная ссылка. Используйте setAnchorHref(), и необязательно setAnchorNames(), чтобы создать гипертекстовую ссылку.

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

void QTextCharFormat::setAnchorHref(const QString &value)

Устанавливает гиперссылку для формата текста на заданное значение value. Обычно это URL, например, "http://example.com/index.html".

Ссылка будет отображаться с value в качестве текста; если вы хотите отобразить другой текст, вызовите setAnchorNames().

Чтобы отформатировать текст как гиперссылку, используйте setAnchor().

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

void QTextCharFormat::setAnchorNames(const QStringList &names)

Устанавливает имена ссылки для формата текста. Чтобы ссылка работала как гиперссылка, необходимо установить пункт назначения с помощью setAnchorHref() и включить ссылку с помощью setAnchor().

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

[since 6.0] void QTextCharFormat::setBaselineOffset(qreal baseline)

Устанавливает линию основания (в % от высоты) текста в baseline. Положительное значение перемещает текст вверх, на соответствующие %; отрицательное значение — вниз. Значение по умолчанию — 0.

Данная функция была добавлена в Qt 6.0.

См. также baselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline(), и superScriptBaseline().

[since 5.3] void QTextCharFormat::setFont(const QFont &font, QTextCharFormat::FontPropertiesInheritanceBehavior behavior = FontPropertiesAll)

Устанавливает шрифт текста.

Если behavior равно QTextCharFormat::FontPropertiesAll, свойство шрифта, которое не было явно установлено, обрабатывается так, как будто оно было установлено со значением по умолчанию; если behavior равно QTextCharFormat::FontPropertiesSpecifiedOnly, свойство шрифта, которое не было явно установлено, игнорируется, и соответствующее значение свойства остается неизменным.

Данная функция была добавлена в Qt 5.3.

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

void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)

Устанавливает регистр текста, который отображается в этом шрифте, на capitalization.

Регистр шрифта заставляет текст отображаться в выбранном режиме регистрового преобразования.

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

[since 5.13] void QTextCharFormat::setFontFamilies(const QStringList &families)

Устанавливает наборы шрифтов для данного формата текста.

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

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

void QTextCharFormat::setFontFixedPitch(bool fixedPitch)

Если fixedPitch равно true, устанавливает шрифт текста как фиксированной ширины; в противном случае используется шрифт с переменной шириной.

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

void QTextCharFormat::setFontHintingPreference(QFont::HintingPreference hintingPreference)

Устанавливает предпочтение керирования шрифта для данного формата текста на hintingPreference.

См. также fontHintingPreference(), setFont(), и QFont::setHintingPreference().

void QTextCharFormat::setFontItalic(bool italic)

Если italic равно true, устанавливает шрифт текста как курсивный; в противном случае шрифт будет некурсивным.

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

void QTextCharFormat::setFontKerning(bool enable)

Включает кернинг для этого шрифта, если enable имеет значение true; в противном случае отключает его.

При включенном кернинге метрики глифов больше не суммируются, даже для латинского текста. Другими словами, предположение, что width('a') + width('b') равно width("ab"), необязательно верно.

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

void QTextCharFormat::setFontLetterSpacing(qreal spacing)

Устанавливает интерлиньяж для этого формата на заданное значение spacing. Значение зависит от типа интерлиньяжа шрифта.

Для интерлиньяжа в процентах значение 100 соответствует стандартному интерлиньяжу; значение 200 удваивает размер отступа между буквами.

См. также fontLetterSpacing(), setFontLetterSpacingType() и fontLetterSpacingType().

[since 5.0] void QTextCharFormat::setFontLetterSpacingType(QFont::SpacingType letterSpacingType)

Устанавливает тип интерлиньяжа этого формата на letterSpacingType.

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

См. также fontLetterSpacingType(), setFontLetterSpacing() и fontLetterSpacing().

void QTextCharFormat::setFontOverline(bool overline)

Если overline имеет значение true, устанавливает шрифт текста с надстрочной чертой; в противном случае шрифт отображается без надстрочной черты.

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

void QTextCharFormat::setFontPointSize(qreal size)

Устанавливает размер шрифта текста формата size.

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

[since 5.0] void QTextCharFormat::setFontStretch(int factor)

Устанавливает коэффициент растяжения шрифта на factor.

Коэффициент растяжения изменяет ширину всех символов в шрифте на фактор процентов. Например, установка factor в 150 приводит к тому, что все символы в шрифте становятся в 1,5 раза (то есть на 150%) шире. Значение по умолчанию для коэффициента растяжения — 100. Минимальное значение коэффициента растяжения — 1, максимальное — 4000.

Коэффициент растяжения применяется только к контурным шрифтам. Для растровых шрифтов коэффициент растяжения игнорируется.

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

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

void QTextCharFormat::setFontStrikeOut(bool strikeOut)

Если strikeOut имеет значение true, устанавливает формат текста шрифта с включённым перечёркиванием (с горизонтальной линией через него); в противном случае он отображается без перечёркивания.

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

void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy = QFont::PreferDefault)

Устанавливает стиль шрифта hint и strategy.

Qt не поддерживает стили подсказок на X11, так как эта информация не предоставляется системой окон.

См. также fontStyleHint(), setFont() и QFont::setStyleHint().

[since 5.13] void QTextCharFormat::setFontStyleName(const QString &styleName)

Устанавливает имя стиля шрифта текста styleName.

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

См. также fontStyleName(), setFont() и QFont::setStyleName().

void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)

Устанавливает стратегию стиля шрифта strategy.

См. также fontStyleStrategy(), setFont() и QFont::setStyleStrategy().

void QTextCharFormat::setFontUnderline(bool underline)

Если underline имеет значение true, устанавливает шрифт текста с подчёркиванием; в противном случае шрифт отображается без подчёркивания.

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

void QTextCharFormat::setFontWeight(int weight)

Устанавливает начертание шрифта текста на weight.

См. также fontWeight(), setFont() и QFont::Weight.

void QTextCharFormat::setFontWordSpacing(qreal spacing)

Устанавливает интерлиньяж для этого формата на заданное значение spacing в пикселях.

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

[since 6.0] void QTextCharFormat::setSubScriptBaseline(qreal baseline)

Устанавливает базовую линию нижнего индекса как процент высоты шрифта на baseline. Значение по умолчанию — 16,67% (1/6 высоты).

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

См. также subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset() и baselineOffset().

[since 6.0] void QTextCharFormat::setSuperScriptBaseline(qreal baseline)

Устанавливает базовую линию верхнего индекса как процент высоты шрифта на baseline. Значение по умолчанию — 50% (1/2 высоты).

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

См. также superScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset() и baselineOffset().

void QTextCharFormat::setTextOutline(const QPen &pen)

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

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

void QTextCharFormat::setToolTip(const QString &text)

Устанавливает всплывающую подсказку для фрагмента текста на заданный text.

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

void QTextCharFormat::setUnderlineColor(const QColor &color)

Устанавливает цвет, используемый для рисования подчёркиваний, надстрочных линий и перечёркиваний символов с этим форматом, на указанный color.

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

void QTextCharFormat::setUnderlineStyle(QTextCharFormat::UnderlineStyle style)

Устанавливает стиль подчёркивания текста на style.

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

void QTextCharFormat::setVerticalAlignment(QTextCharFormat::VerticalAlignment alignment)

Устанавливает вертикальное выравнивание для символов с этим форматом на указанное alignment.

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

[since 6.0] qreal QTextCharFormat::subScriptBaseline() const

Возвращает базовую линию нижнего индекса как процент высоты шрифта.

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

См. также setSubScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset() и baselineOffset().

[since 6.0] qreal QTextCharFormat::superScriptBaseline() const

Возвращает базовую линию верхнего индекса как процент высоты шрифта.

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

См. также setSuperScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset(), и baselineOffset().

QPen QTextCharFormat::textOutline() const

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

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

QString QTextCharFormat::toolTip() const

Возвращает всплывающую подсказку, отображаемую для фрагмента текста.

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

QColor QTextCharFormat::underlineColor() const

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

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

QTextCharFormat::UnderlineStyle QTextCharFormat::underlineStyle() const

Возвращает стиль подчеркивания текста.

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

QTextCharFormat::VerticalAlignment QTextCharFormat::verticalAlignment() const

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

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