Класс QTextListFormat
Класс QTextListFormat предоставляет информацию о форматировании списков в QTextDocument. Подробнее...
| Заголовок: | #include <QTextListFormat> |
| CMake: | find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Наследуется от: | QTextFormat |
Примечание: Все функции этого класса являются повторно входящими.
Типы публичного доступа
| Перечисление | Стиль { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman } |
Функции публичного доступа
| QTextListFormat() | |
| int | отступ() const |
| bool | isValid() const |
| QString | префикс_номера() const |
| QString | суффикс_номера() const |
| void | установитьОтступ(int отступ) |
| void | установитьПрефиксНомера(const QString &префиксНомера) |
| void | установитьСуффиксНомера(const QString &суффиксНомера) |
| void | установитьСтиль(QTextListFormat::Style style) |
| QTextListFormat::Style | стиль() const |
Подробное описание
Список состоит из одного или нескольких элементов, представленных как текстовые блоки. Формат списка определяет внешний вид элементов списка. В частности, он определяет отступы и стиль каждого элемента.
Отступ элементов — это целое значение, которое смещает каждый элемент от левой границы на определённое количество. Это значение читается с помощью отступ() и устанавливается с помощью установитьОтступ().
Стиль, используемый для оформления каждого элемента, устанавливается с помощью установитьСтиль() и может быть прочитан с помощью функции стиль(). Стиль управляет типом маркеров и схемой нумерации, используемых для элементов в списке. Обратите внимание, что списки, использующие десятичную схему нумерации, начинают счёт с 1, а не с 0.
Свойства стиля могут быть настроены для дальнейшей настройки внешнего вида элементов списка; например, свойства ListNumberPrefix и ListNumberSuffix могут быть использованы для настройки чисел, используемых в упорядоченном списке, так что они отображаются как (1), (2), (3) и т. д.:
QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");
cursor.insertList(listFormat); См. также QTextList.
Документация по типам членов
Перечисление QTextListFormat::Стиль
Это перечисление описывает символы, используемые для оформления элементов списка:
| Константа | Значение | Описание |
|---|---|---|
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::отступ() const
Возвращает отступ формата списка. Отступ умножается на свойство QTextDocument::indentWidth, чтобы получить эффективный отступ в пикселях.
См. также установитьОтступ().
bool QTextListFormat::isValid() const
Возвращает true, если этот формат списка корректен; в противном случае возвращает false.
QString QTextListFormat::префикс_номера() const
Возвращает префикс номера формата списка.
См. также установитьПрефиксНомера().
QString QTextListFormat::суффикс_номера() const
Возвращает суффикс номера формата списка.
См. также установитьСуффиксНомера().
void QTextListFormat::установитьОтступ(int отступ)
Устанавливает отступ формата списка. Отступ умножается на свойство QTextDocument::indentWidth, чтобы получить эффективный отступ в пикселях.
См. также отступ().
void QTextListFormat::установитьПрефиксНомера(const QString &префиксНомера)
Устанавливает префикс номера формата списка на строку, указанную параметром префиксНомера. Это может быть использовано со всеми типами упорядоченных списков. Оно не оказывает никакого влияния на неупорядоченные типы списков.
По умолчанию префикс — пустая строка.
См. также префикс_номера().
void QTextListFormat::установитьСуффиксНомера(const QString &суффиксНомера)
Устанавливает суффикс номера формата списка на строку, указанную параметром суффиксНомера. Это может быть использовано со всеми типами упорядоченных списков. Оно не оказывает никакого влияния на неупорядоченные типы списков.
По умолчанию суффикс — «.».
См. также суффикс_номера().
void QTextListFormat::установитьСтиль(QTextListFormat::Стиль style)
Устанавливает стиль формата списка.
QTextListFormat::Стиль QTextListFormat::стиль() const
Возвращает стиль формата списка.
См. также установитьСтиль() и Стиль.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qtextlistformat.html