|  | Home · Overviews · Examples

# QTextList Class Reference
[com.trolltech.qt.gui module]

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

Inherits `QTextBlockGroup`.

## Detailed Description

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

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`.