Qml组件化编程5-Qml与C++交互



  • 简介

    本文是《Qml组件化编程》系列文章的第五篇,涛哥将教大家,Qml与C++的交互。

    Qml已经有很多功能,不过终归会有不够用或不适用的地方,需要通过与C++的交互进行功能扩展。

    这回涛哥尝试把所有Qml与C++交互相关的知识点都写出来,做一个透彻、全面的总结。


    顺便说一下,涛哥的TaoQuick项目正式开源了, 系列文章中的所有功能,包括动态换皮肤、切换多语言等等,都集成在了TaoQuick中,

    同时涛哥也在TaoQuick中使用了持续集成(CI)技术,目前已经能够自动编译、发布Windows和 Macos平台的软件包,可以在github的Release界面下载体验。

    互联网行业很流行的DevOps理念,在TaoQuick项目中得到了最佳的实践。

    (linux平台的发布工具linuxdeployqt暂时还有点问题,涛哥后续会搞定的)

    地址在这https://github.com/jaredtao/TaoQuick, 赶快去star吧。

    注:文章主要发布在涛哥的博客知乎专栏-涛哥的Qt进阶之路

    C++访问Qml

    c++访问Qml有两种方式: findChild和 QQmlComponent。

    findChild

    了解Qt的人都知道,Qt的很多对象是QObject的子类,这些QObject只要设置了parent,就是有父子关系的,会产生一棵 "对象树"。

    只要有了根节点,树上的任意节点都可以通过findChild的方式获取到。

    写个简单的TaoObject,来示意一下:

    class TaoObject 
    {
    public:
        //构造函数,传递parent进来
        TaoObject(TaoObject *parent = nullptr) : m_pParent(parent) 
        {}
        //析构函数,析构children。即子对象自动回收机制。
        ~TaoObject() 
        {
            for (auto *pObj : m_children) 
            {
                delete pObj;
            }
            m_chilrren.clear();
        }
        //获取name
        const QString &getName() const { return m_name;}
        //设置name
        void setName(const QString &name) { m_name = name;} 
        //查找子Object
        TaoObject * findChild(const QString &name) 
        {
            //先检查自己的名字,是否匹配目标名字
            if (m_name == name) 
            {
                return this;
            }
            //遍历子Object,查找
            for (auto pObj: m_children) 
            {
                //递归调用,深度优先的搜索
                auto resObj = pObj->findChild(name);
                if (resObj) 
                {
                    return resObj;
                }
            }
            return nullptr;
        }
    private:
        //存储名字
        QString m_name;
        //子对象列表
        std::vector<TaoObject *> m_children;
        //父对象指针
        TaoObject *m_pParent = nullptr;
    }
    
    

    Qml的基本元素,大多是继承于QQuickItem,而QQuickItem继承于QObject。

    所以Qml大多数对象都是QObject的子类,也是可以通过findChild的方式获取到对象指针。

    拿到了QObject,可以通过qobject_cast转换成具体的类型来使用,也可以直接用QObject的invok方法。

    例如有如下Qml代码:

    Item {
        id: root
        ...
        Rectangle {
            id: centerRect
            objectName: "centerRect"        //必不可少的objectName
            property bool canSee: visible   //自定义属性,可以被C++ invok访问
            signal sayHello()               //自定义信号1,可以被C++ invok调用
            signal sayHelloTo(name)         //自定义信号2,带参数。可以被C++ invok调用。参数的名字要起好,后面通过这个名字来使用参数
            function rotateToAngle(angle)   //自定义js函数,旋转至指定角度。可以被C++ invok调用。
            {
                rotation = angle
                return true;
            }
        }
        ...
    }
    
    

    那么在C++ 中访问的方式是:

    • 如果用QQuickView加载qml,就是
    QQuickView view;
    ...
    QObject *centerObj = view.rootObject()->findChild<QObject *>("centerRect");
    if (!centerObj) { return;}
    
    • 如果用QQmlEngine加载qml,就是
    QQmlEngine engine;
    ...
    QObject *centerObj = engine.rootObject()->findChild<QObject *>("centerRect");
    if (!centerObj) { return;}
    

    (QObject类型也可以换成QQuickItem 或者其它)

    拿到了对象指针,接下来就好办了

    访问其属性

    bool canSee = centerObj->property("canSee").toBool();
    

    发射其信号(其实就是函数调用)

    QObject::invokeMethod(centerObj, "sayHello");
    QObject::invokeMethod(centerObj, "sayHelloTo", Q_ARG(QString, "Tao"))
    

    调用其js函数,可以传参数过去,可以取得返回值

    bool ok;
    QObject::invokeMethod(centerObj, "rotateToAngle", Q_RETURN_ARG(bool, ok), Q_ARG(qreal 180));
    

    这里再补充一下, Qml中给自定义的信号写槽或连接到别的槽(Qml中的槽就是js函数):

    Item {
        id: root
        ...
        Rectangle {
            id: centerRect
            objectName: "centerRect" //必不可少的objectName
            signal sayHello()       //自定义信号1
            signal sayHelloTo(name) //自定义信号2,带参数。参数的名字要起好,后面通过这个名字来使用参数
    
            function rotateToAngle(angle) //自定义js函数,旋转至指定角度
            {
                rotation = angle
            }
    
            onSayHello: {               //信号1的槽
                console.log("hello")
            }
            onSayHelloTo: {             //信号2的槽,直接用信号定义时的参数名字name作为关键字访问参数
                console.log("hello", name)
            }
            Component.onCompleted: { 
                //信号2 连接到 root的函数。参数会自动匹配。
                sayHello.connect(root.rootSayHello)
            }
        }
        ...
    
        function rootSayHello(name) {
            console.log("root: hello", name)
        }
    }
    

    QQmlComponent

    C++中的QQmlComponent可以用来动态加载Qml文件,并可以创建多个实例,

    对应Qml中的Component。Qml中还有一个Loader,也可以动态加载并创建单个实例。

    (QQmlComponent这种方式不太多见,不过涛哥之前参与过开发一个框架,使用的就是QQmlComponent动态加载Qml,

    完全在c++中控制界面的加载,加载效率、内存占用上都比纯Qml优秀。)

    来看一个例子:

    // Circle.qml
    Rectangle {
        width: 300
        height: width
        radius: width / 2
        color: "red"
    }
    
    QQmlEngine engine;
    QQmlComponent component(&engine, QUrl::fromLocalFile("Circle.qml"));
    
    QObject *circleObject = component.create();
    QQuickItem *item = qobject_cast<QQuickItem*>(circleObject);
    int width = item->width();
    

    拿到对象指针,就和前面的一样了,这里不再赘述了。

    Qml访问C++

    Qml要访问C++的内容,需要先从C++把要访问的内容注册进Qml。

    先说说能用哪些:

    注册过后,Qml中可以访问的内容,包括 Q_INVOKABLE 修饰的函数、枚举、 QObject的属性 信号 槽

    Q_INVOKABLE 函数可以用在普通的结构体或者类中,但是这种用法不常见/不方便。常见的是在QObject的子类中,给非槽函数设置为Q_INVOKABLE

    枚举的注册Qt帮助文档很详细,而且5.10以后可以在qml中定义枚举了,这里涛哥就不展开了。

    QObject的属性 信号 槽,都是可以通过注册后,在qml中使用的。信号、槽都可以带参数,槽可以有返回值。

    class BrotherTao : public QObject 
    {
        Q_OBJECT //这个宏一定要写上。不写可能的后果是,moc生成失败,信号 槽实现不了,编译过不了。
        Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged) //自定义属性,操作包括: 读、写和通知。Qml可以读写、获取通知
    public:
        ...
        //唱歌
        Q_INVOKABLE void sing();        //invok函数,可以被Qml调用。可以带参数和返回值
    public slots:
        //打游戏,参数为次数,返回值为得分。
        int playGame(int count);        //槽函数,可以被Qml调用。可以带参数和返回值
    
    signals:
        //肚子饿了。参数为想吃的东西。
        void hungry(const QString &foodName);                  //信号,可以被Qml接收。
        ...
    };
    

    这里要说的是,属性、函数参数、返回值的类型,都需要是Qml能识别的类型。

    Qt的常用类型已经在Qt内部注册好了,自定义的需要单独注册。

    再说说怎么用:

    注册分为两种:注册类型和注册实例。

    注册类并使用

    qmlRegisterTyle<BrotherTao>("BrotherTao",1, 0, "BrotherTao");
    
    import BrotherTao 1.0
    Item {
        BrotherTao {         //实例化一个对象
            id: tao
            onHungry: {     //给信号写个槽函数
                if (foodName === "蛋炒饭") {      //示意一下,不要在意吃啥。
                    console.log("涛哥要吃蛋炒饭")
                } else if (foodName === "水饺") {
                    console.log("涛哥要吃水饺")
                } 
            }
        }
        ...
        Button {
            onClicked: {
                //这个按钮按下的时候,涛哥开始唱歌
                tao.sing();
            }
        }
        Button {
            onClicked: {
                //这个按钮按下的时候,涛哥开始打游戏
                let score = tao.sing(3);
                console.log("涛哥打游戏次数", 3, "得分为", score)
            }
        }
    }
    

    注册实例并使用

    BrotherTao tao;     //C++中创建的实例
    
    //如果用QQ'u'ic'kView加载Qml
    QQuickView view;
    ...
    view.rootContext()->setContextProperty("tao", &tao);    //注意这个名字不要用大写字母开头,规则和Qml中的id不能用大写字母开头一样。
    
    //如果用QQmlEngine加载Qml
    QQmlEngine engine;
    ...
    engine..rootContext()->setContextProperty("tao", &tao); //注意这个名字不要用大写字母开头,规则和Qml中的id不能用大写字母开头一样。
    
    
    //这种不用再import了
    Item {
        Connections {        //通过connectins连接信号
            target: tao     //指定target
            onHungry: {     //给信号写个槽函数
                if (foodName === "蛋炒饭") {      //示意一下,不要在意吃啥。
                    console.log("涛哥要吃蛋炒饭")
                } else if (foodName === "水饺") {
                    console.log("涛哥要吃水饺")
                } 
            }
        }
        ...
        Button {
            onClicked: {
                //这个按钮按下的时候,涛哥开始唱歌
                tao.sing();
            }
        }
        Button {
            onClicked: {
                //这个按钮按下的时候,涛哥开始打游戏
                let score = tao.sing(3);
                console.log("涛哥打游戏次数", 3, "得分为", score)
            }
        }
    }
    

    文章出自涛哥的博客
    文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可, 转载请注明出处, 谢谢合作 © 涛哥

    联系方式


    作者 涛哥
    开发理念 弘扬鲁班文化,传承工匠精神
    博客 https://jaredtao.github.io
    知乎 https://www.zhihu.com/people/wentao-jia
    邮箱 jared2020@163.com
    微信 xsd2410421
    QQ 759378563

    请放心联系我,乐于提供咨询服务,也可洽谈商务合作相关事宜。

    打赏

    weixin
    zhifubao


    如果觉得涛哥写的还不错,还请为涛哥打个赏,您的赞赏是涛哥持续创作的源泉。



 

