QTextList Class

The QTextList class provides a decorated list of items in a QTextDocument. More...

Header:	#include <QTextList>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake:	QT += gui
Inherits:	QTextBlockGroup

List of all members, including inherited members
QTextList is part of Rich Text Processing APIs.

Note: All functions in this class are reentrant.

Public Functions

void	add(const QTextBlock &block)
int	count() const
QTextListFormat	format() const
QTextBlock	item(int i) const
int	itemNumber(const QTextBlock &block) const
QString	itemText(const QTextBlock &block) const
void	remove(const QTextBlock &block)
void	removeItem(int i)
void	setFormat(const QTextListFormat &format)

Detailed Description

A list contains a sequence of text blocks, each of which is marked with a bullet point or other symbol. Multiple levels of lists can be used, and the automatic numbering feature provides support for ordered numeric and alphabetical lists.

Lists are created by using a text cursor to insert an empty list at the current position or by moving existing text into a new list. The QTextCursor::insertList() function inserts an empty block into the document at the cursor position, and makes it the first item in a list.

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

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

The QTextCursor::createList() function takes the contents of the cursor's current block and turns it into the first item of a new list.

The cursor's current list is found with QTextCursor::currentList().

The number of items in a list is given by count(). Each item can be obtained by its index in the list with the item() function. Similarly, the index of a given item can be found with itemNumber(). The text of each item can be found with the itemText() function.

Note that the items in the list may not be adjacent elements in the document. For example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.

List items can be deleted by index with the removeItem() function. remove() deletes the specified item in the list.

The list's format is set with setFormat() and read with format(). The format describes the decoration of the list itself, and not the individual items.

See also QTextBlock, QTextListFormat, and QTextCursor.

Member Function Documentation

void QTextList::add(const QTextBlock &block)

Makes the given block part of the list.

See also remove() and removeItem().

int QTextList::count() const

Returns the number of items in the list.

QTextListFormat QTextList::format() const

Returns the list's format.

See also setFormat().

QTextBlock QTextList::item(int i) const

Returns the i-th text block in the list.

See also count() and itemText().

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

Returns the index of the list item that corresponds to the given block. Returns -1 if the block was not present in the list.

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

Returns the text of the list item that corresponds to the given block.

void QTextList::remove(const QTextBlock &block)

Removes the given block from the list.

See also add() and removeItem().

void QTextList::removeItem(int i)

Removes the item at item position i from the list. When the last item in the list is removed, the list is automatically deleted by the QTextDocument that owns it.

See also add() and remove().

void QTextList::setFormat(const QTextListFormat &format)

Sets the list's format to format.

See also format().

Contents