C++调用QML函数的两种方法

Source

一.概述

   本文将深入探讨如何在C++中调用QML函数。这项功能非常常用,尤其是在需要将C++逻辑与QML界面进行交互时。我们将重点关注invokeMethod函数,它支持多种参数形式,并允许我们灵活地处理不同的调用场景。

二.方式一:invokeMethod方式调用QML函数

   1.invokeMethod是一个模板函数,主要用于在C++中调用QML的成员函数。这个函数支持多种参数类型和返回值的处理,简化了QML与C++之间的交互。以下是使用该函数时需要关注的几个要点:

函数名传递:函数名需要以字符串形式传递。

对象指针:调用的函数必须是某个QObject对象的成员函数,不能是全局函数。

参数传递:支持基础类型、QVariant、QString等多种类型的参数。

返回值处理:可以指定返回值类型,使用Q_RETURN_ARG宏。

2.无参数、无返回值的调用示例

首先,我们在QML中定义一个简单的无参数、无返回值的函数。例如:

// main.qml

Rectangle {

    width: 200

    height: 200

    function square() {

        print("QML square function called");

    }

}

在C++中,我们需要通过QMetaObject::invokeMethod调用该函数。假设我们已经通过QQmlApplicationEngine加载了QML文件,并获取了根对象:

// main.cpp

QQmlApplicationEngine engine;

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

QObject *qmlObject = engine.rootObjects().first();

// 调用QML函数

QMetaObject::invokeMethod(qmlObject, "square");

这段代码将调用QML中的square函数,输出“QML square function called”。

3.带参数的调用示例

接下来,我们定义一个带参数的QML函数:

    function greet(index:int, str:string, param):int {

        print("Index: " + index + ", String: " + str + ", Parameter: " + param);

        return 1;

    }

在C++中,我们可以这样调用它,并传递不同类型的参数:

    int returnValue;

    QMetaObject::invokeMethod(qmlObject, "greet",

                              Q_RETURN_ARG(int, returnValue),

                              1001,  //int(100) 也可以

                              QString("Hello"),

                              QVariant::fromValue(3.14));

这里的Q_RETURN_ARG宏用于处理返回值,QVariant::fromValue则用于将动态类型(如浮点数)转换为QVariant。

参数类型处理

在调用时,注意传递的参数类型:

整数类型:可以直接传递。

字符串类型:需要转换为QString。

动态类型:可以使用QVariant,使其能够容纳任意类型。

返回值的获取

3.如果QML函数需要返回值,我们可以这样定义:

function getMessage():string {  //注意:类型是string不是QString

    return "Hello from QML!";

}

在C++中,我们可以获取这个返回值:

QString message;

QMetaObject::invokeMethod(qmlObject, "getMessage",

                          Q_RETURN_ARG(QString, message));

通过这种方式,QML的返回值将被赋给C++中的message变量。

4.返回值类型的灵活性

在QML中,我们可以使用不同的返回值类型。例如:

function calculateValue():double {

    return Math.random() * 100;  // 返回浮点数

}

在C++中获取返回值时,无需做额外处理,只需指定目标类型即可:

double value;

QMetaObject::invokeMethod(qmlObject, "calculateValue",

                          Q_RETURN_ARG(double, value));

5.错误处理与调试

在使用invokeMethod时,如果调用失败,通常会返回false。我们可以通过以下方式进行错误检查:

bool success = QMetaObject::invokeMethod(qmlObject, "nonExistentFunction");

if (!success) {

    qDebug() << "Function call failed.";

}

此外,建议使用console.log或print在QML中调试输出,以便于检查参数是否正确传递。

三.方式二:槽通信--qml发送信号给c++的槽函数

1.建立一个c++类

#include <QObject>

class NetworkHandler : public QObject

{

    Q_OBJECT

    Q_PROPERTY(int value READ getValue WRITE setValue NOTIFY valueChanged)

public:

    explicit NetworkHandler(QObject *parent = nullptr);

    void setValue(int newValue);

    int getValue();

signals:

     void valueChanged(int value);

public slots:

    void network_slots(int a, QString str)

{

    qDebug()<<"network_slots:"<<a<<str;

}

};

2.main.c函数中进行注册:

int main(int argc, char *argv[])

{

    set_qt_environment();

    QGuiApplication app(argc, argv);

    qmlRegisterType<NetworkHandler>("NetLibrary", 1, 0, "NetworkHandler");

    QQmlApplicationEngine engine;

    const QUrl url(u"qrc:/qt/qml/Main/main.qml"_qs);

    QObject::connect(

        &engine,

        &QQmlApplicationEngine::objectCreated,

        &app,

        [url](QObject *obj, const QUrl &objUrl) {

            if (!obj && url == objUrl)

                QCoreApplication::exit(-1);

        },

        Qt::QueuedConnection);

    engine.addImportPath(QCoreApplication::applicationDirPath() + "/qml");

    engine.addImportPath(":/");

    engine.load(url);

    if (engine.rootObjects().isEmpty()) {

        return -1;

    }

    return app.exec();

}

注册:qmlRegisterType<NetworkHandler>("NetLibrary", 1, 0, "NetworkHandler");

3.qml代码

import QtQuick 6.0

import QtQuick.Controls 6.0

import NetLibrary 1.0

import MyLibrary 1.0

import MySingleLibrary 1.0

ApplicationWindow {

    visible: true

    width: 640

    height: 480

    title: qsTr("QML Button Example")

    signal qmlsig(int a, string str)  //设置qml信号

    Component.onCompleted:{ //qml的信号连接到c++的槽上

        qmlsig.connect(networkClass.network_slots)

    }

    Column  {

        id: buttonRow

        anchors.fill: parent

        spacing: 20

        NetworkHandler{

        id:networkClass

        }

        Button {

            id: button1

            text: qsTr("button1")

            onClicked: {

                button1.text = qsTr("Clicked1!")

                qmlsig(1, "signal_qml")

            }

        }

    }

}

说明:

    signal qmlsig(int a, string str)  //设置qml信号

    Component.onCompleted:{ //qml的信号连接到c++的槽上

        qmlsig.connect(networkClass.network_slots)

    }

    qmlsig(1, "signal_qml")  //发出信号