QListWidgetItem 类

QListWidgetItem 类提供项为用于 QListWidget 项视图类。 更多...

头: #include <QListWidgetItem>
CMake: find_package(Qt6 REQUIRED COMPONENTS Widgets)
target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: QT += widgets

公共类型

enum ItemType { Type, UserType }

公共函数

QListWidgetItem (QListWidget * parent = nullptr, int type = Type)
QListWidgetItem (const QString & text , QListWidget * parent = nullptr, int type = Type)
QListWidgetItem (const QIcon & icon , const QString & text , QListWidget * parent = nullptr, int type = Type)
QListWidgetItem (const QListWidgetItem & other )
virtual ~QListWidgetItem ()
QBrush background () const
Qt::CheckState checkState () const
virtual QListWidgetItem * clone () const
virtual QVariant data (int role ) const
Qt::ItemFlags flags () const
QFont font () const
QBrush foreground () const
QIcon icon () const
bool isHidden () const
bool isSelected () const
QListWidget * listWidget () const
virtual void read (QDataStream & in )
void setBackground (const QBrush & brush )
void setCheckState (Qt::CheckState state )
virtual void setData (int role , const QVariant & value )
void setFlags (Qt::ItemFlags flags )
void setFont (const QFont & font )
void setForeground (const QBrush & brush )
void setHidden (bool hide )
void setIcon (const QIcon & icon )
void setSelected (bool select )
void setSizeHint (const QSize & size )
void setStatusTip (const QString & statusTip )
void setText (const QString & text )
(从 6.4 起) void setTextAlignment (Qt::Alignment alignment )
void setToolTip (const QString & toolTip )
void setWhatsThis (const QString & whatsThis )
QSize sizeHint () const
QString statusTip () const
QString text () const
int textAlignment () const
QString toolTip () const
int type () const
QString whatsThis () const
virtual void write (QDataStream & out ) const
virtual bool operator< (const QListWidgetItem & other ) const
QListWidgetItem & operator= (const QListWidgetItem & other )
QDataStream & operator<< (QDataStream & out , const QListWidgetItem & item )
QDataStream & operator>> (QDataStream & in , QListWidgetItem & item )

详细描述

QListWidgetItem 表示单项在 QListWidget 。每个项可以保持几条信息,并将适当显示它们。

项视图方便类使用基于项的经典接口,而不是纯模型/视图方式。对于更灵活列表视图 Widget,考虑使用 QListView 类采用标准模型。

可以将列表项自动插入列表当构建它们时,通过指定列表 Widget:

    new QListWidgetItem(tr("Hazel"), listWidget);
					

另外,也可以创建列表项不采用父级 Widget,然后插入列表使用 QListWidget::insertItem ().

列表项通常用于显示 text () 和 icon ()。设置这些采用 setText () 和 setIcon () 函数。可以定制文本的外观采用 setFont (), setForeground (),和 setBackground (). Text in list items can be aligned using the setTextAlignment() function. Tooltips, status tips and "What's This?" help can be added to list items with setToolTip (), setStatusTip (),和 setWhatsThis ().

默认情况下,项目被启用、可选择、可检查,且可以是拖放操作的源。

可以改变每项的标志通过调用 setFlags () 采用适当值 (见 Qt::ItemFlags )。可复选项可以被复选、取消复选和部分复选采用 setCheckState () 函数。相应 checkState () 函数指示项的当前复选状态。

The isHidden () 函数可以用于确定项是否被隐藏。要隐藏项,使用 setHidden ().

子类化

当子类化 QListWidgetItem 以提供自定义项时,为它们定义新类型使之区分于标准项是可能的。对于要求此特征的子类,确保调用基类构造函数采用新类型值等于或大于 UserType ,在 your 构造函数。

另请参阅 QListWidget , 模型/视图编程 , QTreeWidgetItem ,和 QTableWidgetItem .

成员类型文档编制

enum QListWidgetItem:: ItemType

此枚举描述用于描述列表 Widget 项的类型。

常量 描述
QListWidgetItem::Type 0 列表 Widget 项的默认类型。
QListWidgetItem::UserType 1000 用于自定义类型的最小值。低于 UserType 的值由 Qt 预留。

可以定义新用户类型在 QListWidgetItem 子类以确保自定义项被特殊对待。

