QTextList

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

Inheritance diagram of PySide6.QtGui.QTextList

Synopsis

Functions

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 insertList() function inserts an empty block into the document at the cursor position, and makes it the first item in a list.

listFormat = QTextListFormat()
if (list) {
    listFormat = list.format()
    listFormat.setIndent(listFormat.indent() + 1)

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

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

class PySide6.QtGui.QTextList(doc)
Parameters

doc – PySide6.QtGui.QTextDocument

PySide6.QtGui.QTextList.add(block)
Parameters

block – PySide6.QtGui.QTextBlock

Makes the given block part of the list.

PySide6.QtGui.QTextList.count()
Return type

int

Returns the number of items in the list.

PySide6.QtGui.QTextList.format()
Return type

PySide6.QtGui.QTextListFormat

Returns the list’s format.

See also

setFormat()

PySide6.QtGui.QTextList.item(i)
Parameters

i – int

Return type

PySide6.QtGui.QTextBlock

Returns the i-th text block in the list.

See also

count() itemText()

PySide6.QtGui.QTextList.itemNumber(arg__1)
Parameters

arg__1 – PySide6.QtGui.QTextBlock

Return type

int

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

PySide6.QtGui.QTextList.itemText(arg__1)
Parameters

arg__1 – PySide6.QtGui.QTextBlock

Return type

str

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

PySide6.QtGui.QTextList.remove(arg__1)
Parameters

arg__1 – PySide6.QtGui.QTextBlock

Removes the given block from the list.

See also

add() removeItem()

PySide6.QtGui.QTextList.removeItem(i)
Parameters

i – int

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() remove()

PySide6.QtGui.QTextList.setFormat(format)
Parameters

format – PySide6.QtGui.QTextListFormat

Sets the list’s format to format.

See also

format()