走马观花

最近的回复

  • 顶起来 这个不能不解决啊 怎么解决了

    read more
  • @jiangcaiyangVS2017 在编译时出现错误E2512 功能测试宏的参数必须是简单标识符 中说:

    Qt Visual Studio Addon

    请问大神这个具体怎么解决了

    read more
  • 请问大神解决了码

    read more
  • 简介 qmake简介 添加第三方库 示例1 - 直接链接库的全路径 示例2 - 路径中包含空格等特殊字符,用引号括起来。 示例3 - 分别指定路径和库 示例4 - 分平台条件链接 原理 影子构建 指定目标路径 指定中间件生成路径 拷贝资源 拷贝资源示例 编译前拷贝 安装 结束语 简介

    本文是《Qt实用技能》系列文章的第二篇,涛哥将教大家,一些qmake的实用技巧。部分地方也会说一下原理,让大家知其然,知其所以然。

    工欲善其事,必先利其器。

    这个系列,全是干货!

    注:文章主要发布在涛哥的博客知乎专栏-涛哥的Qt进阶之路

    qmake简介

    qmake是Qt的构建工具,主要作用是解析pro格式的项目文件、生成编译规则(Makefiles或其它)。

    qmake是一个比较古老的工具,很多功能使用perl脚本实现,涛哥在其它地方就没怎么见过使用perl脚本的代码/项目。

    Qt官方之前开发的Qbs,后来又宣布不再更新,现在又大力支持CMake。。。

    在这样的背景下,qmake依然是当下主要的构建工具,所以qmake的一些技巧还是有必要掌握的。

    qmake本身作为一个可执行程序,也是有一些参数的,但这不是本文的重点,本文的重点都在pro文件里。

    pro文件中,除了常规的组织项目结构外,还可以做很多事情, 比如 指定编译选项、链接选项、制定目标生成规则、扩展编译规则 等等。

    pro文件中的qmake语法,包括 变量声明和使用、内建变量、替换函数、测试函数等,帮助文档都有详细的介绍。

    搜索关键词为qmake, 或者和普通的类查看帮助文档方式一样,光标放在pro文件要查看的变量上,按F1就能看到相应的说明。

    预览

    涛哥就不赘述了,后面用到的会单独说明。

    添加第三方库

    c++开发,使用第三方库也是家常便饭了,这是一个必备的技能。

    这里首选的方法,是使用QtCreator提供的添加库UI。在pro文件里(或者项目文件夹), 鼠标右键->添加库,然后根据自己的需要下一步、下一步点一下即可。

    预览

    熟练的人也可以直接按pro语法(perl语法)写,给LIBS变量赋值。

    下面给几个示例,至于动态库/静态库的差异,大家自己实践吧。

    示例1 - 直接链接库的全路径 LIBS += c:/mylibs/math.lib

    我们都知道windows系统默认的路径分割符是'',但在qmake中要写成'\'才行。qmake也支持写成'/',其它unix系统又都是'/',

    所以干脆都写成'/',方便处理。

    示例2 - 路径中包含空格等特殊字符,用引号括起来。 LIBS += "C:/mylibs/extra libs/extra.lib" 示例3 - 分别指定路径和库 LIBS += "C:/mylibs/extra libs" -lextra

    这里的LIBS指定要链接的库,'-L'是指定链接库的路径,'-l'指定要链接的库名称

    名称可以省略lib前缀和 扩展名后缀,Qt会自动处理。 后缀包括 '.so' '.dll' '.dylib' 等。

    示例4 - 分平台条件链接 win32:LIBS += "C:/mylibs/extra libs/extra.lib" unix:LIBS += "-L/home/user/extra libs" -lextra

    条件链接可以很方便地实现不同平台链接不同的库。

    这里的 win32 unix 是在选择了不同的编译器环境时,qmake分别预置的变量。

    (比如win32平台相关的变量,可以参考msvc的配置文件: [QTDIR]/mkspecs/win32-msvc/qmake.conf 和 [QTDIR]/mkspecs/common/msvc-desktop.conf)

    原理

    Qt内置了一些perl脚本,在执行qmake解析时会包含这些脚本。其中一些脚本会来处理这个LIBS变量,将其转换成编译器/链接器的参数。

    内置的脚本路径在[QTDIR]/mkspecs/features文件夹下,扩展名为prf。

    预览

    后续的很多变量,也是一样的原理, 只是处理方式各不相同。

    很多pro文件的语法、功能实现,都可以参考这些prf来实现。

    (注意:不熟悉的同学,不要乱改prf,容易改坏)

    Qt程序员都知道的一件事:有时候修改了信号/槽相关的代码,不能正常运行,要重新qmake一下,才会生效。

    本质上就是在重新触发[QTDIR]/mkspecs/features/moc.prf这个脚本。

    (多少年了,都没有修好Moc生成问题,可见qmake的古老...)

    影子构建

    影子构建,就是编译生成的产物和源代码在不同的文件夹。这样可以防止源代码文件夹被污染。

    QtCreator默认导入pro工程时,就会生成一个影子构建路径。比如这样:

    预览

    F:\Dev\Qt\build-HelloTaoQuick-Desktop_Qt_5_12_3_MSVC2017_64bit-Debug

    之后编译项目时生成的中间文件及目标文件,都在这个文件夹中。

    这个路径很长,而且编译器或者编译选项不同时都有可能不一样。

    有时候要做一些特定的操作 比如目标exe生成到特定目录、拷贝资源文件等等,直接用这个路径会不太方便/不太可靠,我们需要一些定制。

    指定目标路径 DESTDIR = $$PWD/bin

    通过给DESTDIR变量赋值, 可以指定生成的lib/exe放在哪个目录下

    'PWD'是qmake内置变量,'$$'是内置变量取值的写法。'/bin'是字符串拼接在变量后面。

    更多内置变量可以参考qmake帮助文档,以及这篇文档隐藏的qmake文档

    当然也可以参考那一堆prf和conf文件。

    指定中间件生成路径

    可以通过这几个变量指定中间件生成的路径

    config(debug, debug|release) { OBJECTS_DIR = build/debug/obj MOC_DIR = build/debug/moc RCC_DIR = build/debug/rcc UI_DIR = build/debug/uic } else { OBJECTS_DIR = build/release/obj MOC_DIR = build/release/moc RCC_DIR = build/release/rcc UI_DIR = build/release/uic }

    config(debug, debug|release) 是一个条件表达式,可以理解为

    if (debug === true) { } else if (release == true) { }

    注意: 按照perl语法,那个左大括号'{'不能换行,要和前面的表达式在同一行。(有人自作聪明换行,被坑了呢😄)

    上面这种指定中间件路径的方式,在QtCreator中有默认路径所以没有太大意义,不过在命令行编译时这样写却很有用。

    拷贝资源

    pro可以实现,在编译代码时,拷贝一些文件到指定的路径下

    拷贝资源示例

    这里以TaoQuick为例,来说明:

    我在TaoQuick库目录下,有个叫qmldir的文件,需要在编译代码时自动拷贝到bin目录下。(先别管这个文件干嘛的,下一篇文章会说)

    预览

    关键目录结构如下:

    TaoQuick TaoQuick.pro - bin -TaoQuick - TaoQuickCore TaoQuickCore.pro - Qml qmldir

    那么我在TaoQuickCore.pro文件中的写法如下:

    !equals(_PRO_FILE_PWD_, $$DESTDIR) { copy_qmldir.target = $$DESTDIR/qmldir copy_qmldir.depends = $$_PRO_FILE_PWD_/qmldir win32 { copy_qmldir.target ~= s,/,\\\\,g copy_qmldir.depends ~= s,/,\\\\,g } copy_qmldir.commands = $${QMAKE_COPY_FILE} $${copy_qmldir.depends} $${copy_qmldir.target} QMAKE_EXTRA_TARGETS += copy_qmldir }

    ‘!equals(PRO_FILE_PWD, $$DESTDIR)’ 这一句是执行条件,即: 目标路径不等于pro文件所在路径时 执行下面的操作。

    剩下的事情就是在创建一个"编译目标"(Target),将这个编译目标添加到QMAKE_EXTRA_TARGETS变量中就行了。

    熟悉MakeFiles的同学应该都清楚什么是"目标"。不懂MakeFiles也没关系,这里的目标就理解为自己声明的一个变量即可。

    这个变量有三个很重要的"子变量":

    copy_qmldir.target 指定目标文件所在的路径 (这里理解成要拷贝到哪去)
    copy_qmldir.depends 指定依赖文件所在的路径 (这里理解成从哪里拷贝)
    copy_qmldir.commands 指定拷贝操作的执行命令 (就是怎么拷贝)

    QMAKE_COPY_FILE 这个变量来自前面说过的隐藏的qmake文档

    qmake会在解析pro文件时,自动替换成平台相应的拷贝命令。 windows 平台就是 copy /y

    注意windows的copy指令,路径分隔符得写成 '\'才行。所以有了下面的特殊处理:

    win32 { copy_qmldir.target ~= s,/,\\\\,g copy_qmldir.depends ~= s,/,\\\\,g }

    ‘s,/,\\,g’ 是一个正则表达式,作用是把‘/’替换成‘\’ 。s表示开头,g表示结尾。

    VAR~= REGEXP 是对变量VAR执行REGEXP这个正则表达式

    编译前拷贝

    如果想在编译之前,先把资源拷贝完成,只需要前面的基础上,添加一句

    PRE_TARGETDEPS += $$copy_qmldir.target

    也就是把"目标"加到 PRE_TARGETDEPS变量

    !equals(_PRO_FILE_PWD_, $$DESTDIR) { copy_qmldir.target = $$DESTDIR/qmldir copy_qmldir.depends = $$_PRO_FILE_PWD_/qmldir win32 { copy_qmldir.target ~= s,/,\\\\,g copy_qmldir.depends ~= s,/,\\\\,g } copy_qmldir.commands = $${QMAKE_COPY_FILE} $${copy_qmldir.depends} $${copy_qmldir.target} QMAKE_EXTRA_TARGETS += copy_qmldir PRE_TARGETDEPS += $$copy_qmldir.target } 安装

    pro中还有一种INSTALL功能,可以执行文件拷贝。

    和编译期拷贝 类似,INSTALL用起来更简单无脑一些,而且INSTALL只在执行make install指令时,才会拷贝资源。

    还是以TaoQuick为例, 我有一堆文件,需要在make install时,安装到Qt的Qml路径中

    预览

    如上图所示所有的文件, 除了TaoQuickDesigner.pri, 都要按照这个结构拷贝。

    (这个pri文件是pro文件的一小部分,可以直接在pro中通过include引入。

    pri和pro语法一样,但是qmake不直接识别pri,只识别pro

    pri一般用来写一些公用的部分,让多个pro公用)

    拷贝整个文件夹是一种做法, 当然为了精确地控制要拷贝的内容,可以写成下面这样:

    taoquick_designer.files = $$PWD/designer/TaoQuick.metainfo taoquick_designer.path = $$[QT_INSTALL_QML]/$${uri}/designer toaquick_qmldir.files = $$PWD/qmldir toaquick_qmldir.path = $$[QT_INSTALL_QML]/$${uri} taoquick_qml_buttons.files = $$PWD/BasicComponent/Button/*.qml taoquick_qml_buttons.path = $$[QT_INSTALL_QML]/$${uri}/BasicComponent/Button taoquick_qml_mouse.files = $$PWD/BasicComponent/Mouse/*.qml taoquick_qml_mouse.path = $$[QT_INSTALL_QML]/$${uri}/BasicComponent/Mouse taoquick_qml_others.files = $$PWD/BasicComponent/Others/*.qml taoquick_qml_others.path = $$[QT_INSTALL_QML]/$${uri}/BasicComponent/Others taoquick_qml_progress.files = $$PWD/BasicComponent/Progress/*.qml taoquick_qml_progress.path = $$[QT_INSTALL_QML]/$${uri}/BasicComponent/Progress taoquick_degisner_images.files = $$PWD/designer/images/*.png taoquick_degisner_images.path = $$[QT_INSTALL_QML]/$${uri}/designer/images INSTALLS += taoquick_designer toaquick_qmldir taoquick_qml_buttons taoquick_qml_mouse taoquick_qml_others taoquick_qml_progress taoquick_degisner_images

    自定义一个变量,然后其子变量files指定要拷贝的文件,子变量path指定目标路径。

    把自定义变量加入INSTALLS变量就行了。

    QT_INSTALL_QML也是一个内置变量,默认值为[QTDIR]/qml。

    之后只要执行以下命令,就能完成资源拷贝。

    qmake make make install

    当然QtCreator中也能执行make install

    如下图所示:

    预览

    任意编译器kit都可以,项目->构建步骤->添加build步骤->Make,添加之后在make参数中输入install。最后重新构建工程,即可完成安装。

    结束语

    以上案例,大部分都在TaoQuick项目中实践过,可以去Github参考。

    TaoQuick

    转载声明

    文章出自涛哥的博客

    文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可, 转载请注明出处, 谢谢合作 © 涛哥

    联系方式 作者 武威的涛哥 开发理念 弘扬鲁班文化,传承工匠精神 博客 https://jaredtao.github.io github https://github.com/jaredtao 知乎 https://www.zhihu.com/people/wentao-jia 邮箱 jared2020@163.com 微信 xsd2410421 QQ 759378563

    请放心联系我,乐于提供咨询服务,也可洽谈商务合作相关事宜。

    打赏

    weixin
    zhifubao

    如果觉得涛哥写的还不错,还请为涛哥打个赏,您的赞赏是涛哥持续创作的源泉。

    read more

关注我们

微博
QQ群











召唤伊斯特瓦尔