目录
前言
在Qt Quick Controls中，TreeViewDelegate是一个专为树形视图设计的委托控件，它能够高效地渲染树状数据结构，并提供丰富的交互功能。本文将从控件简介、属性说明、应用示例来解析这一组件的特性与使用方法。
1. 控件简介
TreeViewDelegate是Qt 6.3版本引入的QML类型，继承自ItemDelegate，专用于TreeView组件的委托渲染。它通过以下三部分构成树节点的可视化元素：
- 背景：定义节点的背景样式。
- 内容项：显示节点的主内容（如文本或图标）。
- 指示器：用于展开/折叠子节点的交互控件（默认显示三角形图标）。
其核心功能包括：
- 自动缩进：根据节点的depth属性自动调整内容项和指示器的位置，形成树状层次结构。
- 平台样式集成：遵循应用程序运行环境的原生样式，确保视觉一致性。
- 交互支持：内置点击信号（如clicked）和编辑功能，支持自定义扩展。
2. 属性说明
TreeViewDelegate提供了丰富的属性，用于控制树节点的渲染与交互逻辑。以下是关键属性的分类解析：
2.1 布局与缩进
| 属性名 | 类型 | 说明 |
|---|---|---|
| depth | int | 当前节点的深度（祖先节点数量） |
| indentation | real | 子节点相对于父节点的水平缩进量（默认20像素） |
| leftMargin | real | 视图左边缘到指示器左边缘的间距。 |
| rightMargin | real | 视图右边缘到内容项右边缘的间距 |
2.2 状态与交互
| 属性名 | 类型 | 说明 |
|---|---|---|
| current | bool | 是否代表选择模型中的当前索引 |
| selected | bool | 是否被选中 |
| expanded | bool | 节点是否已展开（仅对树列有效） |
| hasChildren | bool | 节点是否包含子节点 |
| editing | bool | 是否处于编辑状态（Qt 6.5新增） |
2.3 自定义控制
| 属性名 | 类型 | 说明 |
|---|---|---|
| indicator | Component | 自定义展开/折叠指示器（需手动计算x位置） |
| treeView | TreeView | 关联的TreeView实例 |
3. 示例及描述
使用官方示例tableofcontents作为示例，如图所示：
3.1 treeitem部分
以下代码是 TreeItem 类的实现部分，它定义了如何构造 TreeItem 对象以及如何操作树形结构中的节点。
treeitem头文件：
#ifndef TREEITEM_H
#define TREEITEM_H
#include <QVariant>
#include <QList>
#include <memory>
class TreeItem
{
public:
explicit TreeItem(QVariantList data, TreeItem *parentItem = nullptr);
void appendChild(std::unique_ptr<TreeItem> &&child);
TreeItem *child(int row);
int childCount() const;
int columnCount() const;
QVariant data(int column) const;
int row() const;
TreeItem *parentItem();
private:
std::vector<std::unique_ptr<TreeItem>> m_childItems;
QVariantList m_itemData;
TreeItem *m_parentItem;
};
#endif // TREEITEM_H
treeitem源文件：
#include "treeitem.h"
TreeItem::TreeItem(QVariantList data, TreeItem *parent)
: m_itemData(std::move(data)), m_parentItem(parent)
{}
void TreeItem::appendChild(std::unique_ptr<TreeItem> &&child)
{
m_childItems.push_back(std::move(child));
}
TreeItem *TreeItem::child(int row)
{
return row >= 0 && row < childCount() ? m_childItems.at(row).get() : nullptr;
}
int TreeItem::childCount() const
{
return int(m_childItems.size());
}
int TreeItem::columnCount() const
{
return int(m_itemData.count());
}
QVariant TreeItem::data(int column) const
{
return m_itemData.value(column);
}
TreeItem *TreeItem::parentItem()
{
return m_parentItem;
}
int TreeItem::row() const
{
if (m_parentItem == nullptr)
return 0;
const auto it = std::find_if(m_parentItem->m_childItems.cbegin(), m_parentItem->m_childItems.cend(),
[this](const std::unique_ptr<TreeItem> &treeItem) {
return treeItem.get() == this;
});
if (it != m_parentItem->m_childItems.cend())
return std::distance(m_parentItem->m_childItems.cbegin(), it);
Q_ASSERT(false); // should not happen
return -1;
}
这段代码实现了一个树形结构中的节点类 TreeItem，提供了节点的基本操作，包括添加子节点、获取子节点、获取子节点数量、获取数据列数、获取指定列的数据、获取父节点以及获取当前节点在其父节点中的行号。它使用了 C++11 的移动语义和智能指针来优化性能和管理内存。
3.2 treemodel模型部分
以下这段代码实现了一个 TreeModel 类，它继承自 QAbstractItemModel，并使用 TreeItem 类来构建一个树形数据结构。TreeModel 主要用于为 Qt 的视图组件（如 TreeView）提供数据。
treemodel头文件：
#ifndef TREEMODEL_H
#define TREEMODEL_H
#include <QAbstractItemModel>
#include <QModelIndex>
#include <QVariant>
#include <QQmlEngine>
class TreeItem;
class TreeModel : public QAbstractItemModel
{
Q_OBJECT
QML_NAMED_ELEMENT(TreeModel)
public:
Q_DISABLE_COPY_MOVE(TreeModel)
explicit TreeModel(QObject *parent = nullptr);
~TreeModel() override;
QVariant data(const QModelIndex &index, int role) const override;
Qt::ItemFlags flags(const QModelIndex &index) const override;
QVariant headerData(int section, Qt::Orientation orientation,
int role = Qt::DisplayRole) const override;
QModelIndex index(int row, int column,
const QModelIndex &parent = {}) const override;
QModelIndex parent(const QModelIndex &index) const override;
int rowCount(const QModelIndex &parent = {}) const override;
int columnCount(const QModelIndex &parent = {}) const override;
private:
static void setupModelData(const QList<QStringView> &lines, TreeItem *parent);
std::unique_ptr<TreeItem> rootItem;
};
#endif // TREEMODEL_H
treemodel源文件：
#include "treemodel.h"
#include "treeitem.h"
#include <QFile>
#include <QStringList>
#include <QStack>
using namespace Qt::StringLiterals;
TreeModel::TreeModel(QObject *parent)
: QAbstractItemModel(parent)
, rootItem(std::make_unique<TreeItem>(QVariantList{tr("Title"), tr("Summary")}))
{
QFile file(":/content.txt"_L1);
file.open(QIODevice::ReadOnly | QIODevice::Text);
setupModelData(QStringView{QString::fromUtf8(file.readAll())}.split(u'\n'), rootItem.get());
file.close();
}
TreeModel::~TreeModel() = default;
int TreeModel::columnCount(const QModelIndex &parent) const
{
if (parent.isValid())
return static_cast<TreeItem*>(parent.internalPointer())->columnCount();
return rootItem->columnCount();
}
QVariant TreeModel::data(const QModelIndex &index, int role) const
{
if (!index.isValid() || role != Qt::DisplayRole)
return {};
const auto *item = static_cast<const TreeItem*>(index.internalPointer());
return item->data(index.column());
}
Qt::ItemFlags TreeModel::flags(const QModelIndex &index) const
{
return index.isValid()
? QAbstractItemModel::flags(index) : Qt::ItemFlags(Qt::NoItemFlags);
}
QVariant TreeModel::headerData(int section, Qt::Orientation orientation,
int role) const
{
return orientation == Qt::Horizontal && role == Qt::DisplayRole
? rootItem->data(section) : QVariant{};
}
QModelIndex TreeModel::index(int row, int column, const QModelIndex &parent) const
{
if (!hasIndex(row, column, parent))
return {};
TreeItem *parentItem = parent.isValid()
? static_cast<TreeItem*>(parent.internalPointer())
: rootItem.get();
if (auto *childItem = parentItem->child(row))
return createIndex(row, column, childItem);
return {};
}
QModelIndex TreeModel::parent(const QModelIndex &index) const
{
if (!index.isValid())
return {};
auto *childItem = static_cast<TreeItem*>(index.internalPointer());
TreeItem *parentItem = childItem->parentItem();
return parentItem != rootItem.get()
? createIndex(parentItem->row(), 0, parentItem) : QModelIndex{};
}
int TreeModel::rowCount(const QModelIndex &parent) const
{
if (parent.column() > 0)
return 0;
const TreeItem *parentItem = parent.isValid()
? static_cast<const TreeItem*>(parent.internalPointer())
: rootItem.get();
return parentItem->childCount();
}
void TreeModel::setupModelData(const QList<QStringView> &lines, TreeItem *parent)
{
struct ParentIndentation
{
TreeItem *parent;
qsizetype indentation;
};
QStack<ParentIndentation> state;
state.push({parent, 0});
for (const auto &line : lines) {
qsizetype position = 0;
for ( ; position < line.length() && line.at(position).isSpace(); ++position) {
}
const QStringView lineData = line.sliced(position).trimmed();
if (!lineData.isEmpty()) {
// Read the column data from the rest of the line.
const auto columnStrings = lineData.split(u'\t', Qt::SkipEmptyParts);
QVariantList columnData;
columnData.reserve(columnStrings.count());
for (const auto &columnString : columnStrings)
columnData << columnString.toString();
if (position > state.top().indentation) {
// The last child of the current parent is now the new parent
// unless the current parent has no children.
auto *lastParent = state.top().parent;
if (lastParent->childCount() > 0)
state.push({lastParent->child(lastParent->childCount() - 1), position});
} else {
while (position < state.top().indentation && !state.isEmpty())
state.pop();
}
// Append a new item to the current parent's list of children.
auto *lastParent = state.top().parent;
lastParent->appendChild(std::make_unique<TreeItem>(columnData, lastParent));
}
}
}
这段代码实现了一个树形数据模型 TreeModel，它通过解析文本文件中的数据来构建树形结构。TreeModel 继承自 QAbstractItemModel，并重写了必要的方法（如 columnCount、data、flags、headerData、index、parent 和 rowCount），以满足 Qt 视图组件（如 TreeView）的需求。setupModelData 方法通过分析文本行的缩进级别来构建树形结构，支持多列数据。
4. 关于宏定义
4.1 QML_NAMED_ELEMENT
QML_NAMED_ELEMENT 宏的主要作用是将一个 C++ 类注册为 QML 中的一个可使用的元素，并为其指定一个名称。这个名称可以在 QML 文件中直接使用，就像使用内置的 QML 元素（如 Rectangle、Text 等）一样。
与旧宏的区别
在 Qt 5 中，通常使用 qmlRegisterType 函数来注册自定义类型。QML_NAMED_ELEMENT 宏是 Qt 6 中引入的更现代的替代方案，它提供了更好的模块化支持和编译时检查。
4.2 Q_DISABLE_COPY_MOVE
在 C++ 中，类默认会生成默认的复制构造函数、复制赋值运算符、移动构造函数和移动赋值运算符。这些默认生成的函数可能会导致不期望的行为，尤其是在类管理动态内存或其他资源时。Q_DISABLE_COPY_MOVE 宏通过将这些函数标记为删除（= delete），来禁用它们。
未完待续，接下来说明在qml中如何使用
扫一扫
1038
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
