内容表

上一话题

QTreeView

下一话题

QTreeWidgetItem

QTreeWidget

QTreeWidget class provides a tree view that uses a predefined tree model. 更多

Inheritance diagram of PySide2.QtWidgets.QTreeWidget

概要

函数

虚函数

信号

详细描述

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

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 .

不需要灵活模型/视图框架的开发者可以使用此类,非常轻松地创建简单分层列表。更灵活方式涉及组合 QTreeView 采用标准项模型。这允许将数据存储与其表示分开。

以最简单形式,可以按以下方式构造树 Widget:

treeWidget = QTreeWidget()
treeWidget.setColumnCount(1)
items = []
for i in range(10):
    items.append(QTreeWidgetItem(None, QStringList(QString("item: %1").arg(i))))
treeWidget.insertTopLevelItems(None, items)
											

在可以把项添加到树 Widget 之前,必须设置列数采用 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() 函数。

树可以拥有包含 Widget 每列区间的 Header 头。为每区间设置标签的最简单方式是通过提供字符串列表采用 setHeaderLabels() , but a custom header can be constructed with a QTreeWidgetItem 并插入树采用 setHeaderItem() 函数。

树中的项可以根据预定义排序次序按列排序。若排序被启用,用户可以通过点击列 Header 头排序项。可以启用或禁用排序通过调用 setSortingEnabled() isSortingEnabled() 函数指示是否启用排序。

class QTreeWidget ( [ parent=None ] )
param parent

QWidget

构造树 Widget 采用给定 parent .

PySide2.QtWidgets.QTreeWidget. addTopLevelItem ( item )
参数

item QTreeWidgetItem

追加 item 作为 Widget 顶层项。

PySide2.QtWidgets.QTreeWidget. addTopLevelItems ( items )
参数

items

追加列表 items 作为 Widget 顶层项。

PySide2.QtWidgets.QTreeWidget. clear ( )

清零树 Widget 通过移除其所有项和选定。

注意

由于每项在被删除之前会从树 Widget 被移除,返回值的 treeWidget() will be invalid when called from an item’s destructor.

PySide2.QtWidgets.QTreeWidget. closePersistentEditor ( item [ , column=0 ] )
参数

关闭持久编辑器为 item 以给定 column .

此函数不起作用,若此项和列的组合没有打开持久编辑器。

PySide2.QtWidgets.QTreeWidget. collapseItem ( item )
参数

item QTreeWidgetItem

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

PySide2.QtWidgets.QTreeWidget. columnCount ( )
返回类型

int

另请参阅

setColumnCount()

PySide2.QtWidgets.QTreeWidget. currentColumn ( )
返回类型

int

返回树 Widget 当前列。

PySide2.QtWidgets.QTreeWidget. currentItem ( )
返回类型

QTreeWidgetItem

返回树 Widget 中的当前项。

PySide2.QtWidgets.QTreeWidget. currentItemChanged ( current , 上一 )
参数
PySide2.QtWidgets.QTreeWidget. dropMimeData ( parent , index , data , action )
参数
返回类型

bool

处理 data 提供通过拖放操作结束按给定 action index 以给定 parent 项。

默认实现返回 true 若掉落成功处理通过解码 MIME 数据并将其插入模型;否则它返回 false .

PySide2.QtWidgets.QTreeWidget. editItem ( item [ , column=0 ] )
参数

开始编辑 item 以给定 column 若它可编辑。

PySide2.QtWidgets.QTreeWidget. expandItem ( item )
参数

item QTreeWidgetItem

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

PySide2.QtWidgets.QTreeWidget. findItems ( text , flags [ , column=0 ] )
参数
  • text – unicode

  • flags MatchFlags

  • column int

返回类型

返回的项列表匹配给定 text ,使用给定 flags ,在给定 column .

PySide2.QtWidgets.QTreeWidget. headerItem ( )
返回类型

QTreeWidgetItem

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

另请参阅

setHeaderItem()

PySide2.QtWidgets.QTreeWidget. indexFromItem ( item [ , column=0 ] )
参数
返回类型

QModelIndex

返回 QModelIndex 关联给定 item 以给定 column .

注意

在 Qt 5.7 之前的版本中,此函数接受非 const item .

PySide2.QtWidgets.QTreeWidget. indexFromItem ( item [ , column=0 ] )
参数
返回类型

QModelIndex

返回 QModelIndex 关联给定 item 以给定 column .

注意

在 Qt 5.7 之前的版本中,此函数接受非 const item .

PySide2.QtWidgets.QTreeWidget. indexOfTopLevelItem ( item )
参数

item QTreeWidgetItem

返回类型

