Home · All Classes · Modules

QTreeView Class Reference
[QtGui module]

The QTreeView class provides a default model/view implementation of a tree view. More...

Inherits QAbstractItemView.

Inherited by QHelpContentWidget and QTreeWidget.

Methods

Qt Signals


Detailed Description

The QTreeView class provides a default model/view implementation of a tree view.

A QTreeView implements a tree representation of items from a model. This class is used to provide standard hierarchical lists that were previously provided by the QListView class, but using the more flexible approach provided by Qt's model/view architecture.

The QTreeView class is one of the Model/View Classes and is part of Qt's model/view framework.

QTreeView implements the interfaces defined by the QAbstractItemView class to allow it to display data provided by models derived from the QAbstractItemModel class.

It is simple to construct a tree view displaying data from a model. In the following example, the contents of a directory are supplied by a QFileSystemModel and displayed as a tree:

     QFileSystemModel *model = new QFileSystemModel;
     model->setRootPath(QDir.currentPath());
     QTreeView *tree = new QTreeView(splitter);
     tree->setModel(model);

The model/view architecture ensures that the contents of the tree view are updated as the model changes.

Items that have children can be in an expanded (children are visible) or collapsed (children are hidden) state. When this state changes a collapsed() or expanded() signal is emitted with the model index of the relevant item.

The amount of indentation used to indicate levels of hierarchy is controlled by the indentation property.

Headers in tree views are constructed using the QHeaderView class and can be hidden using header()->hide(). Note that each header is configured with its stretchLastSection property set to true, ensuring that the view does not waste any of the space assigned to it for its header. If this value is set to true, this property will override the resize mode set on the last section in the header.

Key Bindings

QTreeView supports a set of key bindings that enable the user to navigate in the view and interact with the contents of items:

Key Action
Up Moves the cursor to the item in the same column on the previous row. If the parent of the current item has no more rows to navigate to, the cursor moves to the relevant item in the last row of the sibling that precedes the parent.
Down Moves the cursor to the item in the same column on the next row. If the parent of the current item has no more rows to navigate to, the cursor moves to the relevant item in the first row of the sibling that follows the parent.
Left Hides the children of the current item (if present) by collapsing a branch.
Minus Same as LeftArrow.
Right Reveals the children of the current item (if present) by expanding a branch.
Plus Same as RightArrow.
Asterisk Expands all children of the current item (if present).
PageUp Moves the cursor up one page.
PageDown Moves the cursor down one page.
Home Moves the cursor to an item in the same column of the first row of the first top-level item in the model.
End Moves the cursor to an item in the same column of the last row of the last top-level item in the model.
F2 In editable models, this opens the current item for editing. The Escape key can be used to cancel the editing process and revert any changes to the data displayed.
Screenshot of a Windows XP style tree view Screenshot of a Macintosh style tree view Screenshot of a Plastique style tree view
A Windows XP style tree view. A Macintosh style tree view. A Plastique style tree view.

Improving Performance

It is possible to give the view hints about the data it is handling in order to improve its performance when displaying large numbers of items. One approach that can be taken for views that are intended to display items with equal heights is to set the uniformRowHeights property to true.


Method Documentation

QTreeView.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a tree view with a parent to represent a model's data. Use setModel() to set the model.

See also QAbstractItemModel.

bool QTreeView.allColumnsShowFocus (self)

int QTreeView.autoExpandDelay (self)

QTreeView.collapse (self, QModelIndex index)

This method is also a Qt slot with the C++ signature void collapse(const QModelIndex&).

Collapses the model item specified by the index.

See also collapsed().

QTreeView.collapseAll (self)

This method is also a Qt slot with the C++ signature void collapseAll().

Collapses all expanded items.

This function was introduced in Qt 4.2.

See also expandAll(), expand(), collapse(), and setExpanded().

int QTreeView.columnAt (self, int x)

Returns the column in the tree view whose header covers the x coordinate given.

QTreeView.columnCountChanged (self, int oldCount, int newCount)

This method is also a Qt slot with the C++ signature void columnCountChanged(int,int).

Informs the tree view that the number of columns in the tree view has changed from oldCount to newCount.

QTreeView.columnMoved (self)

This method is also a Qt slot with the C++ signature void columnMoved().

This slot is called whenever a column has been moved.

QTreeView.columnResized (self, int column, int oldSize, int newSize)

This method is also a Qt slot with the C++ signature void columnResized(int,int,int).

