QTextListFormat¶

Inheritance diagram of QTextListFormat

Synopsis¶

Functions¶

def indent ()
def setIndent (indent)
def setStyle (style)
def style ()

Detailed Description¶

The PySide.QtGui.QTextListFormat class provides formatting information for lists in a PySide.QtGui.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 PySide.QtGui.QTextListFormat.indent() and set with PySide.QtGui.QTextListFormat.setIndent() .

The style used to decorate each item is set with PySide.QtGui.QTextListFormat.setStyle() and can be read with the PySide.QtGui.QTextListFormat.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.

See also

PySide.QtGui.QTextList

class PySide.QtGui.QTextListFormat¶

class PySide.QtGui.QTextListFormat(fmt)

class PySide.QtGui.QTextListFormat(QTextListFormat)

Parameters:	QTextListFormat – `PySide.QtGui.QTextListFormat` fmt – `PySide.QtGui.QTextFormat`

Constructs a new list format object.

Creates a new list format with the same attributes as the given text format.

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

PySide.QtGui.QTextListFormat.indent()¶

Return type:	`PySide.QtCore.int`

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

PySide.QtGui.QTextListFormat.setIndent(indent)¶

Parameters:	indent – `PySide.QtCore.int`

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

See also

PySide.QtGui.QTextListFormat.indent()

PySide.QtGui.QTextListFormat.setStyle(style)¶