QTextListFormat

The QTextListFormat class provides formatting information for lists in a QTextDocument . More

Inheritance diagram of PySide2.QtGui.QTextListFormat

Synopsis

Functions

Detailed Description

A list is composed of one or more items, represented as text blocks. The list’s format specifies the appearance of items in the list. In particular, it determines the indentation and the style of each item.

The indentation of the items is an integer value that causes each item to be offset from the left margin by a certain amount. This value is read with indent() and set with setIndent() .

The style used to decorate each item is set with setStyle() and can be read with the style() function. The style controls the type of bullet points and numbering scheme used for items in the list. Note that lists that use the decimal numbering scheme begin counting at 1 rather than 0.

Style properties can be set to further configure the appearance of list items; for example, the ListNumberPrefix and ListNumberSuffix properties can be used to customize the numbers used in an ordered list so that they appear as (1), (2), (3), etc.:

QTextListFormat listFormat;

listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");

cursor.insertList(listFormat);

See also

QTextList

class QTextListFormat

QTextListFormat(fmt)

QTextListFormat(QTextListFormat)

param fmt

QTextFormat

param QTextListFormat

QTextListFormat

Constructs a new list format object.

PySide2.QtGui.QTextListFormat.Style

This enum describes the symbols used to decorate list items:

Constant

Description

QTextListFormat.ListDisc

a filled circle

QTextListFormat.ListCircle

an empty circle

QTextListFormat.ListSquare

a filled square

QTextListFormat.ListDecimal

decimal values in ascending order

QTextListFormat.ListLowerAlpha

lower case Latin characters in alphabetical order

QTextListFormat.ListUpperAlpha

upper case Latin characters in alphabetical order

QTextListFormat.ListLowerRoman

lower case roman numerals (supports up to 4999 items only)

QTextListFormat.ListUpperRoman

upper case roman numerals (supports up to 4999 items only)

PySide2.QtGui.QTextListFormat.indent()
Return type

int

Returns the list format’s indentation. The indentation is multiplied by the indentWidth property to get the effective indent in pixels.

See also

setIndent()

PySide2.QtGui.QTextListFormat.numberPrefix()
Return type

unicode

Returns the list format’s number prefix.

PySide2.QtGui.QTextListFormat.numberSuffix()
Return type

unicode

Returns the list format’s number suffix.

PySide2.QtGui.QTextListFormat.setIndent(indent)
Parameters

indentint

Sets the list format’s indentation . The indentation is multiplied by the indentWidth property to get the effective indent in pixels.

See also

indent()

PySide2.QtGui.QTextListFormat.setNumberPrefix(numberPrefix)
Parameters

numberPrefix – unicode

Sets the list format’s number prefix to the string specified by numberPrefix . This can be used with all sorted list types. It does not have any effect on unsorted list types.

The default prefix is an empty string.

See also

numberPrefix()

PySide2.QtGui.QTextListFormat.setNumberSuffix(numberSuffix)
Parameters

numberSuffix – unicode

Sets the list format’s number suffix to the string specified by numberSuffix . This can be used with all sorted list types. It does not have any effect on unsorted list types.

The default suffix is “.”.

See also

numberSuffix()

PySide2.QtGui.QTextListFormat.setStyle(style)
Parameters

styleStyle

Sets the list format’s style .

See also

style() Style

PySide2.QtGui.QTextListFormat.style()
Return type

Style

Returns the list format’s style.

See also

setStyle() Style