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() 向列表项添加工具提示、状态提示和 "这是什么" 帮助。

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

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

可以使用 isHidden() 函数来确定项是否隐藏。要隐藏项,请使用 setHidden() 。

继承#

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

class ItemType#

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

常量

描述

QListWidgetItem.Type

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

QListWidgetItem.UserType

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

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

也可参见

type()

__init__(icon, text[, listview=None[, type=list()]])#
参数列表

使用指定的 type 创建一个空的列表小部件项,并具有给定的 icontextparent。如果没有指定父级,则需要使用 insertItem() 将项插入到列表小部件中。

此构造函数将项插入到构造函数中传入的父级的模型中。如果模型已排序,则插入行为是不确定的,因为模型会调用项的 '<' 操作符方法,但在这一点上,项尚未构造。为了避免不确定的行为,我们建议不要指定父级,并使用 insertItem()

也可参见

type()

__init__([listview=None[, type=list()]])
参数列表

使用给定的 parent 创建一个空的指定 type 的列表小部件项。如果未指定 parent,则该项需要通过 insertItem() 插入到列表小部件中。

此构造函数将项插入到构造函数中传入的父级的模型中。如果模型已排序,则插入行为是不确定的,因为模型会调用项的 '<' 操作符方法,但在这一点上,项尚未构造。为了避免不确定的行为,我们建议不要指定父级,并使用 insertItem()

也可参见

type()

__init__(text[, listview=None[, type=list()]])
参数列表

使用给定的 textparent 创建一个空的指定 type 的列表小部件项。如果未指定父项,则该项需通过 insertItem() 插入到列表小部件中。

此构造函数将项插入到构造函数中传入的父级的模型中。如果模型已排序,则插入行为是不确定的,因为模型会调用项的 '<' 操作符方法,但在这一点上,项尚未构造。为了避免不确定的行为,我们建议不要指定父级,并使用 insertItem()

也可参见

type()

__init__(other)
参数列表

otherQListWidgetItem

创建 other 的副本。注意,type()listWidget() 不会复制。

当重新实现 clone() 时,此功能很有用。

也可参见

data() flags()

background()#
返回类型::

QBrush

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

checkState()#
返回类型::

检查状态

返回列表项的选中状态(请参阅 Qt::CheckState)。

也可参见

setCheckState() flags()

clone()#
返回类型::

QListWidgetItem

创建项目的精确副本。

data(role)#
参数列表

role – int

返回类型::

对象

返回指定 role 的项目数据。需要更多角色或特定角色的特殊行为时,请重新实现此函数。

也可参见

setData()

flags()#
返回类型::

ItemFlag 的组合

返回此项目的项目标志(见 Qt::ItemFlags)。

也可参见

setFlags()

font()#
返回类型::

QFont

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

也可参见

setFont()

foreground()#
返回类型::

QBrush

返回用于显示列表项目前景(例如文本)的画刷。

icon()#
返回类型::

QIcon

返回列表项的图标。

也可参见

setIcon() iconSize

isHidden()#
返回类型::

bool

如果项目被隐藏,则返回 true;否则返回 false

也可参见

setHidden()

isSelected()#
返回类型::

bool

如果项目被选中,则返回 true;否则返回 false

也可参见

setSelected()

listWidget()#
返回类型::

QListWidget

返回包含项目的列表窗口。

__lt__(other)#
参数列表

otherQListWidgetItem

返回类型::

bool

如果此项目的文本小于 other 项目的文本,则返回 true;否则返回 false

read(in)#
参数列表

inQDataStream

从流 in 中读取项。

也可参见

write()

setBackground(brush)#
参数列表

brushQBrush

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

setCheckState(state)#
参数列表

stateCheckState

将列表项的复选状态设置为 state

也可参见

checkState()

setData(role, value)#
参数列表
  • role – int

  • value – 对象

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

备注

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

也可参见

data()

setFlags(flags)#
参数列表

flagsItemFlag 的组合

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

也可参见

flags() ItemFlags

setFont(font)#
参数列表

fontQFont

将用于绘制项的字体设置为给定的 font

也可参见

font()

setForeground(brush)#
参数列表

brushQBrush

将列表项的前景色设置为指定的 brush。设置默认构造的画刷将使视图使用样式中的默认颜色。

setHidden(hide)#
参数列表

hide – bool

如果 hide 为真,则隐藏项目;否则显示项目。

也可参见

isHidden()

setIcon(icon)#
参数列表

iconQIcon

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

也可参见

icon() text() iconSize

setSelected(select)#
参数列表

select – bool

将项目的选择状态设置为 select

也可参见

isSelected()

setSizeHint(size)#
参数列表

sizeQSize

将列表项的大小提示设置为 size。如果没有设置大小提示或 size 无效,则项目代理将根据项目数据计算大小提示。

也可参见

sizeHint()

setStatusTip(statusTip)#
参数列表

statusTip – str

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

setText(text)#
参数列表

text – str

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

也可参见

text()

setTextAlignment(alignment)#
参数列表

alignmentAlignmentFlag 的组合

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

setTextAlignment(alignment)
参数列表

alignmentAlignmentFlag

setTextAlignment(alignment)
参数列表

alignment – int

备注

此函数已弃用。

使用接受 Qt::Alignment 参数的重载版本。

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

也可参见

textAlignment() Alignment

setToolTip(toolTip)#
参数列表

toolTip – str

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

setWhatsThis(whatsThis)#
参数列表

whatsThis – str

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

大小提示()#
返回类型::

QSize

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

也可参见

set上火提示()

状态提示()#
返回类型::

字符串

返回列表项的状态提示。

文本()#
返回类型::

字符串

返回列表项的文本。

也可参见

setText()

文本对齐()#
返回类型::

整数

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

备注

此函数返回一个整数是出于历史原因。在Qt 7中,它将被更改为返回Qt::Alignment。

也可参见

对齐

工具提示()#
返回类型::

字符串

返回列表项的工具提示。

类型()#
返回类型::

整数

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

这是什么?()#
返回类型::

字符串

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

write(out)#
参数列表

outQDataStream

将项写入流out

也可参见

read()