Класс QTreeView

Класс QTreeView предоставляет реализацию представления дерева по умолчанию на основе модели/представления. Подробнее...

• Список всех членов, включая унаследованные

Свойства

Открытые функции

Переопределённые открытые функции

Открытые слоты

Сигналы

Защищенные функции

Переопределённые защищенные функции

Защищенные слоты

Подробное описание

Класс QTreeView реализует древовидное представление элементов из модели. Этот класс используется для предоставления стандартных иерархических списков, которые ранее предоставлялись классом QListView, но с использованием более гибкого подхода, предоставляемого архитектурой моделей/представлений Qt.

Класс QTreeView является одним из классов модели/представления и входит в состав фреймворка модели/представления Qt.

QTreeView реализует интерфейсы, определённые классом QAbstractItemView, что позволяет ему отображать данные, предоставляемые моделями, производными от класса QAbstractItemModel.

Легко создать вид дерева, отображающий данные из модели. В следующем примере содержимое каталога предоставляется моделью QFileSystemModel и отображается как дерево:

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

Архитектура модели/представления гарантирует, что содержимое дерева отображается обновлённым при изменении модели.

Элементы, имеющие дочерние элементы, могут находиться в развёрнутом (дети видны) или свёрнутом (дети скрыты) состоянии. При изменении этого состояния генерируется сигнал collapsed() или expanded() с индексом модели соответствующего элемента.

Количество отступов, используемых для обозначения уровней иерархии, контролируется свойством отступ.

Заголовки в древовидных представлениях создаются с использованием класса QHeaderView и могут быть скрыты с помощью header()->hide(). Обратите внимание, что каждый заголовок настроен со свойством stretchLastSection, установленным в значение true, что гарантирует, что представление не будет тратить никакое пространство, выделенное для заголовка. Если это значение установлено в значение true, это свойство переопределит режим изменения размера, заданный для последнего раздела в заголовке.

По умолчанию все столбцы в древовидном представлении перемещаемы, за исключением первого. Чтобы отключить перемещение этих столбцов, используйте функцию QHeaderView's setSectionsMovable(). Более подробную информацию о переупорядочивании разделов см. в разделе Перемещение разделов заголовка.

Клавиши

QTreeView поддерживает набор клавишных сочетаний, которые позволяют пользователю перемещаться по представлению и взаимодействовать с содержимым элементов:

Повышение производительности

Можно предоставить представлению подсказки о данных, которые оно обрабатывает, чтобы повысить его производительность при отображении большого количества элементов. Один из подходов для представлений, предназначенных для отображения элементов с одинаковой высотой, заключается в установке свойства uniformRowHeights в значение true.

См. также QListView, QTreeWidget, Классы представлений, QAbstractItemModel, QAbstractItemView и Пример Dir View.

Документация функций-членов

QTreeView::QTreeView(QWidget *parent = nullptr)

Создает представление дерева с parent для представления данных модели. Используйте setModel() для задания модели.

См. также QAbstractItemModel.

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

Сворачивает элемент модели, заданный с помощью index.

См. также collapsed().

[slot] void QTreeView::collapseAll()

Сворачивает все раскрытые элементы.

См. также expandAll(), expand(), collapse() и setExpanded().

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

Этот сигнал излучается, когда элемент, указанный параметром index, сворачивается.

[protected slot] void QTreeView::columnCountChanged(int oldCount, int newCount)

Сообщает вид дерева о том, что количество столбцов в представлении дерева изменилось с oldCount на newCount.

[protected slot] void QTreeView::columnMoved()

Этот слот вызывается всякий раз, когда столбец был перемещен.

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

Эта функция вызывается всякий раз, когда изменяется размер столбца column в заголовке. oldSize и newSize содержат предыдущий и новый размеры в пикселях.

См. также setColumnWidth().

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

Развертывает элемент модели, указанный параметром index.

См. также expanded().

[slot] void QTreeView::expandAll()

Развертывает все разворачиваемые элементы.

См. также collapseAll(), expand(), collapse() и setExpanded().

[slot, since 5.13] void QTreeView::expandRecursively(const QModelIndex &index, int depth = -1)

Развертывает элемент по указанному index и всех его потомков до заданной depth. depth относится к элементу по index. Значение depth равное -1 развернет всех потомков, значение 0 развернет только указанный index.

Эта функция была добавлена в Qt 5.13.

