QTextListFormat#

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

Synopsis#

Functions#

def indent ()
def numberPrefix ()
def numberSuffix ()
def setIndent (indent)
def setNumberPrefix (numberPrefix)
def setNumberSuffix (numberSuffix)
def setStart (indent)
def setStyle (style)
def start ()
def style ()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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, unless it has been overridden via setStart() .

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

listFormat = QTextListFormat()
listFormat.setStyle(QTextListFormat.ListDecimal)
listFormat.setNumberPrefix("(")
listFormat.setNumberSuffix(")")
cursor.insertList(listFormat)

See also

QTextList

class PySide6.QtGui.QTextListFormat#

PySide6.QtGui.QTextListFormat(fmt)

Parameters:: fmt – PySide6.QtGui.QTextFormat

Constructs a new list format object.

PySide6.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)

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)

PySide6.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()

PySide6.QtGui.QTextListFormat.numberPrefix()#

Return type:: str

Returns the list format’s number prefix.

See also

setNumberPrefix()

PySide6.QtGui.QTextListFormat.numberSuffix()#

Return type:: str

Returns the list format’s number suffix.

See also

setNumberSuffix()

PySide6.QtGui.QTextListFormat.setIndent(indent)#

Parameters:: indent – int

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

See also

indent()

PySide6.QtGui.QTextListFormat.setNumberPrefix(numberPrefix)#

Parameters:: numberPrefix – str

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

PySide6.QtGui.QTextListFormat.setNumberSuffix(numberSuffix)#

Parameters:: numberSuffix – str

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

PySide6.QtGui.QTextListFormat.setStart(indent)#

Parameters:: indent – int

Sets the list format’s start index.

This allows you to start a list with an index other than 1. This can be used with all sorted list types: for example if the style() is ListLowerAlpha and start() is 4, the first list item begins with “d”. It does not have any effect on unsorted list types.

The default start is 1.

See also

start()

PySide6.QtGui.QTextListFormat.setStyle(style)#

Parameters:: style – Style

Sets the list format’s style.

See also

style() Style

PySide6.QtGui.QTextListFormat.start()#

Return type:: int

Returns the number to be shown by the first list item, if the style() is ListDecimal , or to offset other sorted list types.

See also

setStart()

PySide6.QtGui.QTextListFormat.style()#

Return type:: Style

Returns the list format’s style.

See also

setStyle() Style