另请参阅 type ().

成员函数文档编制

[explicit] QListWidgetItem:: QListWidgetItem ( QListWidget * parent = nullptr, int type = Type)

构造空列表 Widget 项为指定 type 采用给定 parent 。若 parent 未指定,则需要将项插入列表 Widget 采用 QListWidget::insertItem ().

此构造函数将项插入被传递给构造函数的父级模型。若模型有排序,则插入行为不确定,由于模型将调用 '<' 运算符方法,此时项尚未被构造。为避免不确定行为,推荐不指定父级和使用 QListWidget::insertItem () 代替。

另请参阅 type ().

[explicit] QListWidgetItem:: QListWidgetItem (const QString & text , QListWidget * parent = nullptr, int type = Type)

构造空列表 Widget 项为指定 type 采用给定 text and parent 。若父级未指定,则需要将项插入列表 Widget 采用 QListWidget::insertItem ().

此构造函数将项插入被传递给构造函数的父级模型。若模型有排序,则插入行为不确定,由于模型将调用 '<' 运算符方法,此时项尚未被构造。为避免不确定行为,推荐不指定父级和使用 QListWidget::insertItem () 代替。

另请参阅 type ().

[explicit] QListWidgetItem:: QListWidgetItem (const QIcon & icon , const QString & text , QListWidget * parent = nullptr, int type = Type)

构造空列表 Widget 项为指定 type 采用给定 icon , text and parent 。若父级未指定,则需要将项插入列表 Widget 采用 QListWidget::insertItem ().

此构造函数将项插入被传递给构造函数的父级模型。若模型有排序,则插入行为不确定,由于模型将调用 '<' 运算符方法,此时项尚未被构造。为避免不确定行为,推荐不指定父级和使用 QListWidget::insertItem () 代替。

另请参阅 type ().

QListWidgetItem:: QListWidgetItem (const QListWidgetItem & other )

构造副本为 other 。注意, type () 和 listWidget () 不拷贝。

此函数是有用的,当重实现 clone ().

另请参阅 data () 和 flags ().

[virtual noexcept] QListWidgetItem:: ~QListWidgetItem ()

销毁列表项。

QBrush QListWidgetItem:: background () const

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

另请参阅 setBackground () 和 foreground ().

Qt::CheckState QListWidgetItem:: checkState () const

返回列表项的复选状态 (见 Qt::CheckState ).

另请参阅 setCheckState () 和 flags ().

[虚拟] QListWidgetItem *QListWidgetItem:: clone () const

创建项的准确副本。

[虚拟] QVariant QListWidgetItem:: data ( int role ) const

返回项的数据为给定 role 。重实现此函数若需要额外角色或某些角色的特殊行为。

另请参阅 Qt::ItemDataRole and setData ().

Qt::ItemFlags QListWidgetItem:: flags () const

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

另请参阅 setFlags ().

QFont QListWidgetItem:: font () const

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

另请参阅 setFont ().

QBrush QListWidgetItem:: foreground () const

返回用于显示列表项前景 (如:文本) 的笔刷。

另请参阅 setForeground () 和 background ().

QIcon QListWidgetItem:: icon () const

返回列表项的图标。

另请参阅 setIcon () 和 iconSize .

bool QListWidgetItem:: isHidden () const

返回 true 若项被隐藏; 否则返回 false .

另请参阅 setHidden ().

bool QListWidgetItem:: isSelected () const

返回 true 若项被选中; 否则返回 false .

另请参阅 setSelected ().

QListWidget *QListWidgetItem:: listWidget () const

返回包含项的列表 Widget。

[虚拟] void QListWidgetItem:: read ( QDataStream & in )

读取项从流 in .

另请参阅 write ().

void QListWidgetItem:: setBackground (const QBrush & brush )

将列表项的背景笔刷设为给定 brush 。设置默认构造的笔刷将使视图使用来自样式的默认颜色。

另请参阅 background () 和 setForeground ().

void QListWidgetItem:: setCheckState ( Qt::CheckState state )

将列表项的校验状态设为 state .

另请参阅 checkState ().

[虚拟] void QListWidgetItem:: setData ( int role , const QVariant & value )

设置数据为给定 role 到给定 value 。重实现此函数若需要额外角色或某些角色的特殊行为。