См. также expandAll().

[slot] void QTreeView::expandToDepth(int depth)

Развертывает все разворачиваемые элементы до указанной depth.

См. также expandAll(), collapseAll(), expand(), collapse() и setExpanded().

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

Этот сигнал излучается, когда элемент, указанный параметром index, развертывается.

См. также setExpanded().

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

Скрывает указанный столбец column.

См. также showColumn() и setColumnHidden().

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

Изменяет размер указанного столбца column до размера его содержимого.

См. также columnWidth(), setColumnWidth(), sizeHintForColumn() и QHeaderView::resizeContentsPrecision().

[protected slot] void QTreeView::rowsRemoved(const QModelIndex &parent, int start, int end)

Сообщает представлению, что строки от start-ой до end-ой включительно были удалены из указанного родительского элемента модели parent.

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

Отображает указанный столбец column в представлении дерева.

См. также hideColumn() и setColumnHidden().

[slot] void QTreeView::sortByColumn(int column, Qt::SortOrder order)

Сортирует модель по значениям в указанном column и порядке order.

column может быть -1, в этом случае индикатор сортировки не будет отображен, и модель вернётся к своему естественному, несортированному порядку. Обратите внимание, что не все модели поддерживают это и даже могут аварийно завершить работу в этом случае.

См. также sortingEnabled.

[virtual] QTreeView::~QTreeView()

Уничтожает представление дерева.

[override virtual protected] void QTreeView::changeEvent(QEvent *event)

Переопределяет: QFrame::changeEvent(QEvent *ev).

int QTreeView::columnAt(int x) const

Возвращает столбец в представлении дерева, заголовок которого покрывает заданную координату x.

int QTreeView::columnViewportPosition(int column) const

Возвращает горизонтальную позицию столбца column в области просмотра.

int QTreeView::columnWidth(int column) const

Возвращает ширину столбца column.

См. также resizeColumnToContents() и setColumnWidth().

[override virtual protected] void QTreeView::currentChanged(const QModelIndex &current, const QModelIndex &previous)

Переопределяет: QAbstractItemView::currentChanged(const QModelIndex &current, const QModelIndex &previous).

[override virtual] void QTreeView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList<int> &roles = QList<int>())

Переопределяет: QAbstractItemView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList<int> &roles).

[override virtual protected] void QTreeView::dragMoveEvent(QDragMoveEvent *event)

Переопределяет: QAbstractItemView::dragMoveEvent(QDragMoveEvent *event).

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

Рисует ветви в представлении дерева на той же строке, что и элемент модели index, используя заданный painter. Ветви рисуются в прямоугольнике, заданном rect.

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

Рисует строку в представлении дерева, содержащую элемент модели index, используя заданный painter. option управляет тем, как отображается элемент.

См. также setAlternatingRowColors().

[protected] void QTreeView::drawTree(QPainter *painter, const QRegion &region) const

Рисует часть дерева, пересекающую заданную region, используя указанный painter.

См. также paintEvent().

QHeaderView *QTreeView::header() const

Возвращает заголовок для представления дерева.

См. также setHeader() и QAbstractItemModel::headerData().

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

Переопределяет: QAbstractItemView::horizontalOffset() const.

Возвращает горизонтальное смещение элементов в дереве.

Обратите внимание, что вид дерева использует позиции горизонтальной заголовка для определения позиций столбцов в представлении.

См. также verticalOffset().

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

Возвращает индекс модели элемента, расположенного над index.

[override virtual] QModelIndex QTreeView::indexAt(const QPoint &point) const

Переопределяет: QAbstractItemView::indexAt(const QPoint &point) const.

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

Возвращает индекс модели элемента, расположенного под index.

[protected] int QTreeView::indexRowSizeHint(const QModelIndex &index) const

Возвращает размер подсказки для строки, указанной index.

См. также sizeHintForColumn() и uniformRowHeights().

bool QTreeView::isColumnHidden(int column) const

Возвращает true, если столбец column скрыт; в противном случае возвращает false.

См. также hideColumn() и isRowHidden().

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

Возвращает true, если элемент модели index развернут; в противном случае возвращает false.

См. также expand(), expanded() и setExpanded().

bool QTreeView::isFirstColumnSpanned(int row, const QModelIndex &parent) const

Возвращает true, если элемент в первом столбце в заданной row родительского элемента parent охватывает все столбцы; в противном случае возвращает false.

