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

How to create a generic object model for use in QML?

本文关键字:QML 对象模型 用于 何创建 创建      更新时间:2023-10-16

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

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

我知道我可以将其传递给概览的根上下文

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属性。

(我知道有QQmlListPropertyQQmlListProperty不支持部分刷新。始终需要重建所有 Qml 对象(

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

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

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

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

制作最终的"万事通"列表/模型对象的最后一步是为它实现QQmlListPropertyQ_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或派生,自然包括 QML,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*/})
}

更新:

这里也是实现的要点,用于简单且同样动态和通用的排序和过滤代理,以配合此模型以增强可用性。