This function is called whenever column's size is changed in the header. oldSize and newSize give the previous size and the new size in pixels.

See also setColumnWidth().

int QTreeView.columnViewportPosition (self, int column)

Returns the horizontal position of the column in the viewport.

int QTreeView.columnWidth (self, int column)

Returns the width of the column.

See also resizeColumnToContents() and setColumnWidth().

QTreeView.currentChanged (self, QModelIndex current, QModelIndex previous)

Reimplemented from QAbstractItemView.currentChanged().

QTreeView.dataChanged (self, QModelIndex topLeft, QModelIndex bottomRight)

This method is also a Qt slot with the C++ signature void dataChanged(const QModelIndex&,const QModelIndex&).

Reimplemented from QAbstractItemView.dataChanged().

QTreeView.dragMoveEvent (self, QDragMoveEvent event)

Reimplemented from QWidget.dragMoveEvent().

QTreeView.drawBranches (self, QPainter painter, QRect rect, QModelIndex index)

Draws the branches in the tree view on the same row as the model item index, using the painter given. The branches are drawn in the rectangle specified by rect.

QTreeView.drawRow (self, QPainter painter, QStyleOptionViewItem options, QModelIndex index)

Draws the row in the tree view that contains the model item index, using the painter given. The option control how the item is displayed.

See also setAlternatingRowColors().

QTreeView.drawTree (self, QPainter painter, QRegion region)

Draws the part of the tree intersecting the given region using the specified painter.

This function was introduced in Qt 4.2.

See also paintEvent().

QTreeView.expand (self, QModelIndex index)

This method is also a Qt slot with the C++ signature void expand(const QModelIndex&).

Expands the model item specified by the index.

See also expanded().

QTreeView.expandAll (self)

This method is also a Qt slot with the C++ signature void expandAll().

Expands all expandable items.

Warning: if the model contains a large number of items, this function will take some time to execute.

This function was introduced in Qt 4.2.

See also collapseAll(), expand(), collapse(), and setExpanded().

bool QTreeView.expandsOnDoubleClick (self)

QTreeView.expandToDepth (self, int depth)

This method is also a Qt slot with the C++ signature void expandToDepth(int).

Expands all expandable items to the given depth.

This function was introduced in Qt 4.3.

See also expandAll(), collapseAll(), expand(), collapse(), and setExpanded().

QHeaderView QTreeView.header (self)

Returns the header for the tree view.

See also setHeader() and QAbstractItemModel.headerData().

QTreeView.hideColumn (self, int column)

This method is also a Qt slot with the C++ signature void hideColumn(int).

Hides the column given.

Note: This function should only be called after the model has been initialized, as the view needs to know the number of columns in order to hide column.

See also showColumn() and setColumnHidden().

int QTreeView.horizontalOffset (self)

Reimplemented from QAbstractItemView.horizontalOffset().

Returns the horizontal offset of the items in the treeview.

Note that the tree view uses the horizontal header section positions to determine the positions of columns in the view.

See also verticalOffset().

QTreeView.horizontalScrollbarAction (self, int action)

int QTreeView.indentation (self)

QModelIndex QTreeView.indexAbove (self, QModelIndex index)

Returns the model index of the item above index.

QModelIndex QTreeView.indexAt (self, QPoint p)

Reimplemented from QAbstractItemView.indexAt().

QModelIndex QTreeView.indexBelow (self, QModelIndex index)

Returns the model index of the item below index.

int QTreeView.indexRowSizeHint (self, QModelIndex index)

Returns the size hint for the row indicated by index.

See also sizeHintForColumn() and uniformRowHeights().

bool QTreeView.isAnimated (self)

bool QTreeView.isColumnHidden (self, int column)

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

See also hideColumn() and isRowHidden().

bool QTreeView.isExpanded (self, QModelIndex index)

Returns true if the model item index is expanded; otherwise returns false.

See also expand(), expanded(), and setExpanded().

bool QTreeView.isFirstColumnSpanned (self, int row, QModelIndex parent)

Returns true if the item in first column in the given row of the parent is spanning all the columns; otherwise returns false.

This function was introduced in Qt 4.3.

See also setFirstColumnSpanned().

bool QTreeView.isHeaderHidden (self)

bool QTreeView.isIndexHidden (self, QModelIndex index)

Reimplemented from QAbstractItemView.isIndexHidden().

bool QTreeView.isRowHidden (self, int row, QModelIndex parent)

Returns true if the item in the given row of the parent is hidden; otherwise returns false.

See also setRowHidden() and isColumnHidden().

