Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

QTreeView Class Reference

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

#include <QTreeView>

Inherits QAbstractItemView.

List of all members.

Writable Properties

Read-Only Properties

Public Functions

Public Slots

Signals

Static Public Members

Protected Functions

Protected Slots


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.

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 QDirModel and displayed as a tree:

    QDirModel *model = new QDirModel(QDir(), parent);
    QTreeView *tree = new QTreeView(parent);
    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.

See also Model/View Programming, QAbstractItemModel, and QAbstractItemView.


Property Documentation

indentation : int

This property holds indentation of the items in the tree view.

This property holds the indentation of the items for each level in the tree view.

Access functions:

See also setIndentation().

rootIsDecorated : bool

This property holds whether to show controls for opening and closing items.

This property holds whether root items are displayed with controls for opening and closing them.

Access functions:


Member Function Documentation

QTreeView::QTreeView ( QWidget * parent = 0 )

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

See also QAbstractItemModel.

QTreeView::~QTreeView ()

Destroys the tree view.

void QTreeView::close ( const QModelIndex & index )   [slot]

Closes the model item specified by the index.

void QTreeView::collapsed ( const QModelIndex & index )   [signal]

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

int QTreeView::columnAt ( int x ) const

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

void QTreeView::columnCountChanged ( int first, int last )   [protected slot]

Informs the tree view that the columns from the first to the last inclusive as changed.

int QTreeView::columnSizeHint ( int column ) const   [virtual protected]

Returns the size hint for the column's width.

Reimplemented from QAbstractItemView.

See also QWidget::sizeHint.

int QTreeView::columnViewportPosition ( int column ) const

Returns the horizontal position of the column in the viewport.

int QTreeView::columnWidth ( int column ) const

Returns the width of the column.

void QTreeView::columnWidthChanged ( int column, int oldSize, int newSize )   [protected slot]

Changes the column's width from the size specified by oldSize to the size specified by newSize.

void QTreeView::dataChanged ()   [protected slot]

This slot is called whenever the items in the tree view are changed.

void QTreeView::doItemsLayout ()   [virtual]

Lays out the items in the tree view.

Reimplemented from QAbstractItemView.

void QTreeView::drawBranches ( QPainter * painter, const QRect & rect, const QModelIndex & index ) const   [virtual protected]

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

void QTreeView::drawRow ( QPainter * painter, const QStyleOptionViewItem & option, const QModelIndex & index ) const   [virtual protected]

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 QStyleOptionViewItem.

void QTreeView::ensureItemVisible ( const QModelIndex & index )   [virtual]

Scroll the contents of the tree view until the given model item index is visible.

Reimplemented from QAbstractItemView.

void QTreeView::expanded ( const QModelIndex & index )   [signal]

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

QHeaderView * QTreeView::header () const

Returns the header for the tree view.

void QTreeView::hideColumn ( int column )   [slot]

Hides the column given.

See also showColumn().

int QTreeView::horizontalOffset () const   [virtual protected]

Returns the horizontal offset.

Reimplemented from QAbstractItemView.

void QTreeView::horizontalScrollbarAction ( int action )   [virtual protected]

Moves the horizontal scroll bar in the way described by the action.

Reimplemented from QAbstractItemView.

See also QScrollBar::SliderAction.

bool QTreeView::isColumnHidden ( int column ) const

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

See also hideColumn().

bool QTreeView::isOpen ( const QModelIndex & index ) const

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

QModelIndex QTreeView::itemAbove ( const QModelIndex & index ) const

Returns the model index of the item above index.

QModelIndex QTreeView::itemAt ( int x, int y ) const   [virtual]

Returns the model index of the item at point (x, y).

Reimplemented from QAbstractItemView.

QModelIndex QTreeView::itemBelow ( const QModelIndex & index ) const

Returns the model index of the item below index.

QRect QTreeView::itemViewportRect ( const QModelIndex & index ) const   [virtual]

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

Reimplemented from QAbstractItemView.

QModelIndex QTreeView::moveCursor ( QAbstractItemView::CursorAction cursorAction, Qt::ButtonState state )   [virtual protected]

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

Reimplemented from QAbstractItemView.

See also QAbstractItemView::CursorAction.

void QTreeView::open ( const QModelIndex & index )   [slot]

Opens the model item specified by the index.

void QTreeView::resizeColumnToContents ( int column, bool checkHeader = true )   [protected slot]

Resizes the column given to the size of its contents. If checkHeader is true, the contents of the header section will be taken into consideration.

void QTreeView::rowsInserted ( const QModelIndex & parent, int first, int last )   [virtual protected]

Informs the view that the rows from the first to the last inclusive have been inserted into the parent model item.

Reimplemented from QAbstractItemView.

void QTreeView::rowsRemoved ( const QModelIndex & parent, int first, int last )   [virtual protected]

Informs the view that the rows from the first to the last inclusive have been removed from the given parent model item.

Reimplemented from QAbstractItemView.

void QTreeView::scrollContentsBy ( int dx, int dy )   [virtual protected]

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

Reimplemented from QViewport.

QRect QTreeView::selectionViewportRect ( const QItemSelection & selection ) const   [virtual protected]

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

Reimplemented from QAbstractItemView.

void QTreeView::setHeader ( QHeaderView * header )

Sets the header for the tree view.

void QTreeView::setSelection ( const QRect & rect, QItemSelectionModel::SelectionFlags command )   [virtual protected]

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

Reimplemented from QAbstractItemView.

See also selectionCommand().

void QTreeView::showColumn ( int column )   [slot]

Shows the given column in the tree view.

See also hideColumn().

int QTreeView::verticalOffset () const   [virtual protected]

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

Reimplemented from QAbstractItemView.

void QTreeView::verticalScrollbarAction ( int action )   [virtual protected]

Moves the vertical scroll bar in the way described by the action.

Reimplemented from QAbstractItemView.

See also QScrollBar::SliderAction.


Copyright © 2004 Trolltech. Trademarks
Qt 4.0.0-tp1