注意: 默认实现视 Qt::EditRole and Qt::DisplayRole 为引用相同数据。

另请参阅 Qt::ItemDataRole and data ().

void QListWidgetItem:: setFlags ( Qt::ItemFlags flags )

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

另请参阅 flags () 和 Qt::ItemFlags .

void QListWidgetItem:: setFont (const QFont & font )

将描绘项时使用的字体设为给定 font .

另请参阅 font ().

void QListWidgetItem:: setForeground (const QBrush & brush )

将列表项的前景笔刷设为给定 brush 。设置默认构造的笔刷将使视图使用来自样式的默认颜色。

另请参阅 foreground () 和 setBackground ().

void QListWidgetItem:: setHidden ( bool hide )

隐藏项若 hide 为 true;否则展示项。

另请参阅 isHidden ().

void QListWidgetItem:: setIcon (const QIcon & icon )

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

另请参阅 icon (), text (),和 iconSize .

void QListWidgetItem:: setSelected ( bool select )

将项的选定状态设为 select .

另请参阅 isSelected ().

void QListWidgetItem:: setSizeHint (const QSize & size )

将列表项的大小提示设为 size 。若未设置大小提示或 size 无效,项委托将基于项数据计算大小提示。

另请参阅 sizeHint ().

void QListWidgetItem:: setStatusTip (const QString & statusTip )

将列表项的状态提示设为文本指定通过 statusTip . QListWidget 鼠标追踪需要启用为使此特征能工作。

另请参阅 statusTip (), setToolTip (), setWhatsThis (),和 QWidget::setMouseTracking ().

void QListWidgetItem:: setText (const QString & text )

把列表 Widget 项的文本,设为给定 text .

另请参阅 text ().

[since 6.4] void QListWidgetItem:: setTextAlignment ( Qt::Alignment alignment )

把列表项的文本对齐方式,设为 alignment .

该函数在 Qt 6.4 引入。

void QListWidgetItem:: setToolTip (const QString & toolTip )

将列表项工具提示设为指定文本通过 toolTip .

另请参阅 toolTip (), setStatusTip (),和 setWhatsThis ().

void QListWidgetItem:: setWhatsThis (const QString & whatsThis )

将列表项 What's This? 帮助设为指定文本通过 whatsThis .

另请参阅 whatsThis (), setStatusTip (),和 setToolTip ().

QSize QListWidgetItem:: sizeHint () const

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

另请参阅 setSizeHint ().

QString QListWidgetItem:: statusTip () const

返回列表项的状态提示。

另请参阅 setStatusTip ().

QString QListWidgetItem:: text () const

返回列表项的文本。

另请参阅 setText ().

int QListWidgetItem:: textAlignment () const

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

注意: This function returns an int for historical reasons. It will be corrected to return Qt::Alignment in Qt 7.

另请参阅 Qt::Alignment .

QString QListWidgetItem:: toolTip () const

返回列表项的工具提示。

另请参阅 setToolTip (), statusTip (),和 whatsThis ().

int QListWidgetItem:: type () const

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

QString QListWidgetItem:: whatsThis () const

返回列表项的 What's This? 帮助文本。

另请参阅 setWhatsThis (), statusTip (),和 toolTip ().

[虚拟] void QListWidgetItem:: write ( QDataStream & out ) const

把项写入流 out .

另请参阅 read ().

[虚拟] bool QListWidgetItem:: operator< (const QListWidgetItem & other ) const

返回 true 若此项的文本小于 other 项的文本;否则返回 false .

QListWidgetItem &QListWidgetItem:: operator= (const QListWidgetItem & other )

赋值 other 的数据和标志到此项。注意 type () 和 listWidget () 不拷贝。

此函数是有用的,当重实现 clone ().

另请参阅 data () 和 flags ().

相关非成员

QDataStream & operator<< ( QDataStream & out , const QListWidgetItem & item )

写列表 Widget 项 item 到流 out .

此操作符使用 QListWidgetItem::write ().

另请参阅 序列化 Qt 数据类型 .

QDataStream & operator>> ( QDataStream & in , QListWidgetItem & item )

读取列表 Widget 项从流 in into item .

此操作符使用 QListWidgetItem::read ().

另请参阅 序列化 Qt 数据类型 .