bool QTreeView.isSortingEnabled (self)

bool QTreeView.itemsExpandable (self)

QTreeView.keyboardSearch (self, QString search)

Reimplemented from QAbstractItemView.keyboardSearch().

QTreeView.keyPressEvent (self, QKeyEvent event)

Reimplemented from QWidget.keyPressEvent().

QTreeView.mouseDoubleClickEvent (self, QMouseEvent e)

Reimplemented from QWidget.mouseDoubleClickEvent().

QTreeView.mouseMoveEvent (self, QMouseEvent event)

Reimplemented from QWidget.mouseMoveEvent().

QTreeView.mousePressEvent (self, QMouseEvent e)

Reimplemented from QWidget.mousePressEvent().

QTreeView.mouseReleaseEvent (self, QMouseEvent event)

Reimplemented from QWidget.mouseReleaseEvent().

QModelIndex QTreeView.moveCursor (self, QAbstractItemView.CursorAction cursorAction, Qt.KeyboardModifiers modifiers)

Reimplemented from QAbstractItemView.moveCursor().

Move the cursor in the way described by cursorAction, using the information provided by the button modifiers.

QTreeView.paintEvent (self, QPaintEvent e)

Reimplemented from QWidget.paintEvent().

QTreeView.reexpand (self)

This method is also a Qt slot with the C++ signature void reexpand().

QTreeView.reset (self)

Reimplemented from QAbstractItemView.reset().

QTreeView.resizeColumnToContents (self, int column)

This method is also a Qt slot with the C++ signature void resizeColumnToContents(int).

Resizes the column given to the size of its contents.

See also columnWidth() and setColumnWidth().

bool QTreeView.rootIsDecorated (self)

int QTreeView.rowHeight (self, QModelIndex index)

Returns the height of the row indicated by the given index.

This function was introduced in Qt 4.3.

See also indexRowSizeHint().

QTreeView.rowsAboutToBeRemoved (self, QModelIndex parent, int start, int end)

Reimplemented from QAbstractItemView.rowsAboutToBeRemoved().

Informs the view that the rows from the start row to the end row inclusive are about to removed from the given parent model item.

QTreeView.rowsInserted (self, QModelIndex parent, int start, int end)

Reimplemented from QAbstractItemView.rowsInserted().

Informs the view that the rows from the start row to the end row inclusive have been inserted into the parent model item.

QTreeView.rowsRemoved (self, QModelIndex parent, int first, int last)

This method is also a Qt slot with the C++ signature void rowsRemoved(const QModelIndex&,int,int).

Informs the view that the rows from the start row to the end row inclusive have been removed from the given parent model item.

This function was introduced in Qt 4.1.

QTreeView.scrollContentsBy (self, int dx, int dy)

Reimplemented from QAbstractScrollArea.scrollContentsBy().

Scrolls the contents of the tree view by (dx, dy).

QTreeView.scrollTo (self, QModelIndex index, QAbstractItemView.ScrollHint hint = QAbstractItemView.EnsureVisible)

Reimplemented from QAbstractItemView.scrollTo().

Scroll the contents of the tree view until the given model item index is visible. The hint parameter specifies more precisely where the item should be located after the operation. If any of the parents of the model item are collapsed, they will be expanded to ensure that the model item is visible.

QTreeView.selectAll (self)

This method is also a Qt slot with the C++ signature void selectAll().

Reimplemented from QAbstractItemView.selectAll().

list-of-QModelIndex QTreeView.selectedIndexes (self)

Reimplemented from QAbstractItemView.selectedIndexes().

QTreeView.selectionChanged (self, QItemSelection selected, QItemSelection deselected)

Reimplemented from QAbstractItemView.selectionChanged().

QTreeView.setAllColumnsShowFocus (self, bool enable)

QTreeView.setAnimated (self, bool enable)

QTreeView.setAutoExpandDelay (self, int delay)

QTreeView.setColumnHidden (self, int column, bool hide)

If hide is true the column is hidden, otherwise the column is shown.

See also isColumnHidden(), hideColumn(), and setRowHidden().

QTreeView.setColumnWidth (self, int column, int width)

Sets the width of the given column to the width specified.

This function was introduced in Qt 4.2.

See also columnWidth() and resizeColumnToContents().

QTreeView.setExpanded (self, QModelIndex index, bool expand)

Sets the item referred to by index to either collapse or expanded, depending on the value of expanded.

See also expanded(), expand(), and isExpanded().

