QTextListFormat Class

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

Header:	#include <QTextListFormat>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake:	QT += gui
Inherits:	QTextFormat

List of all members, including inherited members
QTextListFormat is part of Rich Text Processing APIs and Implicitly Shared Classes.

Note: All functions in this class are reentrant.

Public Types

enum	Style { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman }

Public Functions

	QTextListFormat()
int	indent() const
bool	isValid() const
QString	numberPrefix() const
QString	numberSuffix() const
void	setIndent(int indentation)
void	setNumberPrefix(const QString &numberPrefix)
void	setNumberSuffix(const QString &numberSuffix)
`(since 6.6)` void	setStart(int start)
void	setStyle(QTextListFormat::Style style)
`(since 6.6)` int	start() const
QTextListFormat::Style	style() const

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

 QTextListFormat listFormat;

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

 cursor.insertList(listFormat);

See also QTextList.

Member Type Documentation

enum QTextListFormat::Style

This enum describes the symbols used to decorate list items:

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

Member Function Documentation

QTextListFormat::QTextListFormat()

Constructs a new list format object.

int QTextListFormat::indent() const

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

See also setIndent().

bool QTextListFormat::isValid() const

Returns true if this list format is valid; otherwise returns false.

QString QTextListFormat::numberPrefix() const

Returns the list format's number prefix.

See also setNumberPrefix().

QString QTextListFormat::numberSuffix() const

Returns the list format's number suffix.

See also setNumberSuffix().

void QTextListFormat::setIndent(int indentation)

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

See also indent().

void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

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

void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

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

`[since 6.6]` void QTextListFormat::setStart(int start)

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

This function was introduced in Qt 6.6.

See also start().

void QTextListFormat::setStyle(QTextListFormat::Style style)

Sets the list format's style.

See also style() and Style.

`[since 6.6]` int QTextListFormat::start() const

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