PySide6.QtGui.QTextListFormat

class QTextListFormat

QTextListFormat 类为 QTextDocument 中的列表提供格式化信息。更多

PySide6.QtGui.QTextListFormat 的继承图

概要

方法

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题,您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述

警告

本节包含从C++自动翻译到Python的代码片段,可能包含错误。

列表由一个或多个项目组成,表示为文本块。列表的格式指定了列表中项目的外观。特别是,它决定了每个项目的缩进和样式。

项目的缩进是一个整数值,它使每个项目从左边距偏移一定量。这个值通过indent()读取,并通过setIndent()设置。

用于装饰每个项目的样式通过setStyle()设置,并可以通过style()函数读取。该样式控制列表中项目使用的项目符号类型和编号方案。请注意,使用十进制编号方案的列表从1开始计数,而不是0,除非通过setStart()进行了覆盖。

可以设置样式属性以进一步配置列表项的外观;例如,可以使用ListNumberPrefix和ListNumberSuffix属性来自定义有序列表中使用的数字,使其显示为(1)、(2)、(3)等:

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

另请参阅

QTextList

class Style

此枚举描述了用于装饰列表项的符号:

常量

描述

QTextListFormat.ListDisc

一个实心圆

QTextListFormat.ListCircle

一个空心的圆圈

QTextListFormat.ListSquare

一个实心方块

QTextListFormat.ListDecimal

按升序排列的十进制值

QTextListFormat.ListLowerAlpha

按字母顺序排列的小写拉丁字符

QTextListFormat.ListUpperAlpha

按字母顺序排列的大写拉丁字符

QTextListFormat.ListLowerRoman

小写罗马数字(仅支持最多4999个项目)

QTextListFormat.ListUpperRoman

大写罗马数字(仅支持最多4999个项目)

__init__()

构造一个新的列表格式对象。

__init__(fmt)
Parameters:

fmtQTextFormat

indent()
Return type:

整数

返回列表格式的缩进。缩进乘以indentWidth属性以获得以像素为单位的有效缩进。

另请参阅

setIndent()

numberPrefix()
Return type:

字符串

返回列表格式的数字前缀。

另请参阅

setNumberPrefix()

numberSuffix()
Return type:

字符串

返回列表格式的数字后缀。

另请参阅

setNumberSuffix()

setIndent(indent)
Parameters:

缩进 – int

设置列表格式的缩进。缩进值乘以indentWidth属性以获得以像素为单位的有效缩进。

另请参阅

indent()

setNumberPrefix(numberPrefix)
Parameters:

numberPrefix – str

将列表格式的数字前缀设置为由numberPrefix指定的字符串。这可以用于所有排序的列表类型。它对未排序的列表类型没有任何影响。

默认前缀是一个空字符串。

另请参阅

numberPrefix()

setNumberSuffix(numberSuffix)
Parameters:

numberSuffix – str

将列表格式的数字后缀设置为由numberSuffix指定的字符串。这可以用于所有排序的列表类型。它对未排序的列表类型没有任何影响。

默认后缀是“.”。

另请参阅

numberSuffix()

setStart(indent)
Parameters:

缩进 – int

设置列表格式的start索引。

这允许你以非1的索引开始一个列表。这可以用于所有排序的列表类型:例如,如果style()ListLowerAlpha并且start()4,则第一个列表项以“d”开始。它对未排序的列表类型没有任何影响。

默认起始值为 1

另请参阅

start()

setStyle(style)
Parameters:

样式Style

设置列表格式的style

另请参阅

style() Style

start()
Return type:

整数

返回第一个列表项要显示的数字,如果style()ListDecimal,或者用于偏移其他排序列表类型。

另请参阅

setStart()

style()
Return type:

样式

返回列表格式的样式。

另请参阅

setStyle() Style