См. также setFirstColumnSpanned().

[override virtual protected] bool QTreeView::isIndexHidden(const QModelIndex &index) const

Переопределяет: QAbstractItemView::isIndexHidden(const QModelIndex &index) const.

bool QTreeView::isRowHidden(int row, const QModelIndex &parent) const

Возвращает true, если элемент в заданной row родительского элемента parent скрыт; в противном случае возвращает false.

См. также setRowHidden() и isColumnHidden().

[override virtual protected] void QTreeView::keyPressEvent(QKeyEvent *event)

Переопределяет: QAbstractItemView::keyPressEvent(QKeyEvent *event).

[override virtual] void QTreeView::keyboardSearch(const QString &search)

Переопределяет: QAbstractItemView::keyboardSearch(const QString &search).

[override virtual protected] void QTreeView::mouseDoubleClickEvent(QMouseEvent *event)

Переопределяет: QAbstractItemView::mouseDoubleClickEvent(QMouseEvent *event).

[override virtual protected] void QTreeView::mouseMoveEvent(QMouseEvent *event)

Переопределяет: QAbstractItemView::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QTreeView::mousePressEvent(QMouseEvent *event)

Переопределяет: QAbstractItemView::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QTreeView::mouseReleaseEvent(QMouseEvent *event)

Переопределяет: QAbstractItemView::mouseReleaseEvent(QMouseEvent *event).

[override virtual protected] QModelIndex QTreeView::moveCursor(QAbstractItemView::CursorAction cursorAction, Qt::KeyboardModifiers modifiers)

Переопределяет: QAbstractItemView::moveCursor(QAbstractItemView::CursorAction cursorAction, Qt::KeyboardModifiers modifiers).

Перемещает курсор в соответствии с cursorAction, используя информацию, предоставленную кнопкой modifiers.

[override virtual protected] void QTreeView::paintEvent(QPaintEvent *event)

Переопределяет: QAbstractScrollArea::paintEvent(QPaintEvent *event).

[override virtual] void QTreeView::reset()

Переопределяет: QAbstractItemView::reset().

[protected] int QTreeView::rowHeight(const QModelIndex &index) const

Возвращает высоту строки, указанной данным index.

См. также indexRowSizeHint().

[override virtual protected] void QTreeView::rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end)

Переопределяет: QAbstractItemView::rowsAboutToBeRemoved(const QModelIndex &parent, int start, int end).

Сообщает представлению, что строки от start строки до end строки включительно, будут удалены из заданного родительского элемента модели parent.

[override virtual protected] void QTreeView::rowsInserted(const QModelIndex &parent, int start, int end)

Переопределяет: QAbstractItemView::rowsInserted(const QModelIndex &parent, int start, int end).

Сообщает представлению, что строки от start строки до end строки включительно были вставлены в родительский элемент модели parent.

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

Переопределяет: QAbstractScrollArea::scrollContentsBy(int dx, int dy).

Прокручивает содержимое дерева на (dx, dy).

[override virtual] void QTreeView::scrollTo(const QModelIndex &index, QAbstractItemView::ScrollHint hint = EnsureVisible)

Переопределяет: QAbstractItemView::scrollTo(const QModelIndex &index, QAbstractItemView::ScrollHint hint).

Прокручивает содержимое дерева до тех пор, пока указанный элемент модели index не станет видимым. Параметр hint более точно указывает, где должен находиться элемент после операции. Если какие-либо из родителей элемента модели свернуты, они будут развернуты, чтобы гарантировать видимость элемента модели.

[override virtual] void QTreeView::selectAll()

Переопределяет: QAbstractItemView::selectAll().

[override virtual protected] QModelIndexList QTreeView::selectedIndexes() const

Переопределяет: QAbstractItemView::selectedIndexes() const.

[override virtual protected] void QTreeView::selectionChanged(const QItemSelection &selected, const QItemSelection &deselected)

Переопределяет: QAbstractItemView::selectionChanged(const QItemSelection &selected, const QItemSelection &deselected).

void QTreeView::setColumnHidden(int column, bool hide)

Если hide равно true, то столбец column скрывается, в противном случае — отображается.

См. также isColumnHidden(), hideColumn() и setRowHidden().

void QTreeView::setColumnWidth(int column, int width)

Устанавливает ширину заданного столбца column в значение width.

