Класс QTreeWidget

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

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

Свойства

• columnCount : int
• topLevelItemCount : const int

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

Общедоступные функции

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

• 52 общедоступных функций унаследовано от QTreeView
• 59 общедоступных функций унаследовано от QAbstractItemView
• 20 общедоступных функций унаследовано от QAbstractScrollArea
• 14 общедоступных функций унаследовано от QFrame
• 214 общедоступных функций унаследовано от QWidget
• 32 общедоступных функций унаследовано от QObject
• 14 общедоступных функций унаследовано от QPaintDevice

Общедоступные слоты

• 8 public slots унаследованных от QTreeView
• 9 public slots унаследованных от QAbstractItemView
• 19 public slots унаследованных от QWidget
• 1 public slot унаследованного от QObject

Сигналы

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

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

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

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

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

• 5 статических публичных членов унаследованных от QWidget
• 11 статических публичных членов унаследованных от QObject
• 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, Model/View Programming и Settings Editor Example.

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

QTreeWidget::QTreeWidget(QWidget *parent = Q_NULLPTR)

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

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

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

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

Переопределено из QWidget::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, если он редактируем.

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

Переопределено из QObject::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().

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

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

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

void QTreeWidget::setHeaderLabels(const QStringList &метки)

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

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

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

void QTreeWidget::setItemWidget(QTreeWidgetItem *элемент, int столбец, QWidget *виджет)

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

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

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

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

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

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

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

[virtual] void QTreeWidget::setSelectionModel(QItemSelectionModel *selectionModel)

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

int QTreeWidget::sortColumn() const

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

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

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

void QTreeWidget::sortItems(int столбец, Qt::SortOrder порядок)

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

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

[virtual protected] Qt::DropActions QTreeWidget::supportedDropActions() const

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

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

QTreeWidgetItem *QTreeWidget::takeTopLevelItem(int индекс)

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

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

QTreeWidgetItem *QTreeWidget::topLevelItem(int индекс) const

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

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

QRect QTreeWidget::visualItemRect(const QTreeWidgetItem *элемент) const

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

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