QListWidgetItem¶

The QListWidgetItem class provides an item for use with the QListWidget item view class. More…

Synopsis¶

Functions¶

def background ()
def checkState ()
def flags ()
def font ()
def foreground ()
def icon ()
def isHidden ()
def isSelected ()
def listWidget ()
def setBackground (brush)
def setCheckState (state)
def setFlags (flags)
def setFont (font)
def setForeground (brush)
def setHidden (hide)
def setIcon (icon)
def setSelected (select)
def setSizeHint (size)
def setStatusTip (statusTip)
def setText (text)
def setTextAlignment (alignment)
def setToolTip (toolTip)
def setWhatsThis (whatsThis)
def sizeHint ()
def statusTip ()
def text ()
def textAlignment ()
def toolTip ()
def type ()
def whatsThis ()

Virtual functions¶

def __lt__ (other)
def clone ()
def data (role)
def read (in)
def setData (role, value)
def write (out)

Detailed Description¶

A QListWidgetItem represents a single item in a QListWidget . Each item can hold several pieces of information, and will display them appropriately.

The item view convenience classes use a classic item-based interface rather than a pure model/view approach. For a more flexible list view widget, consider using the QListView class with a standard model.

List items can be inserted automatically into a list, when they are constructed, by specifying the list widget:

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

Alternatively, list items can also be created without a parent widget, and later inserted into a list using insertItem() .

List items are typically used to display and an . These are set with the and functions. The appearance of the text can be customized with , , and . Text in list items can be aligned using the function. Tooltips, status tips and “What’s This?” help can be added to list items with , , and .

By default, items are enabled, selectable, checkable, and can be the source of drag and drop operations.

Each item’s flags can be changed by calling with the appropriate value (see ItemFlags ). Checkable items can be checked, unchecked and partially checked with the function. The corresponding function indicates the item’s current check state.

The function can be used to determine whether the item is hidden. To hide an item, use .

Subclassing¶

When subclassing QListWidgetItem to provide custom items, it is possible to define new types for them enabling them to be distinguished from standard items. For subclasses that require this feature, ensure that you call the base class constructor with a new type value equal to or greater than UserType , within your constructor.

See also

QListWidget Model/View Programming QTreeWidgetItem QTableWidgetItem

class PySide6.QtWidgets.QListWidgetItem([listview=None[, type=Type]])¶

PySide6.QtWidgets.QListWidgetItem(icon, text[, listview=None[, type=Type]])

PySide6.QtWidgets.QListWidgetItem(other)

PySide6.QtWidgets.QListWidgetItem(text[, listview=None[, type=Type]])

Parameters

icon – PySide6.QtGui.QIcon
other – PySide6.QtWidgets.QListWidgetItem
text – str
listview – PySide6.QtWidgets.QListWidget
type – int

Constructs a copy of other. Note that and are not copied.

This function is useful when reimplementing clone() .

See also

data() flags()

PySide6.QtWidgets.QListWidgetItem.ItemType¶

This enum describes the types that are used to describe list widget items.

Constant

Description

QListWidgetItem.Type

The default type for list widget items.

QListWidgetItem.UserType

The minimum value for custom types. Values below are reserved by Qt.

You can define new user types in QListWidgetItem subclasses to ensure that custom items are treated specially.

See also

type()

PySide6.QtWidgets.QListWidgetItem.background()¶

Return type: PySide6.QtGui.QBrush

PySide6.QtWidgets.QListWidgetItem.checkState()¶

Return type: CheckState

PySide6.QtWidgets.QListWidgetItem.clone()¶

Return type: PySide6.QtWidgets.QListWidgetItem

Creates an exact copy of the item.

PySide6.QtWidgets.QListWidgetItem.data(role)¶

Parameters: role – int
Return type: object

Returns the item’s data for a given role. Reimplement this function if you need extra roles or special behavior for certain roles.

See also

ItemDataRole setData()

PySide6.QtWidgets.QListWidgetItem.flags()¶

Return type: ItemFlags

PySide6.QtWidgets.QListWidgetItem.font()¶

Return type: PySide6.QtGui.QFont

PySide6.QtWidgets.QListWidgetItem.foreground()¶

Return type: PySide6.QtGui.QBrush

PySide6.QtWidgets.QListWidgetItem.icon()¶

Return type: PySide6.QtGui.QIcon

PySide6.QtWidgets.QListWidgetItem.isHidden()¶

Return type: bool

PySide6.QtWidgets.QListWidgetItem.isSelected()¶

Return type: bool

PySide6.QtWidgets.QListWidgetItem.listWidget()¶

Return type: PySide6.QtWidgets.QListWidget

PySide6.QtWidgets.QListWidgetItem.__lt__(other)¶

Parameters: other – PySide6.QtWidgets.QListWidgetItem
Return type: bool

PySide6.QtWidgets.QListWidgetItem.read(in)¶

Parameters: in – PySide6.QtCore.QDataStream

Reads the item from stream in.

See also

write()

PySide6.QtWidgets.QListWidgetItem.setBackground(brush)¶

Parameters: brush – PySide6.QtGui.QBrush

PySide6.QtWidgets.QListWidgetItem.setCheckState(state)¶

Parameters: state – CheckState

PySide6.QtWidgets.QListWidgetItem.setData(role, value)¶

Parameters

role – int
value – object

Sets the data for a given role to the given value. Reimplement this function if you need extra roles or special behavior for certain roles.

Note

The default implementation treats EditRole and DisplayRole as referring to the same data.

Qt Documentation

Table of Contents

Previous topic

Next topic

QListWidgetItem¶

Synopsis¶

Functions¶

Virtual functions¶

Detailed Description¶

Subclassing¶

Constant	Description
QListWidgetItem.Type	The default type for list widget items.
QListWidgetItem.UserType	The minimum value for custom types. Values below are reserved by Qt.