QTextList类

QTextList类提供了一个QTextDocument中的项目装饰列表。更多...

头文件	#include <QTextList>
CMake	find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake	QT += gui
继承	QTextBlockGroup

所有成员的列表，包括继承的成员
QTextList是富文本处理API的一部分。

注意：本类中所有函数均可重入。

公共函数

void	add(const QTextBlock &block)
int	count() const
QTextListFormat	format() const
QTextBlock	item(int i) const
int	itemNumber(const QTextBlock &block) const
QString	itemText(const QTextBlock &block) const
void	remove(const QTextBlock &block)
void	removeItem(int i)
void	setFormat(const QTextListFormat &format)

详细说明

列表包含一系列文本块，每个块都带有项目符号或其他符号。可以使用多个层次的列表，自动编号功能提供了支持有序数字和字母列表的功能。

列表是通过使用文本光标在当前位置插入空列表或者将现有文本移动到新列表中来创建的。函数 QTextCursor::insertList() 在光标位置将空块插入到文档中，并将其作为列表的第一个项。

    QTextListFormat listFormat;
    if (list) {
        listFormat = list->format();
        listFormat.setIndent(listFormat.indent() + 1);
    }

    listFormat.setStyle(QTextListFormat::ListDisc);
    cursor.insertList(listFormat);

函数 QTextCursor::createList() 将光标当前块的文本内容转换为新列表的第一个项。

使用 QTextCursor::currentList() 可以找到光标的当前列表。

列表中的项目数量由 count() 指定。可以通过其列表中的索引使用函数 item() 获取每个项。类似地，可以使用函数 itemNumber() 找到给定项的索引。可以通过函数 itemText() 找到每个项的文本。

请注意，列表中的项目可能不是文档中的相邻元素。例如，多级列表中的顶级项目将由列表较低级别的项目分隔。

可以使用 removeItem() 函数按索引删除列表项目。 remove() 删除列表中指定的项目。

列表的格式通过 setFormat() 设置，通过 format() 读取。格式描述的是列表本身的装饰，而不是各个项目。

另请参阅 QTextBlock、QTextListFormat 和 QTextCursor。

成员函数文档

void QTextList::add(const QTextBlock &block)

使给定的 block 成为列表的一部分。

另请参阅 remove() 和 removeItem()。

int QTextList::count() const

返回列表中的项目数。

QTextListFormat QTextList::format() const

返回列表的格式。

另请参阅 setFormat()。

QTextBlock QTextList::item(int i) const

返回列表中的第 i 个文本块。

另请参阅 count() 和 itemText()。

int QTextList::itemNumber(const QTextBlock &block) const

返回与给定 block 对应的列表项目的索引。如果块不在列表中，则返回 -1。

QString QTextList::itemText(const QTextBlock &block) const

返回与给定 block 对应的列表项目的文本。

void QTextList::remove(const QTextBlock &block)

从列表中删除给定的 block。

另请参阅 add() 和 removeItem()。

void QTextList::removeItem(int i)

从列表中删除位于项目位置 i 的项目。当删除列表中的最后项目时，拥有它的 QTextDocument 会自动删除该列表。

另请参阅 add() 和 remove()。

void QTextList::setFormat(const QTextListFormat &format)

将列表的格式设置为 format。

另请参阅 format()。