如何使用 Q_PROPERTY 公开自定义对象列表

Question

我有一个非常简单的类，有 2 个属性；键和值：

KeyValue.h：

class KeyValue : public QObject
{
  Q_OBJECT
  Q_PROPERTY(QString key READ getKey WRITE setKey NOTIFY keyChanged)
  Q_PROPERTY(QString value READ getValue WRITE setValue NOTIFY valueChanged)

 public:
  KeyValue(const QString& key, const QString& value, QObject* parent = 0);  

 signals:
  void keyChanged();
  void valueChanged();

 private:
  QString _key;
  QString _value;

  QString getKey() const;
  QString getValue() const;

  void setKey(const QString& key);  
  void setValue(const QString& value);
};
Q_DECLARE_METATYPE(KeyValue)

在另一个类中，我想要一个包含 KeyValue 对象列表的属性，因此我可以将此列表用作 QML 中的模型。

Controller.h

class Controller : public QObject
{
  Q_OBJECT
  Q_PROPERTY(QList<KeyValue*> items READ getItems NOTIFY itemsChanged)

 public:
  explicit Controller(QObject* parent = 0);

 signals:
  void itemsChanged(); 

 private:
  QList<KeyValue*> getItems() const;
};

我希望能够通过以下方式在 QML 中使用它：

import QtQuick 2.7
import customqml 1.0

Item{
  Controller{
    id: controller
  }
  Repeater{
    model: controller.items
    Text{
      text: modelData.key + ": " + modelData.value
    }
  }
}

这两个类都在我的 main.cpp 文件中注册：

qmlRegisterType<KeyValue>("customqml", 1, 0, "KeyValue");
qmlRegisterType<Controller>("customqml", 1, 0, "Controller");

上面的代码不起作用，因为我显然不能将 QList 直接暴露给 QML。我曾尝试使用 QAbstractItemModel 和 QQmlListProperty，但我无法让它工作。谁能指出我正确的方向？

我的主要问题是控制器类中 items 属性的类型和 getItems 方法的返回值。

如果这有什么不同的话，我正在使用 Qt 5.9。

Answer 1

注意：

• getter 和 setter 通常是公开的，除非有例外，所以将其移至公开部分

• 从 QObject 继承的类不需要 QMetaType，因为当您要传输该类的数据时，会使用指针。

不是所有的数据类型都被 QML 通过 Q_PROPERTY 支持，所以一个可能的解决方案是通过已知的类例如导出

• QList<QObject *>：

---

class Controller : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QList<QObject *> items READ getItems NOTIFY itemsChanged)
public:
    explicit Controller(QObject *parent = nullptr);
    QList<QObject *> getItems() const;
signals:
    void itemsChanged();
private:
    QList<KeyValue *>key_values_list;
};

---

...
QList<QObject *> Controller::getItems() const
{
    QObjectList l;
    for(auto e: key_values_list)
        l << e;
    return l;
}

• QVariantList：

---

class Controller : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QVariantList items READ getItems NOTIFY itemsChanged)
public:
    explicit Controller(QObject *parent = nullptr);
    QVariantList getItems() const;
signals:
    void itemsChanged();
private:
    QList<KeyValue *>key_values_list;
};

---

...
QVariantList Controller::getItems() const
{
    QVariantList l;
    for(auto e: key_values_list)
        l.append(QVariant::fromValue(e));
    return l;
}

其他选项是实现一个模型，下面的例子只显示了一个只读模型：

keyvaluemodel.h

#ifndef KEYVALUEMODEL_H
#define KEYVALUEMODEL_H

#include "keyvalue.h"

#include <QAbstractListModel>

class KeyValueModel : public QAbstractListModel
{
    Q_OBJECT

public:
    explicit KeyValueModel(QObject *parent = nullptr)
        : QAbstractListModel(parent)
    {
        key_values_list = {new KeyValue{"k", "v"}, new KeyValue{"k2", "v2"}};
    }
    int rowCount(const QModelIndex &parent = QModelIndex()) const override
    {
        if (parent.isValid())
            return 0;
        return key_values_list.length();
    }
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override
    {
        if (!index.isValid())
            return QVariant();
        if(index.row() >= 0 && index.row() < rowCount())
            return QVariant::fromValue(key_values_list[index.row()]);
        return QVariant();
    }
private:
    QList<KeyValue* >key_values_list;
};

#endif // KEYVALUEMODEL_H

---

class Controller : public QObject
{
    Q_OBJECT
    Q_PROPERTY(KeyValueModel* items READ getItems NOTIFY itemsChanged)
public:
    explicit Controller(QObject *parent = nullptr);
    KeyValueModel* getItems() const;
signals:
    void itemsChanged();
private:
    KeyValueModel *model;
};

---

...
Text{
    text: display.key + ": " + display.value
}
...

您可以通过类似的方式实现 QQmlListProperty，在文档中有很多示例。

Answer 2

如果您想要一个具有添加/删除对象和更改数据的复杂模型，您应该研究子类化QAbstractListModel。

作为一种简单但不太灵活的方式，您可以使用QVariantList 并使您的 Controller 类成为值类型。你需要：

• Controller 头文件末尾的宏 Q_DECLARE_METATYPE(Controller)。
• Controller 的复制构造函数
• Controller 的默认构造函数

Q_PROPERTY 类型和返回值则为 QVariantList。