class QTreeWidget

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

Inheritance diagram of PySide6.QtWidgets.QTreeWidget

Synopsis

Properties

Methods

Virtual methods

Slots

Signals

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.

../../_images/windows-treeview.png

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.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property columnCountᅟ: int

This property holds the number of columns displayed in the tree widget.

By default, this property has a value of 1.

Access functions:
property topLevelItemCountᅟ: int

This property holds the number of top-level items.

By default, this property has a value of 0.

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

Constructs a tree widget with the given parent.

addTopLevelItem(item)
Parameters:

item – QTreeWidgetItem

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

addTopLevelItems(items)
Parameters:

items – .list of QTreeWidgetItem

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

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.

See also

takeTopLevelItem() topLevelItemCount() columnCount()

closePersistentEditor(item[, column=0])
Parameters:

Closes the persistent editor for the item in the given column.

This function has no effect if no persistent editor is open for this combination of item and column.

collapseItem(item)
Parameters:

item – QTreeWidgetItem

Closes the item. This causes the tree containing the item’s children to be collapsed.

columnCount()
Return type:

int

See also

setColumnCount()

Getter of property columnCountᅟ .

currentColumn()
Return type:

int

Returns the current column in the tree widget.

currentItem()
Return type:

QTreeWidgetItem

Returns the current item in the tree widget.

currentItemChanged(current, previous)
Parameters:

This signal is emitted when the current item changes. The current item is specified by current, and this replaces the previous current item.

See also

setCurrentItem()

dropMimeData(parent, index, data, action)
Parameters:
Return type:

bool

Handles the data supplied by a drag and drop operation that ended with the given action in the index in the given parent item.

The default implementation returns true if the drop was successfully handled by decoding the mime data and inserting it into the model; otherwise it returns false.

editItem(item[, column=0])
Parameters:

Starts editing the item in the given column if it is editable.

expandItem(item)
Parameters:

item – QTreeWidgetItem

Expands the item. This causes the tree containing the item’s children to be expanded.

findItems(text, flags[, column=0])
Parameters:

  • text – str

  • flags – Combination of MatchFlag

  • column – int

Return type:

.list of QTreeWidgetItem

Returns a list of items that match the given text, using the given flags, in the given column.

headerItem()
Return type:

QTreeWidgetItem

Returns the item used for the tree widget’s header.

See also

setHeaderItem()

indexFromItem(item[, column=0])
Parameters:
Return type:

QModelIndex

Returns the QModelIndex associated with the given item in the given column.

Note

In Qt versions prior to 5.7, this function took a non-const item.

See also

itemFromIndex() topLevelItem()

indexOfTopLevelItem(item)
Parameters:

item – QTreeWidgetItem

Return type:

int

Returns the index of the given top-level item, or -1 if the item cannot be found.

insertTopLevelItem(index, item)
Parameters:

Inserts the item at index in the top level in the view.

If the item has already been inserted somewhere else it won’t be inserted.

insertTopLevelItems(index, items)
Parameters:

  • index – int

  • items – .list of QTreeWidgetItem

Inserts the list of items at index in the top level in the view.

Items that have already been inserted somewhere else won’t be inserted.

invisibleRootItem()
Return type:

QTreeWidgetItem

Returns the tree widget’s invisible root item.

The invisible root item provides access to the tree widget’s top-level items through the QTreeWidgetItem API, making it possible to write functions that can treat top-level items and their children in a uniform way; for example, recursive functions.

isPersistentEditorOpen(item[, column=0])
Parameters:
Return type:

bool

Returns whether a persistent editor is open for item item in column column.

itemAbove(item)
Parameters:

item – QTreeWidgetItem

Return type:

QTreeWidgetItem

Returns the item above the given item.

itemActivated(item, column)
Parameters:

This signal is emitted when the user activates an item by single- or double-clicking (depending on the platform, i.e. on the SH_ItemView_ActivateItemOnSingleClick style hint) or pressing a special key (e.g., Enter).

The specified item is the item that was clicked, or None if no item was clicked. The column is the item’s column that was clicked, or -1 if no item was clicked.

itemAt(p)
Parameters:

p – QPoint

Return type:

QTreeWidgetItem

Returns a pointer to the item at the coordinates p. The coordinates are relative to the tree widget’s viewport() .

See also

visualItemRect()

itemAt(x, y)
Parameters:

  • x – int

  • y – int

Return type:

QTreeWidgetItem

This is an overloaded function.

Returns a pointer to the item at the coordinates (x, y). The coordinates are relative to the tree widget’s viewport() .

itemBelow(item)
Parameters:

item – QTreeWidgetItem

Return type:

QTreeWidgetItem

Returns the item visually below the given item.

itemChanged(item, column)
Parameters:

This signal is emitted when the contents of the column in the specified item changes.

itemClicked(item, column)
Parameters:

This signal is emitted when the user clicks inside the widget.

The specified item is the item that was clicked. The column is the item’s column that was clicked. If no item was clicked, no signal will be emitted.

itemCollapsed(item)
Parameters:

