Класс QTextBlockFormat

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

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

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

Открытые типы

Открытые функции

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

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

Класс 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::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::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().