Класс QTreeWidget

Класс QTreeWidget предоставляет виджет дерева, использующий предопределённую модель дерева. Подробнее...

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

Свойства

• columnCount : int
• topLevelItemCount : const int

• 11 свойств унаследовано от QTreeView
• 16 свойств унаследовано от QAbstractItemView
• 3 свойства унаследовано от QAbstractScrollArea
• 6 свойств унаследовано от QFrame
• 59 свойств унаследовано от QWidget
• 1 свойство унаследовано от QObject

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

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

• 52 открытых функций унаследовано от QTreeView
• 60 открытых функций унаследовано от QAbstractItemView
• 20 открытых функций унаследовано от QAbstractScrollArea
• 14 открытых функций унаследовано от QFrame
• 214 открытых функций унаследовано от QWidget
• 31 открытых функций унаследовано от QObject
• 14 открытых функций унаследовано от QPaintDevice

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

• 8 общедоступных слотов унаследовано от QTreeView
• 9 общедоступных слотов унаследовано от QAbstractItemView
• 19 общедоступных слотов унаследовано от QWidget
• 1 общедоступный слот унаследовано от QObject

Сигналы

• 2 сигнала унаследовано от QTreeView
• 7 сигналов унаследовано от QAbstractItemView
• 3 сигнала унаследовано от QWidget
• 2 сигнала унаследовано от QObject

Статические общедоступные члены

• 5 статических общедоступных членов унаследовано от QWidget
• 9 статических общедоступных членов унаследовано от QObject

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

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

• 29 защищенных функций унаследовано от QTreeView
• 38 защищенных функций унаследовано от QAbstractItemView
• 20 защищенных функций унаследовано от QAbstractScrollArea
• 4 защищенных функций унаследовано от QFrame
• 35 защищенных функций унаследовано от QWidget
• 9 защищенных функций унаследовано от QObject
• 1 защищенная функция унаследовано от QPaintDevice

Дополнительные унаследованные члены

• 4 защищенных слота унаследовано от QTreeView
• 9 защищенных слотов унаследовано от QAbstractItemView
• 1 защищенный слот унаследовано от QWidget

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

Класс QTreeWidget предоставляет виджет дерева, использующий предопределённую модель дерева.

Класс QTreeWidget — это удобный класс, который предоставляет стандартный виджет дерева с классическим интерфейсом на основе элементов, подобным тому, который используется классом QListView в Qt 3. Этот класс основан на архитектуре Qt Model/View и использует модель по умолчанию для хранения элементов, каждый из которых является QTreeWidgetItem.

Разработчики, которым не нужна гибкость модели Model/View, могут использовать этот класс для очень лёгкого создания простых иерархических списков. Более гибкий подход предполагает сочетание QTreeView со стандартной моделью элементов. Это позволяет разделить хранение данных и их представление.

В самом простом виде виджет дерева можно создать следующим образом:

QTreeWidget *treeWidget = new QTreeWidget();
treeWidget->setColumnCount(1);
QList<QTreeWidgetItem *> items;
for (int i = 0; i < 10; ++i)
    items.append(new QTreeWidgetItem((QTreeWidget*)0, QStringList(QString("item: %1").arg(i))));
treeWidget->insertTopLevelItems(0, items);

Перед добавлением элементов в виджет дерева необходимо установить количество столбцов с помощью setColumnCount(). Это позволяет каждому элементу иметь один или несколько меток или других элементов оформления. Количество используемых столбцов можно найти с помощью функции columnCount().

Дерево может иметь заголовок, содержащий раздел для каждого столбца в виджете. Наиболее простой способ установить метки для каждого раздела — предоставить список строк с помощью setHeaderLabels(), но можно создать настраиваемый заголовок с помощью QTreeWidgetItem и вставить его в дерево с помощью функции setHeaderItem().

Элементы в дереве можно сортировать по столбцу в соответствии с предопределённым порядком сортировки. Если сортировка включена, пользователь может отсортировать элементы, щелкнув по заголовку столбца. Сортировку можно включить или выключить, вызвав setSortingEnabled(). Функция isSortingEnabled() указывает, включена ли сортировка.

См. также QTreeWidgetItem, QTreeWidgetItemIterator, QTreeView, Программирование на основе модели/представления и Пример Settings Editor.

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

QTreeWidget::QTreeWidget(QWidget *parent = nullptr)

Конструирует виджет дерева с заданным parent.

[virtual] QTreeWidget::~QTreeWidget()

Удаляет виджет дерева и все его элементы.