item – QTreeWidgetItem

This signal is emitted when the specified item is collapsed so that none of its children are displayed.

Note

This signal will not be emitted if an item changes its state when collapseAll() is invoked.

See also

isExpanded() itemExpanded() collapseItem()

itemDoubleClicked(item, column)
Parameters:

This signal is emitted when the user double clicks inside the widget.

The specified item is the item that was clicked, or None if no item was clicked. The column is the item’s column that was clicked. If no item was double clicked, no signal will be emitted.

itemEntered(item, column)
Parameters:

This signal is emitted when the mouse cursor enters an item over the specified column. QTreeWidget mouse tracking needs to be enabled for this feature to work.

itemExpanded(item)
Parameters:

item – QTreeWidgetItem

This signal is emitted when the specified item is expanded so that all of its children are displayed.

itemFromIndex(index)
Parameters:

index – QModelIndex

Return type:

QTreeWidgetItem

Returns a pointer to the QTreeWidgetItem associated with the given index.

See also

indexFromItem()

itemPressed(item, column)
Parameters:

This signal is emitted when the user presses a mouse button inside the widget.

The specified item is the item that was clicked, or None if no item was clicked. The column is the item’s column that was clicked, or -1 if no item was clicked.

itemSelectionChanged()

This signal is emitted when the selection changes in the tree widget. The current selection can be found with selectedItems() .

itemWidget(item, column)
Parameters:
Return type:

QWidget

Returns the widget displayed in the cell specified by item and the given column.

mimeData(items)
Parameters:

items – .list of QTreeWidgetItem

Return type:

QMimeData

Returns an object that contains a serialized description of the specified items. The format used to describe the items is obtained from the mimeTypes() function.

If the list of items is empty, None is returned rather than a serialized empty list.

mimeTypes()
Return type:

list of strings

Returns a list of MIME types that can be used to describe a list of treewidget items.

See also

mimeData()

openPersistentEditor(item[, column=0])
Parameters:

Opens a persistent editor for the item in the given column.

removeItemWidget(item, column)
Parameters:

Removes the widget set in the given item in the given column.

scrollToItem(item[, hint=QAbstractItemView.ScrollHint.EnsureVisible])
Parameters:

Ensures that the item is visible, scrolling the view if necessary using the specified hint.

selectedItems()
Return type:

.list of QTreeWidgetItem

Returns a list of all selected non-hidden items.

setColumnCount(columns)
Parameters:

columns – int

See also

columnCount()

Setter of property columnCountᅟ .

setCurrentItem(item)
Parameters:

item – QTreeWidgetItem

Sets the current item in the tree widget.

Unless the selection mode is NoSelection , the item is also selected.

setCurrentItem(item, column)
Parameters:

Sets the current item in the tree widget and the current column to column.

See also

currentItem()

setCurrentItem(item, column, command)
Parameters:

Sets the current item in the tree widget and the current column to column, using the given command.

See also

currentItem()

setHeaderItem(item)
Parameters:

item – QTreeWidgetItem

Sets the header item for the tree widget. The label for each column in the header is supplied by the corresponding label in the item.

The tree widget takes ownership of the item.

setHeaderLabel(label)
Parameters:

label – str

Same as setHeaderLabels (QStringList(label)).

setHeaderLabels(labels)
Parameters:

labels – list of strings

Adds a column in the header for each item in the labels list, and sets the label for each column.

Note that setHeaderLabels() won’t remove existing columns.

setItemWidget(item, column, widget)
Parameters:

Sets the given widget to be displayed in the cell specified by the given item and column.

The given widget's autoFillBackground property must be set to true, otherwise the widget’s background will be transparent, showing both the model data and the tree widget item.

This function should only be used to display static content in the place of a tree widget item. If you want to display custom dynamic content or implement a custom editor widget, use QTreeView and subclass QStyledItemDelegate instead.

This function cannot be called before the item hierarchy has been set up, i.e., the QTreeWidgetItem that will hold widget must have been added to the view before widget is set.

Note

The tree takes ownership of widget.

See also

itemWidget() removeItemWidget() Delegate Classes

sortColumn()
Return type:

int

Returns the column used to sort the contents of the widget.

See also

sortItems()

sortItems(column, order)
Parameters:

Sorts the items in the widget in the specified order by the values in the given column.

See also

sortColumn()

supportedDropActions()
Return type:

Combination of DropAction

Returns the drop actions supported by this view.

See also

DropActions

takeTopLevelItem(index)
Parameters:

index – int

Return type:

QTreeWidgetItem

Removes the top-level item at the given index in the tree and returns it, otherwise returns None;

topLevelItem(index)
Parameters:

index – int

Return type:

QTreeWidgetItem

Returns the top level item at the given index, or None if the item does not exist.

topLevelItemCount()
Return type:

int

Getter of property topLevelItemCountᅟ .

visualItemRect(item)
Parameters:

item – QTreeWidgetItem

Return type:

QRect

Returns the rectangle on the viewport occupied by the item at item.

See also

itemAt()