См. также columnWidth() и resizeColumnToContents().

void QTreeView::setExpanded(const QModelIndex &index, bool expanded)

Устанавливает элемент, на который указывает index, в состояние свёрнутости или развернутости в зависимости от значения expanded.

См. также expanded(), expand() и isExpanded().

void QTreeView::setFirstColumnSpanned(int row, const QModelIndex &parent, bool span)

Если span равно true, то элемент в первом столбце строки row с указанным parent устанавливается для захвата всех столбцов, в противном случае все элементы в строке row отображаются.

См. также isFirstColumnSpanned().

void QTreeView::setHeader(QHeaderView *header)

Устанавливает заголовок для дерева, задавая значение header.

Просмотр получает владение указанным header и удаляет его при установке нового заголовка.

См. также QAbstractItemModel::headerData().

[override virtual] void QTreeView::setModel(QAbstractItemModel *model)

Переопределяет: QAbstractItemView::setModel(QAbstractItemModel *model).

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

Переопределяет: QAbstractItemView::setRootIndex(const QModelIndex &index).

void QTreeView::setRowHidden(int row, const QModelIndex &parent, bool hide)

Если hide равно true, то строка row с заданным parent скрывается, в противном случае — отображается.

См. также isRowHidden() и setColumnHidden().

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

Переопределяет: QAbstractItemView::setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags flags).

Применяет команду выделения command к элементам внутри или касающимся прямоугольника rect.

См. также selectionCommand().

[override virtual] void QTreeView::setSelectionModel(QItemSelectionModel *selectionModel)

Переопределяет: QAbstractItemView::setSelectionModel(QItemSelectionModel *selectionModel).

[since 5.2] void QTreeView::setTreePosition(int index)

Указывает, что структура дерева должна быть размещена в логическом индексе index. Если задано значение -1, дерево всегда следует визуальному индексу 0.

Данная функция была добавлена в Qt 5.2.

См. также treePosition(), QHeaderView::swapSections() и QHeaderView::moveSection().

[override virtual protected] int QTreeView::sizeHintForColumn(int column) const

Переопределяет: QAbstractItemView::sizeHintForColumn(int column) const.

Возвращает размерный указатель для ширины столбца column или -1, если модели нет.

Если нужно установить ширину столбца в фиксированное значение, вызовите QHeaderView::resizeSection() для заголовка просмотра.

Если вы переопределяете эту функцию в подклассе, обратите внимание, что возвращаемое значение используется только при вызове resizeColumnToContents(). В этом случае, если необходима большая ширина столбца, как заголовок просмотра, так и делегат элементов, будут использовать эту ширину.

См. также QWidget::sizeHint, header() и QHeaderView::resizeContentsPrecision().

[override virtual protected] void QTreeView::timerEvent(QTimerEvent *event)

Переопределяет: QAbstractItemView::timerEvent(QTimerEvent *event).

[since 5.2] int QTreeView::treePosition() const

Возвращает логический индекс, по которому установлено дерево. Если возвращаемое значение равно -1, дерево размещено по визуальному индексу 0.

Данная функция была добавлена в Qt 5.2.

См. также setTreePosition().

[override virtual protected] void QTreeView::updateGeometries()

Переопределяет: QAbstractItemView::updateGeometries().

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

Переопределяет: QAbstractItemView::verticalOffset() const.

Возвращает вертикальное смещение элементов в дереве.

См. также horizontalOffset().

[override virtual protected] bool QTreeView::viewportEvent(QEvent *event)

Переопределяет: QAbstractItemView::viewportEvent(QEvent *event).

[override virtual protected] QSize QTreeView::viewportSizeHint() const

Переопределяет: QAbstractItemView::viewportSizeHint() const.

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

Переопределяет: QAbstractItemView::visualRect(const QModelIndex &index) const.

Возвращает прямоугольник на области просмотра, занимаемый элементом в index. Если индекс не отображается или явно скрыт, возвращаемый прямоугольник недействителен.

[override virtual protected] QRegion QTreeView::visualRegionForSelection(const QItemSelection &selection) const

Переопределяет: QAbstractItemView::visualRegionForSelection(const QItemSelection &selection) const.

Возвращает прямоугольник из области просмотра элементов в заданном selection.

Начиная с Qt 4.7, возвращаемая область содержит только прямоугольники, пересекающиеся (или включенные в) область просмотра.