Класс QTextBlockFormat

Класс 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::MarkerType

Это перечисление описывает типы маркеров, которые может иметь элемент списка. Если элемент списка (абзац, для которого QTextBlock::textList() возвращает список) имеет маркер, он отображается вместо обычной отметки. Таким образом, можно смешивать элементы списков с возможностью выбора с обычными элементами списка в одном списке, перезаписывая тип маркера, определенный QTextListFormat::style() для всего списка.

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

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

См. также QTextListFormat::style().

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

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

QTextBlockFormat::MarkerType QTextBlockFormat::marker() const

Возвращает маркер абзаца, если он был установлен, или NoMarker , если нет.

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

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

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

void QTextBlockFormat::setBottomMargin(qreal margin)

Устанавливает нижнюю границу абзаца.

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

void QTextBlockFormat::setHeadingLevel(int level)

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

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

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

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

void QTextBlockFormat::setIndent(int indentation)

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

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

void QTextBlockFormat::setLeftMargin(qreal margin)

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

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

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

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

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

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

void QTextBlockFormat::setMarker(QTextBlockFormat::MarkerType marker)

Устанавливает тип украшения, которое должно быть отображено рядом с абзацем, в marker. Например, пункт списка можно украсить галочкой, отмеченной или неотмеченной, как замена маркера. По умолчанию используется NoMarker.

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

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

void QTextBlockFormat::setNonBreakableLines(bool b)

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

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

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

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

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

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

void QTextBlockFormat::setRightMargin(qreal margin)

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

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

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

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

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

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

void QTextBlockFormat::setTextIndent(qreal indent)

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

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

void QTextBlockFormat::setTopMargin(qreal 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().