QTextListFormat¶

PyQt5.QtGui.QTextListFormat: Inherits from QTextFormat.

Description¶

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

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);

Enums¶

Style

This enum describes the symbols used to decorate list items:

Member	Value	Description
ListCircle	-2	an empty circle
ListDecimal	-4	decimal values in ascending order
ListDisc	-1	a filled circle
ListLowerAlpha	-5	lower case Latin characters in alphabetical order
ListLowerRoman	-7	lower case roman numerals (supports up to 4999 items only)
ListSquare	-3	a filled square
ListUpperAlpha	-6	upper case Latin characters in alphabetical order
ListUpperRoman	-8	upper case roman numerals (supports up to 4999 items only)

Methods¶

__init__(): TODO

__init__(QTextListFormat): TODO

indent() → int: See also

setIndent().

isValid() → bool: TODO

numberPrefix() → str: See also

setNumberPrefix().

numberSuffix() → str: See also

setNumberSuffix().

setIndent(int): See also

indent().

setNumberPrefix(str): See also

numberPrefix().

setNumberSuffix(str): See also

numberSuffix().

setStyle(Style): See also

style().

style() → Style: See also

setStyle().