在QML中访问cpp结构的最佳方法

Question

我需要在cpp和QML之间传递结构。如果我使用属性，我应该创建一个单独的集合并获取函数，我的结构至少包含5个成员，所以我觉得对所有这些成员使用集合并获取并不好。以下是我要执行的操作的示例：

MyClass.h

#include <QObject>
#include <QDebug>
using namespace std;

struct MyStruct {
Q_GADGET
int m_val;
QString m_name1;
QString m_name2;
QString m_name3;
QString m_name4;
Q_PROPERTY(int val MEMBER m_val)
Q_PROPERTY(QString name1 MEMBER m_name1)
Q_PROPERTY(QString name2 MEMBER m_name2)
Q_PROPERTY(QString name3 MEMBER m_name3)
Q_PROPERTY(QString name4 MEMBER m_name4)
};

class MyClass:public QObject
    {
        Q_OBJECT
    Q_PROPERTY(MyStruct mystr READ getMyStruct
                WRITE setMyStruct NOTIFY myStructChanged)

public:
    explicit MyClass(QObject *parent = nullptr);
    MyStruct strObj;

     // Edit: changed get function
     MyStruct getMyStruct() const
     {
         return strObj;
     }

// Edit: Added set function
     void setMyStruct(myStruct val)
        {
            mystr = val;
            emit myStructChanged();
        }

signals:
void myStructChanged();

}

main.cpp

#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include <QQmlContext>
#include <QDebug>
#include <QObject>

#include "MyClass.h"

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);
    QQmlApplicationEngine engine;

    MyClass classObj;

    engine.rootContext()->setContextProperty("classObj",&classObj);

    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));

    if (engine.rootObjects().isEmpty())
        return -1;

    return app.exec();
}

Main.qml

import QtQuick 2.6
import QtQuick.Controls 2.2
import QtQuick.Window 2.3

ApplicationWindow {

    id: applicationWindow

    visible: true
    width: 600
    height: 400
    title: qsTr("My App")

    MainForm{
        id : mainform

        Component.onCompleted: {
        console.log("name===="+classObj.mystr.name1)

        //EDIT added more code to explain the use case.
        classObj.myStr.name1 = "abc"  //Calls setter 
        classObj.mystr.name2 = "ans" // Calls setter 
        }
    }
}

如果我只打印，(classObj.myVariant)我会得到QVariant（MyStruct），但是当我尝试访问任何参数时，例如classObj.myVariant.name1我得到“ undefined ”，以及如何设置QML的变体？

[更新] -还应将MyStruct添加到Q_DECLARE_METATYPE中，如下所示：Q_DECLARE_METATYPE（MyStruct）

Answer 1

1. 您的结构或简单类必须Q_GADGET至少具有
2. 您应该声明属性以便从 qml 访问
3. 你必须通过以下方式声明你的结构/类Q_DECLARE_METATYPE()
4. 您必须在通过引擎加载 qml 文件之前使用qRegisterMetaType<>()某处注册它，例如main.cpp

所以你会得到这样的东西：

//review carefully
struct MyStruct {
    Q_GADGET    //<-- 1.
    Q_PROPERTY(QString str1 MEMBER m_str1)    //<-- 2.
public:    //<-- important
    QString m_str1;
};
Q_DECLARE_METATYPE(MyStruct)    //<-- 3.

并在某处使用：

class Controller : public QObject
{
    Q_OBJECT
public:
    explicit Controller(QObject *parent = nullptr);
    Q_INVOKABLE MyStruct setNewConfig(QString v);    //<-- e.g.
    //...
}

主程序

//...
qmlRegisterType<Controller>("AppKernel", 1, 0, "Controller");
qRegisterMetaType<MyStruct>();    //<-- 4.
//...
engine.load(url);
//...

所以它可以在 qml
main.qml中使用

//...
    Controller {
        id: con
    }
    FileDialog {
        id: fileDialog
        nameFilters: ["Config file (*)"]
        onAccepted: {
            var a = con.setNewConfig(file);
            console.log(a.str1);    //<-- yeah! it is here
        }
    }
//...

注意 1：小心，Qt 元似乎不支持嵌套类/结构

注意 2：您可以struct像class. 继承QObject并使用Q_OBJECT. 请参阅Evgenij Legotskoj 的这篇文章

注意 3：以上说明使 qml 知道结构/类，并且您可以访问属性/成员，但在 qml 中不可实例化。参见Qt文档

注意 4：请注意，该qmlRegisterType<>()方法在 Qt 5.15+ 中被标记为“过时”。让自己保持更新；）

Answer 2

您需要元数据才能从QML访问C ++对象。

对于非QObject派生，这是通过使用Q_GADGET宏并将成员公开为属性来实现的：

struct MyStruct {
    Q_GADGET
    int m_val;
    QString m_name1;
    QString m_name2;
    QString m_name3;
    QString m_name4;
    Q_PROPERTY(int val MEMBER m_val)
    Q_PROPERTY(QString name1 MEMBER m_name1)
    Q_PROPERTY(QString name2 MEMBER m_name2)
    Q_PROPERTY(QString name3 MEMBER m_name3)
    Q_PROPERTY(QString name4 MEMBER m_name4)
};