如何创建用于 QML 的通用对象模型？

Question

我想知道是否有任何宏或方法如何将 Qt 模型注册为 QObject 的属性。

例如，我有AnimalModel ( http://doc.qt.io/qt-5/qtquick-modelviewsdata-cppmodels.html#qabstractitemmodel )。

我知道我可以将它传递给 QuickView 的根上下文

QuickView view;
view.rootContext()->setContextProperty("myModel", &model);

如果我通过 Qml 宏注册了 QObject，我也可以传递这个对象来查看：

view.rootContext()->setContextProperty("obj", pDataObject);

但是如果我想要拥有任何数据模型的 QObject 呢？

例如：

class DataObject : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QString color READ color WRITE setColor NOTIFY colorChanged)
    ...

    AnimalModel m_modelAnimals;

    //Is this possible in any way?
    //Q_PROPERTY(AnimalModel modelAnimals READ modelAnimals NOTIFY modelAnimalsChanged)
};

到目前为止，我发现的每个示例都展示了如何将QAbstractListModel传递给根上下文。 但没有如何将它用作 QObject 属性。

（我知道有QQmlListProperty但QQmlListProperty不支持部分刷新。重建所有 Qml 对象总是必要的）

Answer 1

//Is this possible in any way?
//Q_PROPERTY(AnimalModel modelAnimals READ modelAnimals NOTIFY modelAnimalsChanged)

是的，你没有尝试过吗？ 当然，它不会是AnimalModel而是AnimalModel * ，但只要模型继承QAbstractListModel ，这就是你所需要的。 您甚至不需要NOTIFY部分，因为无论如何都会自动反映模型内部的更改。 modelAnimalsChanged仅在您用不同的模型替换整个模型时才有意义，并且自然而然地关闭 QML 关于在没有通知信号的情况下使用属性的警告。 当模型对象没有改变时，更AnimalModel *是只从插槽或Q_INVOKABLE返回一个AnimalModel * 。

如果你想要一个真正灵活的模型，你可以创建一个存储QObject * ，然后从 QML 你可以创建具有任意属性的任意对象，并添加到模型中。 然后从模型中，您有一个返回对象的object角色，您可以查询和使用该对象来检索它所拥有的属性。 “经典”列表模型实现将定义一个具有静态、固定模式的模型，而使用这种方法允许在模型中拥有具有不同属性的“无定形”对象。

自然，这需要某种类型安全性，例如在这样的模型中为每个对象都有一个property int type的property int type ，并且基于它您可以确定该对象的可用属性。 我通常的方法是为委托设置一个Loader ，并将对象作为数据源传递给不同的 QML UI 实现，以可视化它实例化的对象类型。 通过这种方式，模型中既有不同的对象，又有不同的 QML 项作为视图委托。

制作最终“万事通”列表/模型对象的最后一步是为其实现QQmlListProperty和Q_CLASSINFO("DefaultProperty", "container") ，允许您动态地组合列表/模型，或使用 QML 的声明句法。 另请注意，使用此解决方案，您可以向此类模型添加或删除，甚至删除声明性实例化的对象。

此外，根据您的使用场景，您可能需要为模型使用qmlRegisterType()或qmlRegisterUncreatableType() 。

好吧，乍一看，“任何数据的模型”似乎并不是指无模式模型，而是指不同的模式模型。 在这种情况下，您可以使用QAbstractListModel *甚至QObject *而不是返回AnimalModel * - 它无论如何都可以在 QML 中工作，因为它通过元系统使用动态。 但无论如何，无模式模型更加强大和灵活，它们不需要定义 C++ 代码，它可以单独从 QML 工作。

class List : public QAbstractListModel {
    Q_OBJECT
    QList<QObject *> _data;

    Q_PROPERTY(int size READ size NOTIFY sizeChanged)
    Q_PROPERTY(QQmlListProperty<QObject> content READ content)
    Q_PROPERTY(QObject * parent READ parent WRITE setParent)
    Q_CLASSINFO("DefaultProperty", "content")
public:
    List(QObject *parent = 0) : QAbstractListModel(parent) { }
    int rowCount(const QModelIndex &p) const { Q_UNUSED(p) return _data.size(); }
    QVariant data(const QModelIndex &index, int role) const {
        Q_UNUSED(role)
        return QVariant::fromValue(_data[index.row()]);
    }
    QHash<int, QByteArray> roleNames() const {
        static QHash<int, QByteArray> roles = { { Qt::UserRole + 1, "object" } };
        return roles;
    }
    int size() const { return _data.size(); }
    QQmlListProperty<QObject> content() { return QQmlListProperty<QObject>(this, _data); }

public slots:
    void add(QObject * o) { insert(o, _data.size()); }

    void insert(QObject * o, int i) {
        if (i < 0 || i > _data.size()) i = _data.size();
        beginInsertRows(QModelIndex(), i, i);
        _data.insert(i, o);
        o->setParent(this);
        sizeChanged();
        endInsertRows();
    }

    QObject * take(int i) {
        if ((i > -1) && (i < _data.size())) {
            beginRemoveRows(QModelIndex(), i, i);
            QObject * o = _data.takeAt(i);
            o->setParent(0);
            sizeChanged();
            endRemoveRows();
            return o;
        } else qDebug() << "ERROR: take() failed - object out of bounds!";
        return 0;
    }

    QObject * get(int i) {
        if ((i > -1) && (i < _data.size())) return _data[i];
        else  qDebug() << "ERROR: get() failed - object out of bounds!";
        return 0;
    }

    void internalChange(QObject * o) { // added to force sort/filter reevaluation
      int i = _data.indexOf(o);
      if (i == -1) {
        qDebug() << "internal change failed, obj not found";
        return;
      } else {
        dataChanged(index(i), index(i));
      }
    }

signals:
    void sizeChanged();
};

然后，在你qmlRegisterType<List>("Core", 1, 0, "List"); 你几乎可以以任何你想要的方式使用它 - 它会保存任何QObject或派生的，自然包括 QMLs QtObject它可以直接用作模型来驱动ListView 。 您可以使用插槽或声明来动态填充它，如下所示：

List {
    QtObject { ... }
    QtObject { ... }
    List {
        QtObject { ... }
        QtObject { ... }
    }
}

它还将处理对象所有权，您可以轻松嵌套它，从本质上生成一个分区树模型 - 请注意，您不能使用 QML 的ListModel声明性地执行此操作。 您可能想要添加一个parentChanged信号并实现一个发出它的 setter，如果您想绑定一个变化的父级，这在我的情况下是没有必要的。

至于如何在视图中使用它，您可以使用objectName属性或int type属性或基本上任何方法来区分不同的对象类型，并为委托使用Loader ：

Loader {
    // using component in order to capture context props and present to the variable delegate
    sourceComponent: Qt.createComponent(obj.objectName + ".qml")
    // if that is not needed simply use
    // source: obj.objectName + ".qml"
    // or setSource to pass specific properties to delegate properties
    // Component.onCompleted: setSource(obj.objectName + ".qml", {/*prop list*/})
}

更新：

这里也是一个简单的、同样动态的和通用的排序和过滤代理的实现要点，与这个模型一起使用以增强可用性。