QListWidget¶

The QListWidget class provides an item-based list widget. More…

Synopsis¶

Functions¶

def addItem (item)
def addItem (label)
def addItems (labels)
def closePersistentEditor (item)
def count ()
def currentItem ()
def currentRow ()
def editItem (item)
def findItems (text, flags)
def indexFromItem (item)
def insertItem (row, item)
def insertItem (row, label)
def insertItems (row, labels)
def isPersistentEditorOpen (item)
def isSortingEnabled ()
def item (row)
def itemAt (p)
def itemAt (x, y)
def itemFromIndex (index)
def itemWidget (item)
def items (data)
def openPersistentEditor (item)
def removeItemWidget (item)
def row (item)
def selectedItems ()
def setCurrentItem (item)
def setCurrentItem (item, command)
def setCurrentRow (row)
def setCurrentRow (row, command)
def setItemWidget (item, widget)
def setSortingEnabled (enable)
def sortItems ([order=Qt.AscendingOrder])
def takeItem (row)
def visualItemRect (item)

Virtual functions¶

def dropMimeData (index, data, action)
def mimeData (items)
def mimeTypes ()
def supportedDropActions ()

Slots¶

def clear ()
def scrollToItem (item[, hint=QAbstractItemView.ScrollHint.EnsureVisible])

Signals¶

def currentItemChanged (current, previous)
def currentRowChanged (currentRow)
def currentTextChanged (currentText)
def itemActivated (item)
def itemChanged (item)
def itemClicked (item)
def itemDoubleClicked (item)
def itemEntered (item)
def itemPressed (item)
def itemSelectionChanged ()

Detailed Description¶

QListWidget is a convenience class that provides a list view similar to the one supplied by QListView , but with a classic item-based interface for adding and removing items. QListWidget uses an internal model to manage each QListWidgetItem in the list.

For a more flexible list view widget, use the QListView class with a standard model.

List widgets are constructed in the same way as other widgets:

listWidget = QListWidget(self)

The selectionMode() of a list widget determines how many of the items in the list can be selected at the same time, and whether complex selections of items can be created. This can be set with the setSelectionMode() function.

There are two ways to add items to the list: they can be constructed with the list widget as their parent widget, or they can be constructed with no parent widget and added to the list later. If a list widget already exists when the items are constructed, the first method is easier to use:

QListWidgetItem(tr("Oak"), listWidget)
QListWidgetItem(tr("Fir"), listWidget)
QListWidgetItem(tr("Pine"), listWidget)

If you need to insert a new item into the list at a particular position, then it should be constructed without a parent widget. The insertItem() function should then be used to place it within the list. The list widget will take ownership of the item.

newItem = QListWidgetItem()
newItem.setText(itemText)        listWidget.insertItem(row, newItem)

For multiple items, insertItems() can be used instead. The number of items in the list is found with the count() function. To remove items from the list, use takeItem() .

The current item in the list can be found with currentItem() , and changed with setCurrentItem() . The user can also change the current item by navigating with the keyboard or clicking on a different item. When the current item changes, the currentItemChanged() signal is emitted with the new current item and the item that was previously current.

See also

QListWidgetItem QListView QTreeView Model/View Programming Tab Dialog Example

class PySide6.QtWidgets.QListWidget([parent=None])¶

Parameters: parent – PySide6.QtWidgets.QWidget

Constructs an empty QListWidget with the given parent.

PySide6.QtWidgets.QListWidget.addItem(label)¶

Parameters: label – str

Inserts an item with the text label at the end of the list widget.

PySide6.QtWidgets.QListWidget.addItem(item)

Parameters: item – PySide6.QtWidgets.QListWidgetItem

Inserts the item at the end of the list widget.

Warning

A QListWidgetItem can only be added to a QListWidget once. Adding the same QListWidgetItem multiple times to a QListWidget will result in undefined behavior.

Table of Contents

Previous topic

Next topic