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:

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 text() and an icon() . These are set with the setText() and setIcon() functions. The appearance of the text can be customized with setFont() , setForeground() , and 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() , and setWhatsThis() .

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 setFlags() with the appropriate value (see ItemFlags ). Checkable items can be checked, unchecked and partially checked with the setCheckState() function. The corresponding checkState() function indicates the item’s current check state.

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

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=list()]])

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

PySide6.QtWidgets.QListWidgetItem(other)

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

Parameters

• icon – PySide6.QtGui.QIcon

• other – PySide6.QtWidgets.QListWidgetItem

• text – str

• listview – PySide6.QtWidgets.QListWidget

• type – int

Constructs an empty list widget item of the specified type with the given parent. If parent is not specified, the item will need to be inserted into a list widget with insertItem() .

This constructor inserts the item into the model of the parent that is passed to the constructor. If the model is sorted then the behavior of the insert is undetermined since the model will call the '<' operator method on the item which, at this point, is not yet constructed. To avoid the undetermined behavior, we recommend not to specify the parent and use insertItem() instead.

See also

type()

Constructs an empty list widget item of the specified type with the given icon, text and parent. If the parent is not specified, the item will need to be inserted into a list widget with insertItem() .

This constructor inserts the item into the model of the parent that is passed to the constructor. If the model is sorted then the behavior of the insert is undetermined since the model will call the '<' operator method on the item which, at this point, is not yet constructed. To avoid the undetermined behavior, we recommend not to specify the parent and use insertItem() instead.

See also

type()

Constructs a copy of other. Note that type() and listWidget() are not copied.

This function is useful when reimplementing clone() .

See also

data() flags()

Constructs an empty list widget item of the specified type with the given text and parent. If the parent is not specified, the item will need to be inserted into a list widget with insertItem() .

This constructor inserts the item into the model of the parent that is passed to the constructor. If the model is sorted then the behavior of the insert is undetermined since the model will call the '<' operator method on the item which, at this point, is not yet constructed. To avoid the undetermined behavior, we recommend not to specify the parent and use insertItem() instead.

See also

type()

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

Returns the brush used to display the list item’s background.

See also

setBackground() foreground()

PySide6.QtWidgets.QListWidgetItem.checkState()

Return type

CheckState

Returns the checked state of the list item (see CheckState ).

See also

setCheckState() flags()

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

Returns the item flags for this item (see ItemFlags ).

See also

setFlags()

PySide6.QtWidgets.QListWidgetItem.font()

Return type

PySide6.QtGui.QFont

Returns the font used to display this list item’s text.

See also

setFont()

PySide6.QtWidgets.QListWidgetItem.foreground()

Return type

PySide6.QtGui.QBrush

Returns the brush used to display the list item’s foreground (e.g. text).

See also

setForeground() background()

PySide6.QtWidgets.QListWidgetItem.icon()

Return type

PySide6.QtGui.QIcon

Returns the list item’s icon.

See also

setIcon() iconSize

PySide6.QtWidgets.QListWidgetItem.isHidden()

Return type

bool

Returns true if the item is hidden; otherwise returns false.

See also

setHidden()

PySide6.QtWidgets.QListWidgetItem.isSelected()

Return type

bool

Returns true if the item is selected; otherwise returns false.

See also

setSelected()

PySide6.QtWidgets.QListWidgetItem.listWidget()

Return type

PySide6.QtWidgets.QListWidget

Returns the list widget containing the item.

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

Sets the background brush of the list item to the given brush. Setting a default-constructed brush will let the view use the default color from the style.

See also

background() setForeground()

PySide6.QtWidgets.QListWidgetItem.setCheckState(state)

Parameters

state – CheckState

Sets the check state of the list item to state.

See also

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.

See also

ItemDataRole data()

PySide6.QtWidgets.QListWidgetItem.setFlags(flags)

Parameters

flags – ItemFlags

Sets the item flags for the list item to flags.

See also

flags() ItemFlags

PySide6.QtWidgets.QListWidgetItem.setFont(font)

Parameters

font – PySide6.QtGui.QFont

Sets the font used when painting the item to the given font.

See also

font()

PySide6.QtWidgets.QListWidgetItem.setForeground(brush)

Parameters

brush – PySide6.QtGui.QBrush

Sets the foreground brush of the list item to the given brush. Setting a default-constructed brush will let the view use the default color from the style.

See also

foreground() setBackground()

PySide6.QtWidgets.QListWidgetItem.setHidden(hide)

Parameters

hide – bool

Hides the item if hide is true; otherwise shows the item.

See also

isHidden()

PySide6.QtWidgets.QListWidgetItem.setIcon(icon)

Parameters

icon – PySide6.QtGui.QIcon

Sets the icon for the list item to the given icon.

See also

icon() text() iconSize

PySide6.QtWidgets.QListWidgetItem.setSelected(select)

Parameters

select – bool

Sets the selected state of the item to select.

See also

isSelected()

PySide6.QtWidgets.QListWidgetItem.setSizeHint(size)

Parameters

size – PySide6.QtCore.QSize

Sets the size hint for the list item to be size. If no size hint is set or size is invalid, the item delegate will compute the size hint based on the item data.

See also

sizeHint()

PySide6.QtWidgets.QListWidgetItem.setStatusTip(statusTip)

Parameters

statusTip – str

Sets the status tip for the list item to the text specified by statusTip. QListWidget mouseTracking needs to be enabled for this feature to work.

See also

statusTip() setToolTip() setWhatsThis() setMouseTracking()

PySide6.QtWidgets.QListWidgetItem.setText(text)

Parameters

text – str

Sets the text for the list widget item’s to the given text.

See also

text()

PySide6.QtWidgets.QListWidgetItem.setTextAlignment(alignment)

Parameters

alignment – int

Sets the list item’s text alignment to alignment.

See also

textAlignment() AlignmentFlag

PySide6.QtWidgets.QListWidgetItem.setToolTip(toolTip)

Parameters

toolTip – str

Sets the tooltip for the list item to the text specified by toolTip.

See also

toolTip() setStatusTip() setWhatsThis()

PySide6.QtWidgets.QListWidgetItem.setWhatsThis(whatsThis)

Parameters

whatsThis – str

Sets the “What’s This?” help for the list item to the text specified by whatsThis.

See also

whatsThis() setStatusTip() setToolTip()

PySide6.QtWidgets.QListWidgetItem.sizeHint()

Return type

PySide6.QtCore.QSize

Returns the size hint set for the list item.

See also

setSizeHint()

PySide6.QtWidgets.QListWidgetItem.statusTip()

Return type

str

Returns the list item’s status tip.

See also

setStatusTip()

PySide6.QtWidgets.QListWidgetItem.text()

Return type

str

Returns the list item’s text.

See also

setText()

PySide6.QtWidgets.QListWidgetItem.textAlignment()

Return type

int

Returns the text alignment for the list item.

See also

setTextAlignment() AlignmentFlag

PySide6.QtWidgets.QListWidgetItem.toolTip()

Return type

str

Returns the list item’s tooltip.

See also

setToolTip() statusTip() whatsThis()

PySide6.QtWidgets.QListWidgetItem.type()

Return type

int

Returns the type passed to the QListWidgetItem constructor.

PySide6.QtWidgets.QListWidgetItem.whatsThis()

Return type

str

Returns the list item’s “What’s This?” help text.

See also

setWhatsThis() statusTip() toolTip()

PySide6.QtWidgets.QListWidgetItem.write(out)

Parameters

out – PySide6.QtCore.QDataStream

Writes the item to stream out.

See also

read()