Класс QTextListFormat

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

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

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

QString QTextListFormat::numberSuffix() const

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

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

void QTextListFormat::setIndent(int indentation)

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

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

void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

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

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

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

void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

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

По умолчанию суффикс — ".".

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

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

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

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

QTextListFormat::Style QTextListFormat::style() const

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

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