QTreeView.setExpandsOnDoubleClick (self, bool enable)

QTreeView.setFirstColumnSpanned (self, int row, QModelIndex parent, bool span)

If span is true the item in the first column in the row with the given parent is set to span all columns, otherwise all items on the row are shown.

This function was introduced in Qt 4.3.

See also isFirstColumnSpanned().

QTreeView.setHeader (self, QHeaderView header)

The header argument has it's ownership transferred to Qt.

Sets the header for the tree view, to the given header.

The view takes ownership over the given header and deletes it when a new header is set.

See also QAbstractItemModel.headerData().

QTreeView.setHeaderHidden (self, bool hide)

QTreeView.setIndentation (self, int i)

QTreeView.setItemsExpandable (self, bool enable)

QTreeView.setModel (self, QAbstractItemModel model)

Reimplemented from QAbstractItemView.setModel().

QTreeView.setRootIndex (self, QModelIndex index)

Reimplemented from QAbstractItemView.setRootIndex().

QTreeView.setRootIsDecorated (self, bool show)

QTreeView.setRowHidden (self, int row, QModelIndex parent, bool hide)

If hide is true the row with the given parent is hidden, otherwise the row is shown.

See also isRowHidden() and setColumnHidden().

QTreeView.setSelection (self, QRect rect, QItemSelectionModel.SelectionFlags command)

Reimplemented from QAbstractItemView.setSelection().

Applies the selection command to the items in or touched by the rectangle, rect.

See also selectionCommand().

QTreeView.setSelectionModel (self, QItemSelectionModel selectionModel)

Reimplemented from QAbstractItemView.setSelectionModel().

QTreeView.setSortingEnabled (self, bool enable)

QTreeView.setUniformRowHeights (self, bool uniform)

QTreeView.setWordWrap (self, bool on)

QTreeView.showColumn (self, int column)

This method is also a Qt slot with the C++ signature void showColumn(int).

Shows the given column in the tree view.

See also hideColumn() and setColumnHidden().

int QTreeView.sizeHintForColumn (self, int column)

Reimplemented from QAbstractItemView.sizeHintForColumn().

Returns the size hint for the column's width or -1 if there is no model.

If you need to set the width of a given column to a fixed value, call QHeaderView.resizeSection() on the view's header.

If you reimplement this function in a subclass, note that the value you return is only used when resizeColumnToContents() is called. In that case, if a larger column width is required by either the view's header or the item delegate, that width will be used instead.

See also QWidget.sizeHint and header().

QTreeView.sortByColumn (self, int column)

This method is also a Qt slot with the C++ signature void sortByColumn(int).

Sets the model up for sorting by the values in the given column and order.

column may be -1, in which case no sort indicator will be shown and the model will return to its natural, unsorted order. Note that not all models support this and may even crash in this case.

This function was introduced in Qt 4.2.

See also sortingEnabled.

QTreeView.sortByColumn (self, int column, Qt.SortOrder order)

QTreeView.timerEvent (self, QTimerEvent event)

Reimplemented from QObject.timerEvent().

bool QTreeView.uniformRowHeights (self)

QTreeView.updateGeometries (self)

Reimplemented from QAbstractItemView.updateGeometries().

int QTreeView.verticalOffset (self)

Reimplemented from QAbstractItemView.verticalOffset().

Returns the vertical offset of the items in the tree view.

See also horizontalOffset().

bool QTreeView.viewportEvent (self, QEvent event)

Reimplemented from QAbstractScrollArea.viewportEvent().

QRect QTreeView.visualRect (self, QModelIndex index)

Reimplemented from QAbstractItemView.visualRect().

Returns the rectangle on the viewport occupied by the item at index. If the index is not visible or explicitly hidden, the returned rectangle is invalid.

QRegion QTreeView.visualRegionForSelection (self, QItemSelection selection)

Reimplemented from QAbstractItemView.visualRegionForSelection().

Returns the rectangle from the viewport of the items in the given selection.

Since 4.7, the returned region only contains rectangles intersecting (or included in) the viewport.

bool QTreeView.wordWrap (self)


Qt Signal Documentation

void collapsed (const QModelIndex&)

This is the default overload of this signal.

This signal is emitted when the item specified by index is collapsed.

void expanded (const QModelIndex&)

This is the default overload of this signal.

This signal is emitted when the item specified by index is expanded.

See also setExpanded().


PyQt 4.11.2 for X11Copyright © Riverbank Computing Ltd and Digia 2014Qt 4.8.6