Класс QTreeView

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

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

Свойства

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

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

Public Slots

Signals

Protected Functions

Reimplemented Protected Functions

Protected Slots

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

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

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

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

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

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

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

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

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

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

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

Сочетания клавиш

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

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

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

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

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

QTreeView::QTreeView(QWidget *parent = nullptr)

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

См. также QAbstractItemModel.

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

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

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

[slot] void QTreeView::collapseAll()

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

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

См. также 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()

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

Предупреждение: если модель содержит большое количество элементов, выполнение этой функции займет некоторое время.

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

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

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

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

Предупреждение: если модель содержит большое количество элементов, выполнение этой функции займет некоторое время.

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

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

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

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

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

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

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

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

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

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

Скрывает указанный 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.

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

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

Отображает указанный column в дереве.

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

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

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

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

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

См. также sortingEnabled.

[virtual] QTreeView::~QTreeView()

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

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 QVector<int> &roles = QVector<int>())

Переопределяет: QAbstractItemView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<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.

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

См. также 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.

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

См. также 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.

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

См. также 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 скрывается, в противном случае столбец column отображается.

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

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

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

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

См. также 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 отображаются.

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

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

void QTreeView::setHeader(QHeaderView *header)

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

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

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

void QTreeView::setModel(QAbstractItemModel *model)

Реализует: QAbstractItemView::setModel(QAbstractItemModel *model).

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().

void QTreeView::setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags command)

Реализует: QAbstractItemView::setSelection(const QRect &rect, QItemSelectionModel::SelectionFlags flags).

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

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

void QTreeView::setSelectionModel(QItemSelectionModel *selectionModel)

Реализует: QAbstractItemView::setSelectionModel(QItemSelectionModel *selectionModel).

void QTreeView::setTreePosition(int index)

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

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

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

int QTreeView::sizeHintForColumn(int column) const

Реализует: QAbstractItemView::sizeHintForColumn(int column) const.

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

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

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

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

void QTreeView::timerEvent(QTimerEvent *event)

Реализует: QAbstractItemView::timerEvent(QTimerEvent *event).

int QTreeView::treePosition() const

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

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

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

void QTreeView::updateGeometries()

Реализует: QAbstractItemView::updateGeometries().

int QTreeView::verticalOffset() const

Реализует: QAbstractItemView::verticalOffset() const.

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

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

bool QTreeView::viewportEvent(QEvent *event)

Реализует: QAbstractItemView::viewportEvent(QEvent *event).

QSize QTreeView::viewportSizeHint() const

Реализует: QAbstractItemView::viewportSizeHint() const.

QRect QTreeView::visualRect(const QModelIndex &index) const

Реализует: QAbstractItemView::visualRect(const QModelIndex &index) const.

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

QRegion QTreeView::visualRegionForSelection(const QItemSelection &selection) const

Реализует: QAbstractItemView::visualRegionForSelection(const QItemSelection &selection) const.

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

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