int

返回索引为给定顶层 item ,或 -1 若找不到项。

PySide2.QtWidgets.QTreeWidget. insertTopLevelItem ( index , item )
参数

插入 item at index 在视图的顶层。

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

PySide2.QtWidgets.QTreeWidget. insertTopLevelItems ( index , items )
参数
  • index int

  • items

插入列表 items at index 在视图的顶层。

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

PySide2.QtWidgets.QTreeWidget. invisibleRootItem ( )
返回类型

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,使编写可以按统一方式处理顶层项及其子级的函数成为可能;例如:递归函数。

PySide2.QtWidgets.QTreeWidget. isFirstItemColumnSpanned ( item )
参数

item QTreeWidgetItem

返回类型

bool

注意

此函数被弃用。

返回 true 若给定 item is set to show only one section over all columns; otherwise returns false .

This function is deprecated. Use isFirstColumnSpanned() 代替。

PySide2.QtWidgets.QTreeWidget. isItemExpanded ( item )
参数

item QTreeWidgetItem

返回类型

bool

注意

此函数被弃用。

返回 true 若给定 item is open; otherwise returns false .

This function is deprecated. Use isExpanded() 代替。

另请参阅

itemExpanded()

PySide2.QtWidgets.QTreeWidget. isItemHidden ( item )
参数

item QTreeWidgetItem

返回类型

bool

注意

此函数被弃用。

返回 true item is explicitly hidden, otherwise returns false .

This function is deprecated. Use isHidden() 代替。

PySide2.QtWidgets.QTreeWidget. isItemSelected ( item )
参数

item QTreeWidgetItem

返回类型

bool

注意

此函数被弃用。

返回 true item is selected; otherwise returns false .

This function is deprecated. Use isSelected() 代替。

PySide2.QtWidgets.QTreeWidget. isPersistentEditorOpen ( item [ , column=0 ] )
参数
返回类型

bool

返回是否打开持久编辑器为项 item 在列 column .

PySide2.QtWidgets.QTreeWidget. itemAbove ( item )
参数

item QTreeWidgetItem

返回类型

QTreeWidgetItem

返回上方项为给定 item .

PySide2.QtWidgets.QTreeWidget. itemActivated ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemAt ( x , y )
参数
  • x int

  • y int

返回类型

QTreeWidgetItem

这是重载函数。

返回指针指向项在坐标 ( x , y ). The coordinates are relative to the tree widget’s viewport() .

PySide2.QtWidgets.QTreeWidget. itemAt ( p )
参数

p QPoint

返回类型

QTreeWidgetItem

返回指针指向项在坐标 p . The coordinates are relative to the tree widget’s viewport() .

另请参阅

visualItemRect()

PySide2.QtWidgets.QTreeWidget. itemBelow ( item )
参数

item QTreeWidgetItem

返回类型

QTreeWidgetItem

返回下方可见项为给定 item .

PySide2.QtWidgets.QTreeWidget. itemChanged ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemClicked ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemCollapsed ( item )
参数

item QTreeWidgetItem

PySide2.QtWidgets.QTreeWidget. itemDoubleClicked ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemEntered ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemExpanded ( item )
参数

item QTreeWidgetItem

PySide2.QtWidgets.QTreeWidget. itemFromIndex ( index )
参数

index QModelIndex

返回类型

QTreeWidgetItem

返回指针指向 QTreeWidgetItem 关联给定 index .

另请参阅

indexFromItem()

PySide2.QtWidgets.QTreeWidget. itemPressed ( item , column )
参数
PySide2.QtWidgets.QTreeWidget. itemSelectionChanged ( )
PySide2.QtWidgets.QTreeWidget. itemWidget ( item , column )
参数
返回类型

QWidget

返回单元格显示 Widget 指定通过 item 和给定 column .

另请参阅

setItemWidget()

PySide2.QtWidgets.QTreeWidget. items ( data )
参数

data QMimeData

返回类型

Returns an empty list

另请参阅

mimeData()

PySide2.QtWidgets.QTreeWidget. mimeData ( items )
参数

items

返回类型

QMimeData

返回对象包含序列化描述指定通过 items 。用于描述项的格式获取自 mimeTypes() 函数。

若项列表为空, None 被返回而不是序列化空列表。

PySide2.QtWidgets.QTreeWidget. mimeTypes ( )
返回类型

字符串列表

返回可用于描述 treewidget 项列表的 MIME 类型列表。

另请参阅

mimeData()

PySide2.QtWidgets.QTreeWidget. openPersistentEditor ( item [ , column=0 ] )
参数

打开持久编辑器为 item 以给定 column .

