Класс QTextBlockFormat

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

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

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

Общедоступные типы

Общедоступные функции

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

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

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

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

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

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

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

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

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

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

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

qreal QTextBlockFormat::lineHeight() const

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

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

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

int QTextBlockFormat::lineHeightType() const

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

Эта функция была введена в 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().