Класс QTextListFormat

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

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

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

Типы

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

• 51 общедоступных функций, унаследованных от QTextFormat

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

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

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

Отступ элементов — это целое число, которое вызывает смещение каждого элемента от левой границы на определенное количество. Это значение читается с помощью 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::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 indentation)

Устанавливает indentation формата списка. Отступ умножается на свойство 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(Style style)

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

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

Style QTextListFormat::style() const

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

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