PySide2.QtWidgets.QTreeWidget. removeItemWidget ( item , column )
参数

删除设置 Widget 在给定 item 以给定 column .

PySide2.QtWidgets.QTreeWidget. scrollToItem ( item [ , hint=EnsureVisible ] )
参数

确保 item 可见,卷动视图若有必要使用指定 hint .

PySide2.QtWidgets.QTreeWidget. selectedItems ( )
返回类型

返回所有选定的非隐藏项的列表。

PySide2.QtWidgets.QTreeWidget. setColumnCount ( columns )
参数

columns int

另请参阅

columnCount()

PySide2.QtWidgets.QTreeWidget. setCurrentItem ( item )
参数

item QTreeWidgetItem

设置当前 item 在树 Widget。

除非选定模式为 NoSelection ,项还被选中。

PySide2.QtWidgets.QTreeWidget. setCurrentItem ( item , column )
参数

设置当前 item 在树 Widget 和当前列到 column .

另请参阅

currentItem()

PySide2.QtWidgets.QTreeWidget. setCurrentItem ( item , column , command )
参数

设置当前 item 在树 Widget 和当前列到 column ,使用给定 command .

另请参阅

currentItem()

PySide2.QtWidgets.QTreeWidget. setFirstItemColumnSpanned ( item , span )
参数

注意

此函数被弃用。

设置给定 item to only show one section for all columns if span is true; otherwise the item will show one section per column.

This function is deprecated. Use setFirstColumnSpanned() 代替。

PySide2.QtWidgets.QTreeWidget. setHeaderItem ( item )
参数

item QTreeWidgetItem

设置 Header 头 item for the tree widget. The label for each column in the header is supplied by the corresponding label in the item.

树 Widget 拥有项的所有权。

PySide2.QtWidgets.QTreeWidget. setHeaderLabel ( label )
参数

label – unicode

如同 setHeaderLabels ( QStringList ( label )).

PySide2.QtWidgets.QTreeWidget. setHeaderLabels ( labels )
参数

labels – 字符串列表

为每项添加 Header 头部列按 labels 列表, 并为每列设置标签。

Note that won’t remove existing columns.

PySide2.QtWidgets.QTreeWidget. setItemExpanded ( item , expand )
参数

注意

此函数被弃用。

Sets the item referred to by item to either closed or opened, depending on the value of expand .

This function is deprecated. Use setExpanded() 代替。

PySide2.QtWidgets.QTreeWidget. setItemHidden ( item , hide )
参数

注意

此函数被弃用。

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

This function is deprecated. Use setHidden() 代替。

PySide2.QtWidgets.QTreeWidget. setItemSelected ( item , select )
参数

注意

此函数被弃用。

select is true, the given item is selected; otherwise it is deselected.

This function is deprecated. Use setSelected() 代替。

PySide2.QtWidgets.QTreeWidget. setItemWidget ( item , column , widget )
参数

设置给定 widget 以显示在指定单元格通过给定 item and column .

给定 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.

此函数只应该用于在树 Widget 项位置处显示静态内容。若想要显示自定义动态内容或实现自定义编辑器 Widget,使用 QTreeView 和子类 QStyledItemDelegate 代替。

不可以调用此函数在设置项层次结构之前,即 QTreeWidgetItem 将保持 widget 必须被添加到视图之后 widget 被设置。

注意

树拥有 Widget 的所有权。

PySide2.QtWidgets.QTreeWidget. sortColumn ( )
返回类型

int

返回用于排序 Widget 内容的列。

另请参阅

sortItems()

PySide2.QtWidgets.QTreeWidget. sortItems ( column , order )
参数
  • column int

  • order SortOrder

排序 Widget 项按指定 order 通过值在给定 column .

另请参阅

sortColumn()

PySide2.QtWidgets.QTreeWidget. supportedDropActions ( )
返回类型

DropActions

返回由此视图所支持的掉落动作。

另请参阅

DropActions

PySide2.QtWidgets.QTreeWidget. takeTopLevelItem ( index )
参数

index int

返回类型

QTreeWidgetItem

移除顶层项位于给定 index 在树中并返回它,否则返回 None ;

PySide2.QtWidgets.QTreeWidget. topLevelItem ( index )
参数

index int

返回类型

QTreeWidgetItem

返回顶层项位于给定 index ,或 None 若项不存在。

PySide2.QtWidgets.QTreeWidget. topLevelItemCount ( )
返回类型

int

PySide2.QtWidgets.QTreeWidget. visualItemRect ( item )
参数

item QTreeWidgetItem

返回类型

QRect

返回项所占据的视口矩形在 item .

另请参阅

itemAt()