Класс QTextCharFormat

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

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

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

Типы public

Public Функции

• 51 публичные функции, унаследованные от QTextFormat

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

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

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

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

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

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

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

enum QTextCharFormat::FontPropertiesInheritanceBehavior

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

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

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

enum QTextCharFormat::UnderlineStyle

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

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

enum QTextCharFormat::VerticalAlignment

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

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

QTextCharFormat::QTextCharFormat()

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

QString QTextCharFormat::anchorHref() const

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

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

QStringList QTextCharFormat::anchorNames() const

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

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

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

QFont QTextCharFormat::font() const

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

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

QFont::Capitalization QTextCharFormat::fontCapitalization() const

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

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

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

QString QTextCharFormat::fontFamily() const

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

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

bool QTextCharFormat::fontFixedPitch() const

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

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

QFont::HintingPreference QTextCharFormat::fontHintingPreference() const

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

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

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

bool QTextCharFormat::fontItalic() const

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

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

bool QTextCharFormat::fontKerning() const

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

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

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

qreal QTextCharFormat::fontLetterSpacing() const

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

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

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

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().

int QTextCharFormat::fontStretch() const

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

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

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

bool QTextCharFormat::fontStrikeOut() const

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

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

QFont::StyleHint QTextCharFormat::fontStyleHint() const

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

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

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

QFont::StyleStrategy QTextCharFormat::fontStyleStrategy() const

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

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

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

bool QTextCharFormat::fontUnderline() const

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

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

int QTextCharFormat::fontWeight() const

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

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

qreal QTextCharFormat::fontWordSpacing() const

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

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

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

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

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

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

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

void QTextCharFormat::setAnchorNames(const QStringList &names)

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

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

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

void QTextCharFormat::setFont(const QFont &font, FontPropertiesInheritanceBehavior behavior)

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

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

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

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

void QTextCharFormat::setFont(const QFont &font)

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

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

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

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

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

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

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

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

void QTextCharFormat::setFontFamily(const QString &family)

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

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

void QTextCharFormat::setFontFixedPitch(bool fixedPitch)

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

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

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

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

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

См. также 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"), не обязательно верно.

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

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

void QTextCharFormat::setFontLetterSpacing(qreal spacing)

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

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

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

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

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().

void QTextCharFormat::setFontStretch(int factor)

Устанавливает коэффициент растяжения шрифта равным 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, поскольку эта информация не предоставляется системой окон.

Функция была введена в Qt 4.5.

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

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

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

Функция была введена в Qt 4.5.

См. также 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 в пикселях.

Функция была введена в Qt 4.4.

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

void QTextCharFormat::setTextOutline(const QPen &pen)

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

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

void QTextCharFormat::setToolTip(const QString &text)

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

Функция была введена в Qt 4.3.

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

void QTextCharFormat::setUnderlineColor(const QColor &color)

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

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

void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)

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

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

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

void QTextCharFormat::setVerticalAlignment(VerticalAlignment alignment)

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

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

QPen QTextCharFormat::textOutline() const

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

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

QString QTextCharFormat::toolTip() const

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

Функция была введена в Qt 4.3.

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

QColor QTextCharFormat::underlineColor() const

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

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

UnderlineStyle QTextCharFormat::underlineStyle() const

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

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

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

VerticalAlignment QTextCharFormat::verticalAlignment() const

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

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