PySide6.QtWidgets.QListWidgetItem

class QListWidgetItem

QListWidgetItem 类提供了一个用于 QListWidget 项目视图类的项目。更多…

概要

方法

虚拟方法

注意

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

详细描述

警告

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

一个 QListWidgetItem 代表 QListWidget 中的一个单独项。每个项可以包含多条信息，并将适当地显示它们。

项目视图便利类使用经典的项目基础接口，而不是纯粹的模型/视图方法。对于更灵活的列表视图小部件，考虑使用带有标准模型的QListView类。

当列表项被构造时，可以通过指定列表小部件自动插入到列表中：

QListWidgetItem(tr("Hazel"), listWidget)

或者，列表项也可以在没有父部件的情况下创建，然后使用insertItem()插入到列表中。

列表项通常用于显示text()和icon()。这些可以通过setText()和setIcon()函数来设置。文本的外观可以通过setFont()、setForeground()和setBackground()来自定义。列表项中的文本可以使用setTextAlignment()函数进行对齐。工具提示、状态提示和“这是什么？”帮助可以通过setToolTip()、setStatusTip()和setWhatsThis()添加到列表项中。

默认情况下，项目是启用的、可选择的、可勾选的，并且可以作为拖放操作的源。

每个项目的标志可以通过调用setFlags()并传入适当的值来更改（参见Qt::ItemFlags）。可勾选的项目可以使用setCheckState()函数进行勾选、取消勾选和部分勾选。相应的checkState()函数指示项目的当前勾选状态。

isHidden() 函数可用于确定项目是否隐藏。要隐藏项目，请使用 setHidden() 。

子类化

当子类化QListWidgetItem以提供自定义项时，可以为它们定义新类型，使它们能够与标准项区分开来。对于需要此功能的子类，请确保在您的构造函数中调用基类构造函数，并使用等于或大于UserType的新类型值。

class ItemType

(继承自 enum.IntEnum) 此枚举描述了用于描述列表小部件项的类型。

常量

描述

QListWidgetItem.Type

列表小部件项的默认类型。

QListWidgetItem.UserType

自定义类型的最小值。低于UserType的值由Qt保留。

您可以在QListWidgetItem子类中定义新的用户类型，以确保自定义项目得到特殊处理。

另请参阅

type()

__init__(other)
Parameters:

其他 – QListWidgetItem

构造一个other的副本。请注意，type()和listWidget()不会被复制。

这个函数在重新实现clone()时非常有用。

另请参阅

data() flags()

__init__([listview=None[, type=list()]])
Parameters:

构造一个指定type的空列表小部件项，并带有给定的parent。如果未指定parent，则需要使用insertItem()将该项插入到列表小部件中。

此构造函数将项目插入到传递给构造函数的父模型中。如果模型已排序，则插入行为将不确定，因为模型将调用项目上的'<'运算符方法，而此时项目尚未构建。为了避免不确定的行为，我们建议不要指定父模型，而是使用insertItem()。

另请参阅

type()

__init__(text[, listview=None[, type=list()]])
Parameters:

构造一个指定type的空列表小部件项，带有给定的text和parent。如果未指定父项，则需要使用insertItem()将该项插入到列表小部件中。

此构造函数将项目插入传递给构造函数的父模型中。如果模型已排序，则插入行为将不确定，因为模型将调用项目上的'<'运算符方法，而此时项目尚未构建。为了避免不确定的行为，我们建议不要指定父模型，而是使用insertItem()。

另请参阅

type()

__init__(icon, text[, listview=None[, type=list()]])
Parameters:

构造一个指定type的空列表小部件项，带有给定的icon、text和parent。如果未指定父项，则需要使用insertItem()将该项插入到列表小部件中。

此构造函数将项目插入传递给构造函数的父模型中。如果模型已排序，则插入行为将不确定，因为模型将调用项目上的'<'运算符方法，而此时项目尚未构建。为了避免不确定的行为，我们建议不要指定父模型，而是使用insertItem()。

另请参阅

type()

background()
Return type:

QBrush

返回用于显示列表项背景的画笔。

checkState()
Return type:

CheckState

返回列表项的选中状态（参见 Qt::CheckState）。

另请参阅

setCheckState() flags()

clone()
Return type:

QListWidgetItem

创建项目的精确副本。

data(role)
Parameters:

角色 – int

Return type:

对象

返回给定role的项目数据。如果您需要额外的角色或某些角色的特殊行为，请重新实现此函数。

另请参阅

setData()

flags()
Return type:

ItemFlag的组合

返回此项目的项目标志（参见 Qt::ItemFlags）。

