Класс QTextBlockFormat

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

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

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

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

Функции публичного доступа

• 51 функция унаследованная от QTextFormat

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

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

Документ состоит из списка блоков, представленных объектами QTextBlock. Каждый блок может содержать элемент определенного типа, например, абзац текста, таблицу, список или изображение. Каждый блок имеет связанный с ним QTextBlockFormat, определяющий его характеристики.

Для поддержки языков с письмом слева направо и справа налево можно задать направление блока с помощью setDirection(). Выравнивание абзаца задаётся с помощью setAlignment(). Отступы контролируются setTopMargin(), setBottomMargin(), setLeftMargin(), setRightMargin(). Общий отступ задаётся с помощью setIndent(), отступ первой строки — с помощью setTextIndent().

Межстрочный интервал задаётся с помощью setLineHeight() и извлекается через lineHeight() и lineHeightType(). Типы межстрочных интервалов доступны в перечислении LineHeightTypes.

Разрыв строки можно включить или отключить с помощью setNonBreakableLines().

Щётка, используемая для отрисовки фона абзаца, задаётся с помощью setBackground(), а другие аспекты внешнего вида текста могут быть настраиваемы с помощью функции setProperty() со значениями перечисления OutlinePen, ForegroundBrush, и BackgroundBrush QTextFormat::Property.

Если блок текста является частью списка, он также может иметь формат списка, доступный с помощью функции listFormat().

См. также QTextBlock и QTextCharFormat.

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

Перечисление QTextBlockFormat::LineHeightTypes

Это перечисление описывает различные типы межстрочных интервалов, которые могут поддерживать абзацы.

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

См. также lineHeight(), lineHeightType() и setLineHeight().

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

QTextBlockFormat::QTextBlockFormat()

Создаёт новый объект QTextBlockFormat.

Qt::Alignment QTextBlockFormat::alignment() const

Возвращает выравнивание абзаца.

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

qreal QTextBlockFormat::bottomMargin() const

Возвращает нижний отступ абзаца.

См. также setBottomMargin() и topMargin().

int QTextBlockFormat::headingLevel() const

Возвращает уровень заголовка абзаца, если это заголовок, или 0, если нет.

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

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

int QTextBlockFormat::indent() const

Возвращает отступ абзаца.

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

bool QTextBlockFormat::isValid() const

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

qreal QTextBlockFormat::leftMargin() const

Возвращает левый отступ абзаца.

См. также setLeftMargin(), rightMargin() и indent().

qreal QTextBlockFormat::lineHeight(qreal scriptLineHeight, qreal scaling = 1.0) const

Возвращает высоту строк в абзаце, основанную на высоте строки скрипта, заданной scriptLineHeight, и заданном коэффициенте масштабирования scaling.

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

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

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

См. также LineHeightTypes, setLineHeight() и lineHeightType().

qreal QTextBlockFormat::lineHeight() const

Возвращает свойство LineHeight для абзаца.

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

См. также LineHeightTypes, setLineHeight() и lineHeightType().

int QTextBlockFormat::lineHeightType() const

Возвращает свойство LineHeightType абзаца.

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

См. также LineHeightTypes, setLineHeight() и lineHeight().

bool QTextBlockFormat::nonBreakableLines() const

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

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

QTextFormat::PageBreakFlags QTextBlockFormat::pageBreakPolicy() const

Возвращает текущую политику разрыва страницы для абзаца. По умолчанию используется QTextFormat::PageBreak_Auto.

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

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

qreal QTextBlockFormat::rightMargin() const

Возвращает правый отступ абзаца.

См. также setRightMargin() и leftMargin().

void QTextBlockFormat::setAlignment(Qt::Alignment alignment)

Устанавливает выравнивание абзаца alignment.

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

void QTextBlockFormat::setBottomMargin(qreal margin)

Устанавливает нижний отступ абзаца margin.

См. также bottomMargin(), setTopMargin(), setLeftMargin() и setRightMargin().

void QTextBlockFormat::setHeadingLevel(int level)

Устанавливает уровень заголовка абзаца level, где 1 — это самый высокий уровень заголовка (обычно с самым большим возможным размером шрифта заголовка), а возрастающие значения — это всё более глубокие уровни в документе (и, как правило, со всё меньшими размерами шрифта). Например, при чтении тега HTML H1 уровень заголовка устанавливается в 1. Установка уровня заголовка не изменяет размер шрифта автоматически; однако QTextDocumentFragment::fromHtml() устанавливает одновременно и уровень заголовка, и размер шрифта.

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

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

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

void QTextBlockFormat::setIndent(int indentation)

Устанавливает отступ абзаца indentation. Отступы устанавливаются независимо от отступа с помощью setLeftMargin() и setTextIndent(). indentation — это целое число, которое умножается на стандартный отступ всего документа, что приводит к фактическому отступу абзаца.

См. также indent() и QTextDocument::indentWidth().

void QTextBlockFormat::setLeftMargin(qreal margin)

Устанавливает левый отступ абзаца margin. Отступ можно применять отдельно с помощью setIndent().

См. также leftMargin(), setRightMargin(), setTopMargin() и setBottomMargin().

void QTextBlockFormat::setLineHeight(qreal height, int heightType)

Устанавливает высоту строки абзаца со значением height, которое зависит от heightType так, как описано в перечислении LineHeightTypes.

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

См. также LineHeightTypes, lineHeight() и lineHeightType().

void QTextBlockFormat::setNonBreakableLines(bool b)

Если b равно true, строки в абзаце обрабатываются как неразрывные; в противном случае они разрывные.

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

void QTextBlockFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)

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

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

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

void QTextBlockFormat::setRightMargin(qreal margin)

Устанавливает правый отступ абзаца margin.

См. также rightMargin(), setLeftMargin(), setTopMargin() и setBottomMargin().

void QTextBlockFormat::setTabPositions(const QList<QTextOption::Tab> &tabs)

Устанавливает позиции табуляции для текстового блока в соответствии со значениями, указанными в tabs.

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

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

void QTextBlockFormat::setTextIndent(qreal indent)

Устанавливает indent для первой строки блока. Это позволяет отступать первую строку абзаца по-другому, чем остальные строки, повышая читаемость текста.

См. также textIndent(), setLeftMargin(), setRightMargin(), setTopMargin() и setBottomMargin().

void QTextBlockFormat::setTopMargin(qreal margin)

Устанавливает верхний отступ абзаца margin.

См. также topMargin(), setBottomMargin(), setLeftMargin() и setRightMargin().

QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const

Возвращает список позиций табуляции, определенных для текстового блока.

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

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

qreal QTextBlockFormat::textIndent() const

Возвращает отступ абзаца.

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

qreal QTextBlockFormat::topMargin() const

Возвращает верхний отступ абзаца.

См. также setTopMargin() и bottomMargin().