QTreeWidget¶

The QTreeWidget class provides a tree view that uses a predefined tree model. More…

Synopsis¶

Functions¶

def addTopLevelItem (item)
def addTopLevelItems (items)
def closePersistentEditor (item[, column=0])
def columnCount ()
def currentColumn ()
def currentItem ()
def editItem (item[, column=0])
def findItems (text, flags[, column=0])
def headerItem ()
def indexFromItem (item[, column=0])
def indexOfTopLevelItem (item)
def insertTopLevelItem (index, item)
def insertTopLevelItems (index, items)
def invisibleRootItem ()
def isPersistentEditorOpen (item[, column=0])
def itemAbove (item)
def itemAt (p)
def itemAt (x, y)
def itemBelow (item)
def itemFromIndex (index)
def itemWidget (item, column)
def openPersistentEditor (item[, column=0])
def removeItemWidget (item, column)
def selectedItems ()
def setColumnCount (columns)
def setCurrentItem (item)
def setCurrentItem (item, column)
def setCurrentItem (item, column, command)
def setHeaderItem (item)
def setHeaderLabel (label)
def setHeaderLabels (labels)
def setItemWidget (item, column, widget)
def sortColumn ()
def sortItems (column, order)
def takeTopLevelItem (index)
def topLevelItem (index)
def topLevelItemCount ()
def visualItemRect (item)

Virtual functions¶

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

Slots¶

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

Signals¶

def currentItemChanged (current, previous)
def itemActivated (item, column)
def itemChanged (item, column)
def itemClicked (item, column)
def itemCollapsed (item)
def itemDoubleClicked (item, column)
def itemEntered (item, column)
def itemExpanded (item)
def itemPressed (item, column)
def itemSelectionChanged ()

Detailed Description¶

The QTreeWidget class is a convenience class that provides a standard tree widget with a classic item-based interface similar to that used by the QListView class in Qt 3. This class is based on Qt’s Model/View architecture and uses a default model to hold items, each of which is a QTreeWidgetItem .

Developers who do not need the flexibility of the Model/View framework can use this class to create simple hierarchical lists very easily. A more flexible approach involves combining a QTreeView with a standard item model. This allows the storage of data to be separated from its representation.

In its simplest form, a tree widget can be constructed in the following way:

treeWidget = QTreeWidget()
treeWidget.setColumnCount(1)
*> = QList<QTreeWidgetItem()
for i in range(0, 10):
    items.append(QTreeWidgetItem(QTreeWidget (None), QStringList(QString("item: %1").arg(i))))
treeWidget.insertTopLevelItems(0, items)

Before items can be added to the tree widget, the number of columns must be set with setColumnCount() . This allows each item to have one or more labels or other decorations. The number of columns in use can be found with the columnCount() function.

The tree can have a header that contains a section for each column in the widget. It is easiest to set up the labels for each section by supplying a list of strings with setHeaderLabels() , but a custom header can be constructed with a QTreeWidgetItem and inserted into the tree with the setHeaderItem() function.

The items in the tree can be sorted by column according to a predefined sort order. If sorting is enabled, the user can sort the items by clicking on a column header. Sorting can be enabled or disabled by calling setSortingEnabled() . The isSortingEnabled() function indicates whether sorting is enabled.

See also

QTreeWidgetItem QTreeWidgetItemIterator QTreeView Model/View Programming Settings Editor Example

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

Parameters: parent – PySide6.QtWidgets.QWidget

Constructs a tree widget with the given parent.

PySide6.QtWidgets.QTreeWidget.addTopLevelItem(item)¶

Parameters: item – PySide6.QtWidgets.QTreeWidgetItem

Appends the item as a top-level item in the widget.

See also

insertTopLevelItem()

PySide6.QtWidgets.QTreeWidget.addTopLevelItems(items)¶

Parameters: items –

Appends the list of items as a top-level items in the widget.

See also

insertTopLevelItems()

PySide6.QtWidgets.QTreeWidget.clear()¶

Clears the tree widget by removing all of its items and selections.

Note

Since each item is removed from the tree widget before being deleted, the return value of treeWidget() will be invalid when called from an item’s destructor.

Table of Contents

Previous topic

Next topic

QTreeWidget¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