void QTreeWidget::addTopLevelItem(QTreeWidgetItem *item)

Добавляет item в качестве элемента верхнего уровня в виджете.

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

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

void QTreeWidget::addTopLevelItems(const QList<QTreeWidgetItem *> &items)

Добавляет список items в качестве элементов верхнего уровня в виджете.

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

[slot] void QTreeWidget::clear()

Очищает виджет дерева, удаляя все его элементы и выделения.

Примечание: Поскольку каждый элемент удаляется из виджета дерева перед удалением, возвращаемое значение QTreeWidgetItem::treeWidget() станет недопустимым, если вызвано из деструктора элемента.

См. также takeTopLevelItem(), topLevelItemCount() и columnCount().

void QTreeWidget::closePersistentEditor(QTreeWidgetItem *item, int column = 0)

Закрывает постоянный редактор для item в заданном column.

Эта функция не имеет эффекта, если для данной комбинации элемента и столбца не открыт постоянный редактор.

См. также openPersistentEditor() и isPersistentEditorOpen().

[slot] void QTreeWidget::collapseItem(const QTreeWidgetItem *item)

Закрывает item. Это приводит к сворачиванию дерева, содержащего дочерние элементы элемента.

См. также expandItem(), currentItem(), itemAt() и topLevelItem().

int QTreeWidget::currentColumn() const

Возвращает текущий столбец в виджете дерева.

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

См. также setCurrentItem() и columnCount().

QTreeWidgetItem *QTreeWidget::currentItem() const

Возвращает текущий элемент в виджете дерева.

См. также setCurrentItem() и currentItemChanged().

[signal] void QTreeWidget::currentItemChanged(QTreeWidgetItem *current, QTreeWidgetItem *previous)

Этот сигнал испускается при изменении текущего элемента. Текущий элемент задан параметром current, и он заменяет предыдущий текущий элемент previous.

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

[override virtual protected] void QTreeWidget::dropEvent(QDropEvent *event)

Переопределено из QAbstractItemView::dropEvent().

[virtual protected] bool QTreeWidget::dropMimeData(QTreeWidgetItem *parent, int index, const QMimeData *data, Qt::DropAction action)

Обрабатывает data, предоставленные операцией перетаскивания, которая завершилась указанным action в index в заданном элементе parent.

Реализация по умолчанию возвращает true если опускание было обработано успешно путем декодирования данных MIME и вставки их в модель; в противном случае возвращает false.

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

void QTreeWidget::editItem(QTreeWidgetItem *item, int column = 0)

Начинает редактирование item в заданном column, если это разрешено.

[override virtual protected] bool QTreeWidget::event(QEvent *e)

Переопределено из QAbstractItemView::event().

[slot] void QTreeWidget::expandItem(const QTreeWidgetItem *item)

Развертывает item. Это приводит к развертыванию дерева, содержащего дочерние элементы элемента.

См. также collapseItem(), currentItem(), itemAt(), topLevelItem() и itemExpanded().

QList<QTreeWidgetItem *> QTreeWidget::findItems(const QString &text, Qt::MatchFlags flags, int column = 0) const

Возвращает список элементов, которые соответствуют заданному text, используя заданные flags, в заданном column.

QTreeWidgetItem *QTreeWidget::headerItem() const

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

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

[protected] QModelIndex QTreeWidget::indexFromItem(const QTreeWidgetItem *item, int column = 0) const

Возвращает QModelIndex, связанную с заданным item в заданном column.

Примечание: В версиях Qt до 5.7 эта функция принимала не-const item.

См. также itemFromIndex() и topLevelItem().

int QTreeWidget::indexOfTopLevelItem(QTreeWidgetItem *item) const

Возвращает индекс заданного элемента верхнего уровня item или -1, если элемент не найден.

См. также sortItems() и topLevelItemCount().

void QTreeWidget::insertTopLevelItem(int index, QTreeWidgetItem *item)

Вставляет item в позицию index на верхнем уровне в представлении.

Если элемент уже был вставлен в другое место, он не будет вставлен повторно.

См. также addTopLevelItem() и columnCount().

void QTreeWidget::insertTopLevelItems(int index, const QList<QTreeWidgetItem *> &items)

Вставляет список items в позицию index на верхнем уровне в представлении.

Элементы, которые уже были вставлены в другое место, не будут вставлены повторно.

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

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

QTreeWidgetItem *QTreeWidget::invisibleRootItem() const

Возвращает невидимый корневой элемент виджета дерева.