另请参阅

setFlags()

font()
Return type:

QFont

返回用于显示此列表项文本的字体。

另请参阅

setFont()

foreground()
Return type:

QBrush

返回用于显示列表项前景（例如文本）的画笔。

icon()
Return type:

QIcon

返回列表项的图标。

另请参阅

setIcon() iconSize

isHidden()
Return type:

布尔

如果项目被隐藏，则返回 true；否则返回 false。

另请参阅

setHidden()

isSelected()
Return type:

布尔

如果项目被选中，则返回true；否则返回false。

另请参阅

setSelected()

listWidget()
Return type:

QListWidget

返回包含项目的列表小部件。

__lt__(other)
Parameters:

其他 – QListWidgetItem

Return type:

布尔

如果此项目的文本小于other项目的文本，则返回true；否则返回false。

read(in)
Parameters:

in – QDataStream

从流 in 中读取项目。

另请参阅

write()

setBackground(brush)
Parameters:

画笔 – QBrush

将列表项的背景画笔设置为给定的brush。设置一个默认构造的画笔将让视图使用样式中的默认颜色。

setCheckState(state)
Parameters:

状态 – CheckState

将列表项的检查状态设置为 state。

另请参阅

checkState()

setData(role, value)
Parameters:

  • role – int

  • value – 对象

将给定role的数据设置为给定value。如果您需要额外的角色或某些角色的特殊行为，请重新实现此函数。

注意

默认实现将Qt::EditRole和Qt::DisplayRole视为引用相同的数据。

另请参阅

data()

setFlags(flags)
Parameters:

flags – ItemFlag 的组合

将列表项的项标志设置为 flags。

另请参阅

flags() ItemFlags

setFont(font)
Parameters:

字体 – QFont

设置绘制项目时使用的字体为给定的 font。

另请参阅

font()

setForeground(brush)
Parameters:

画笔 – QBrush

将列表项的前景画笔设置为给定的 brush。设置一个默认构造的画笔将让视图使用样式中的默认颜色。

setHidden(hide)
Parameters:

hide – 布尔值

如果 hide 为真，则隐藏该项目；否则显示该项目。

另请参阅

isHidden()

setIcon(icon)
Parameters:

图标 – QIcon

将列表项的图标设置为给定的 icon。

另请参阅

icon() text() iconSize

setSelected(select)
Parameters:

select – 布尔值

将项目的选定状态设置为select。

另请参阅

isSelected()

setSizeHint(size)
Parameters:

大小 – QSize

将列表项的大小提示设置为size。如果未设置大小提示或size无效，则项目委托将根据项目数据计算大小提示。

另请参阅

sizeHint()

setStatusTip(statusTip)
Parameters:

statusTip – str

将列表项的状态提示设置为由statusTip指定的文本。QListWidget需要启用鼠标跟踪功能才能使此功能正常工作。

setText(text)
Parameters:

文本 – str

将列表小部件项的文本设置为给定的 text。

另请参阅

text()

setTextAlignment(alignment)
Parameters:

alignment – AlignmentFlag 的组合

将列表项的文本对齐方式设置为 alignment。

另请参阅

textAlignment()

setTextAlignment(alignment)
Parameters:

对齐方式 – AlignmentFlag

setTextAlignment(alignment)
Parameters:

alignment – int

注意

此函数已弃用。

使用带有Qt::Alignment参数的函数重载。

将列表项的文本对齐方式设置为 alignment。

另请参阅

Alignment

setToolTip(toolTip)
Parameters:

toolTip – str

将列表项的工具提示设置为由toolTip指定的文本。

setWhatsThis(whatsThis)
Parameters:

whatsThis – str

将列表项的“这是什么？”帮助设置为由whatsThis指定的文本。

sizeHint()
Return type:

QSize

返回为列表项设置的大小提示。

另请参阅

setSizeHint()

statusTip()
Return type:

字符串

返回列表项的状态提示。

另请参阅

setStatusTip()

text()
Return type:

字符串

返回列表项的文本。

另请参阅

setText()

textAlignment()
Return type:

整数

返回列表项的文本对齐方式。

注意

由于历史原因，此函数返回一个 int。它将在 Qt 7 中修正为返回 Qt::Alignment。

另请参阅

setTextAlignment() Alignment

toolTip()
Return type:

字符串

返回列表项的工具提示。

type()
Return type:

整数

返回传递给QListWidgetItem构造函数的类型。

whatsThis()
Return type:

字符串

返回列表项的“这是什么？”帮助文本。

write(out)
Parameters:

输出 – QDataStream

将项目写入流 out。

另请参阅

read()