Класс QTextList

Класс QTextList предоставляет форматированный список элементов в QTextDocument. Подробнее...

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

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

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

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

Список содержит последовательность текстовых блоков, каждый из которых помечен маркером (например, пулей). Можно использовать несколько уровней списков, а функция автоматической нумерации поддерживает упорядоченные числовые и алфавитные списки.

Списки создаются с помощью курсора текста, вставляя пустой список в текущую позицию или перемещая существующий текст в новый список. Функция QTextCursor::insertList() вставляет пустой блок в документ в позиции курсора и делает его первым элементом списка.

    QTextListFormat listFormat;
    if (list) {
        listFormat = list->format();
        listFormat.setIndent(listFormat.indent() + 1);
    }

    listFormat.setStyle(QTextListFormat::ListDisc);
    cursor.insertList(listFormat);

Функция QTextCursor::createList() берет содержимое текущего блока курсора и превращает его в первый элемент нового списка.

Текущий список курсора определяется с помощью QTextCursor::currentList().

Количество элементов в списке задаётся функцией count(). Каждый элемент можно получить по его индексу в списке с помощью функции item(). Аналогично, индекс заданного элемента можно найти с помощью функции itemNumber(). Текст каждого элемента можно получить с помощью функции itemText().

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

Элементы списка можно удалить по индексу с помощью функции removeItem(). remove() удаляет указанный элемент в списке.

Формат списка устанавливается функцией setFormat() и читается функцией format(). Формат описывает оформление самого списка, а не отдельных элементов.

См. также QTextBlock, QTextListFormat и QTextCursor.

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

void QTextList::add(const QTextBlock &block)

Делает указанный block частью списка.

См. также remove() и removeItem().

int QTextList::count() const

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

QTextListFormat QTextList::format() const

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

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

QTextBlock QTextList::item(int i) const

Возвращает i-й текстовый блок в списке.

См. также count() и itemText().

int QTextList::itemNumber(const QTextBlock &block) const

Возвращает индекс элемента списка, соответствующего заданному block. Возвращает -1, если блок не присутствует в списке.

QString QTextList::itemText(const QTextBlock &block) const

Возвращает текст элемента списка, соответствующего заданному block.

void QTextList::remove(const QTextBlock &block)

Удаляет указанный block из списка.

См. также add() и removeItem().

void QTextList::removeItem(int i)

Удаляет элемент со значением индекса i из списка. При удалении последнего элемента списка, сам список автоматически удаляется QTextDocument, которому он принадлежит.

См. также add() и remove().

void QTextList::setFormat(const QTextListFormat &format)

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

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