Невидимый корневой элемент предоставляет доступ к элементам верхнего уровня виджета дерева через API QTreeWidgetItem, что позволяет создавать функции, которые могут обрабатывать элементы верхнего уровня и их потомков единообразно; например, рекурсивные функции.

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

bool QTreeWidget::isFirstItemColumnSpanned(const QTreeWidgetItem *item) const

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

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

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

bool QTreeWidget::isPersistentEditorOpen(QTreeWidgetItem *item, int column = 0) const

Возвращает значение, указывающее, открыт ли постоянный редактор для элемента item в столбце column.

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

См. также openPersistentEditor() и closePersistentEditor().

QTreeWidgetItem *QTreeWidget::itemAbove(const QTreeWidgetItem *item) const

Возвращает элемент, расположенный над заданным item.

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

[signal] void QTreeWidget::itemActivated(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда пользователь активирует элемент, щелкнув по нему один или два раза (в зависимости от платформы, т.е. от подсказки стиля QStyle::SH_ItemView_ActivateItemOnSingleClick) или нажав специальную клавишу (например, Enter).

Указанный элемент item — это элемент, по которому был щелчок, или 0, если ни по какому элементу не было щелчка. Столбец column — это столбец элемента, по которому был щелчок, или -1, если ни по какому элементу не было щелчка.

QTreeWidgetItem *QTreeWidget::itemAt(const QPoint &p) const

Возвращает указатель на элемент в координатах p. Координаты относительны к области просмотра виджета дерева viewport().

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

QTreeWidgetItem *QTreeWidget::itemAt(int x, int y) const

Это перегруженная функция.

Возвращает указатель на элемент в координатах (x, y). Координаты относительны к области просмотра виджета дерева viewport().

QTreeWidgetItem *QTreeWidget::itemBelow(const QTreeWidgetItem *item) const

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

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

[signal] void QTreeWidget::itemChanged(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда содержимое столбца column в заданном элементе item изменяется.

[signal] void QTreeWidget::itemClicked(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда пользователь щелкает внутри виджета.

Указанный элемент item — это элемент, по которому был щелчок. Столбец column — это столбец элемента, по которому был щелчок. Если ни по какому элементу не было щелчка, сигнал не будет излучен.

[signal] void QTreeWidget::itemCollapsed(QTreeWidgetItem *item)

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

Примечание: Этот сигнал не будет излучен, если элемент изменяет своё состояние при вызове collapseAll().

См. также QTreeWidgetItem::isExpanded(), itemExpanded(), и collapseItem().

[signal] void QTreeWidget::itemDoubleClicked(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда пользователь дважды щелкает внутри виджета.

Указанный элемент item — это элемент, по которому был двойной щелчок, или 0, если ни по какому элементу не было двойного щелчка. Столбец column — это столбец элемента, по которому был двойной щелчок. Если ни по какому элементу не было двойного щелчка, сигнал не будет излучен.

[signal] void QTreeWidget::itemEntered(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда курсор мыши входит в элемент item над указанным столбцом column. Для работы этой функции необходимо включить отслеживание мыши в QTreeWidget.

[signal] void QTreeWidget::itemExpanded(QTreeWidgetItem *item)

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

Примечание: Этот сигнал не будет излучен, если элемент изменяет свое состояние при вызове expandAll().

См. также setItemExpanded(), QTreeWidgetItem::isExpanded(), itemCollapsed(), и expandItem().

[protected] QTreeWidgetItem *QTreeWidget::itemFromIndex(const QModelIndex &index) const

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

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

[signal] void QTreeWidget::itemPressed(QTreeWidgetItem *item, int column)

Этот сигнал излучается, когда пользователь нажимает кнопку мыши внутри виджета.

Указанный элемент item — это элемент, по которому был щелчок, или 0, если ни по какому элементу не было щелчка. Столбец column — это столбец элемента, по которому был щелчок, или -1, если ни по какому элементу не было щелчка.

[signal] void QTreeWidget::itemSelectionChanged()

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

QWidget *QTreeWidget::itemWidget(QTreeWidgetItem *item, int column) const

Возвращает виджет, отображаемый в ячейке, указанной item и заданным столбцом column.

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

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

[virtual protected] QMimeData *QTreeWidget::mimeData(const QList<QTreeWidgetItem *> items) const

Возвращает объект, содержащий сериализованное описание указанных элементов items. Формат описания элементов получен из функции mimeTypes().

Если список элементов пуст, возвращается 0, а не сериализованный пустой список.

[virtual protected] QStringList QTreeWidget::mimeTypes() const

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

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

void QTreeWidget::openPersistentEditor(QTreeWidgetItem *item, int column = 0)

Открывает постоянный редактор для элемента item в заданном столбце column.

См. также closePersistentEditor() и isPersistentEditorOpen().

void QTreeWidget::removeItemWidget(QTreeWidgetItem *item, int column)

Удаляет виджет, установленный в заданном элементе item в заданном столбце column.

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

[slot] void QTreeWidget::scrollToItem(const QTreeWidgetItem *item, QAbstractItemView::ScrollHint hint = EnsureVisible)

Обеспечивает видимость элемента item, прокручивая представление при необходимости с помощью указанной подсказки hint.

См. также currentItem(), itemAt() и topLevelItem().

QList<QTreeWidgetItem *> QTreeWidget::selectedItems() const

Возвращает список всех выбранных элементов, которые не скрыты.

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

void QTreeWidget::setCurrentItem(QTreeWidgetItem *item)

Устанавливает текущий элемент item в виджете дерева.

Если режим выбора не NoSelection, элемент также выбирается.

См. также currentItem() и currentItemChanged().

void QTreeWidget::setCurrentItem(QTreeWidgetItem *item, int column)

Устанавливает текущий элемент item в виджете дерева и текущий столбец в column.

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

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

void QTreeWidget::setCurrentItem(QTreeWidgetItem *item, int column, QItemSelectionModel::SelectionFlags command)

Устанавливает текущий элемент item в виджете дерева и текущий столбец в column, используя заданное command.

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

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

void QTreeWidget::setFirstItemColumnSpanned(const QTreeWidgetItem *item, bool span)

Устанавливает заданный элемент item для отображения только одного раздела для всех столбцов, если span имеет значение true; в противном случае элемент будет отображаться по одному разделу на столбец.

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

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

void QTreeWidget::setHeaderItem(QTreeWidgetItem *item)

Устанавливает заголовок item для виджета дерева. Метка каждого столбца в заголовке задаётся соответствующей меткой в элементе.

Виджет дерева принимает владение элементом.

См. также headerItem() и setHeaderLabels().

void QTreeWidget::setHeaderLabel(const QString &label)

То же, что и setHeaderLabels(QStringList(label)).

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

void QTreeWidget::setHeaderLabels(const QStringList &labels)

Добавляет столбец в заголовок для каждого элемента в списке labels и устанавливает метку для каждого столбца.

Обратите внимание, что setHeaderLabels() не удаляет существующие столбцы.

См. также setHeaderItem() и setHeaderLabel().

void QTreeWidget::setItemWidget(QTreeWidgetItem *item, int column, QWidget *widget)

Устанавливает заданный widget для отображения в ячейке, заданной заданным item и column.

Свойство autoFillBackground заданного widget должно быть установлено в true, в противном случае фон виджета будет прозрачным, что покажет как данные модели, так и элемент виджета дерева.

Эта функция должна использоваться только для отображения статического содержимого вместо элемента виджета дерева. Если вы хотите отобразить пользовательское динамическое содержимое или реализовать пользовательский виджет редактора, используйте QTreeView и подкласс QItemDelegate вместо этого.

Эта функция не может быть вызвана до того, как иерархия элементов будет настроена, то есть QTreeWidgetItem, который будет содержать widget, должен быть добавлен в представление до того, как widget будет установлен.

Примечание: Дерево принимает владение виджетом.

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

См. также itemWidget() и Классы делегатов.

void QTreeWidget::setSelectionModel(QItemSelectionModel *selectionModel)

Переопределено из QTreeView::setSelectionModel().

int QTreeWidget::sortColumn() const

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

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

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

void QTreeWidget::sortItems(int column, Qt::SortOrder order)

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

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

Qt::DropActions QTreeWidget::supportedDropActions() const

Возвращает действия переноса, поддерживаемые этим представлением.

См. также Qt::DropActions.

QTreeWidgetItem *QTreeWidget::takeTopLevelItem(int index)

Удаляет элемент верхнего уровня по заданному index в дереве и возвращает его, в противном случае возвращает nullptr;

См. также insertTopLevelItem(), topLevelItem(), и topLevelItemCount().

QTreeWidgetItem *QTreeWidget::topLevelItem(int index) const

Возвращает элемент верхнего уровня по заданному index или 0, если элемент не существует.

См. также topLevelItemCount() и insertTopLevelItem().

QRect QTreeWidget::visualItemRect(const QTreeWidgetItem *item) const

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

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