Spec-Zone.ru › Qt 5.15

Класс QTextListFormat

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

Заголовок: #include <QTextListFormat>
qmake: QT += gui
Наследует: QTextFormat
  • Список всех членов, включая унаследованные

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

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

перечисление Style { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman }

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

QTextListFormat()
int indent() const
bool isValid() const
QString numberPrefix() const
QString numberSuffix() const
void setIndent(int отступ)
void setNumberPrefix(const QString &numberPrefix)
void setNumberSuffix(const QString &numberSuffix)
void setStyle(QTextListFormat::Style style)
QTextListFormat::Style style() const

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

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

Отступ элементов — это целое число, которое смещает каждый элемент от левой границы на определенное значение. Это значение считывается с помощью indent() и устанавливается с помощью setIndent().

Стиль, используемый для оформления каждого элемента, устанавливается с помощью setStyle() и может быть прочитан с помощью функции style(). Стиль управляет типом маркеров и схемой нумерации, используемых для элементов списка. Обратите внимание, что списки, использующие десятичную схему нумерации, начинают счет с 1, а не с 0.

Свойства стиля могут быть настроены для дальнейшей настройки внешнего вида элементов списка; например, свойства ListNumberPrefix и ListNumberSuffix могут использоваться для настройки чисел, используемых в упорядоченном списке, так, чтобы они отображались как (1), (2), (3) и т. д.:

QTextListFormat listFormat;

listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");

cursor.insertList(listFormat);

См. также QTextList.

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

перечисление QTextListFormat::Style

Это перечисление описывает символы, используемые для оформления элементов списка:

Постоянная Значение Описание
QTextListFormat::ListDisc -1 заполненный круг
QTextListFormat::ListCircle -2 пустой круг
QTextListFormat::ListSquare -3 заполненный квадрат
QTextListFormat::ListDecimal -4 десятичные значения в возрастающем порядке
QTextListFormat::ListLowerAlpha -5 строчные латинские буквы в алфавитном порядке
QTextListFormat::ListUpperAlpha -6 заглавные латинские буквы в алфавитном порядке
QTextListFormat::ListLowerRoman -7 строчные римские цифры (поддерживает только до 4999 элементов)
QTextListFormat::ListUpperRoman -8 заглавные римские цифры (поддерживает только до 4999 элементов)

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

QTextListFormat::QTextListFormat()

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

int QTextListFormat::indent() const

Возвращает отступ формата списка. Отступ умножается на свойство QTextDocument::indentWidth, чтобы получить эффективный отступ в пикселях.

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

bool QTextListFormat::isValid() const

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

QString QTextListFormat::numberPrefix() const

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

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

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

QString QTextListFormat::numberSuffix() const

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

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

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

void QTextListFormat::setIndent(int отступ)

Устанавливает отступ формата списка. Отступ умножается на свойство QTextDocument::indentWidth, чтобы получить эффективный отступ в пикселях.

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

void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

Устанавливает префикс номера формата списка на строку, указанную параметром numberPrefix. Это может быть использовано со всеми типами упорядоченных списков. Не оказывает влияния на неупорядоченные типы списков.

По умолчанию префикс пустая строка.

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

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

void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

Устанавливает суффикс номера формата списка на строку, указанную параметром numberSuffix. Это может быть использовано со всеми типами упорядоченных списков. Не оказывает влияния на неупорядоченные типы списков.

По умолчанию суффикс «.».

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

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

void QTextListFormat::setStyle(QTextListFormat::Style style)

Устанавливает стиль формата списка.

См. также style() и Style.

QTextListFormat::Style QTextListFormat::style() const

Возвращает стиль формата списка.

См. также setStyle() и Style.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qtextlistformat.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API