PySide6.QtWidgets.QListWidgetItem¶

class QListWidgetItem¶

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

Synopsis¶

Methods¶

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

Virtual methods¶

def clone()
def data()
def __lt__()
def read()
def setData()
def write()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 Qt::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 ItemType¶

(inherits enum.IntEnum) This enum describes the types that are used to describe list widget items.

Constant

Description

QListWidgetItem.ItemType.Type

The default type for list widget items.

QListWidgetItem.ItemType.UserType

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

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

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

See also

type()

__init__(other)¶

Parameters:: other – QListWidgetItem

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

This function is useful when reimplementing clone() .

See also

data() flags()

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

Parameters:

listview – 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()

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

Parameters:

text – str
listview – QListWidget
type – int

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() .

See also

type()

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

Parameters:

icon – QIcon
text – str
listview – QListWidget
type – int

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() .

See also

type()

background()¶

Return type:: QBrush

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

See also

setBackground() foreground()

checkState()¶

Return type:: CheckState

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

See also

setCheckState() flags()

clone()¶

Return type:: QListWidgetItem

Creates an exact copy of the item.

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

setData()

flags()¶

Return type:: Combination of ItemFlag

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

See also

setFlags()

font()¶

Return type:: QFont

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

See also

setFont()

foreground()¶

Return type:: QBrush

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

See also

setForeground() background()

icon()¶

Return type:: QIcon

Returns the list item’s icon.

See also

setIcon() iconSize

isHidden()¶

Return type:: bool

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

See also

setHidden()

isSelected()¶

Return type:: bool

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

See also

setSelected()

listWidget()¶

Return type:: QListWidget

Returns the list widget containing the item.

__lt__(other)¶

Parameters:: other – QListWidgetItem
Return type:: bool

Returns true if this item’s text is less then other item’s text; otherwise returns false.

read(in)¶

Parameters:: in – QDataStream

Reads the item from stream in.

See also

write()

setBackground(brush)¶

Parameters:: brush – 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()

setCheckState(state)¶

Parameters:: state – CheckState

Sets the check state of the list item to state.

See also

checkState()

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 Qt::EditRole and Qt::DisplayRole as referring to the same data.