Qt Quick 之 QML 与 C++ 混合编程详解

最新推荐文章于 2024-05-11 16:36:01 发布

原创

最新推荐文章于 2024-05-11 16:36:01 发布 · 307 阅读

1 ·

CC 4.0 BY-SA版权

本文详细介绍了如何在Qt Quick中使用QML与C++进行混合编程，包括在QML中使用C++类和对象的步骤，如实现可导出的C++类，注册QML类型，以及在C++中使用QML对象的方法。通过示例项目colorMaker，展示了如何创建C++类并将其注册到QML环境，以便在QML中创建和使用这些类型的实例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Qt Quick 技术的引入，使得你能够快速构建 UI ，具有动画、各种绚丽效果的 UI 都不在话下。但它不是万能的，也有很多局限性，原来 Qt 的一些技术，比如低阶的网络编程如 QTcpSocket ，多线程，又如 XML 文档处理类库 QXmlStreamReader / QXmlStreamWriter 等等，在 QML 中要么不可用，要么用起来不方便，所以呢，很多时候我们是会基于这样的原则来混合使用 QML 和 C++： QML 构建界面， C++ 实现非界面的业务逻辑和复杂运算。

那这篇呢，我们就来看看 QML 和 C++ 之间如何交互。

其实话说回来， QML 的很多基本类型原本就是在 C++ 中实现的，比如 Item 对应 QQuickItem ， Image 对应 QQuickImage ， Text 对应 QQuickText ，……这样看来，在 QML 中访问 C++ 对象必然不成问题。然也！反过来，在 C++ 中其实也可以使用 QML 对象。

对于这两种情景，我们分别讲述。先看如何在 QML 中使用 C++ 类和对象。

首先我们需要创建一个 Qt Quick App ，请参考《Qt Quick 之 Hello World 图文详解》建立一个名为 colorMaker 的项目，接下来我们的学习将会伴随 colorMaker 项目进行，等我们讲完，一个完整的 colorMaker 项目也会完成。需要新建两个文件， colorMaker.h 和 colorMaker.cpp 。

colorMaker 只是一个示例项目，我在 C++ 中实现一个 ColorMaker 类，它可以被注册为一个 QML 类型供 QML 像内建类型一样使用，它的实例也可以导出为 QML 上下文属性在 QML 中访问。我们的示例只是在界面顶部显示当前时间（时间文字的颜色随时间变化而变化），在界面中间显示一个变色矩形，在界面底部放置几个按钮来控制颜色如何变化。

图 1 是效果图：

图 1 colorMaker 效果图

在 QML 中使用 C++ 类和对象

我们知道， QML 其实是对 JavaScript 的扩展，融合了 Qt Object 系统，它是一种新的解释型的语言， QML 引擎虽然由 Qt C++ 实现，但 QML 对象的运行环境，说到底和 C++ 对象的上下文环境是不同的，是平行的两个世界。如果你想在 QML 中访问 C++ 对象，那么必然要找到一种途径来在两个运行环境之间建立沟通桥梁。

Qt 提供了两种在 QML 环境中使用 C++ 对象的方式：

在 C++ 中实现一个类，注册到 QML 环境中， QML 环境中使用该类型创建对象
在 C++ 中构造一个对象，将这个对象设置为 QML 的上下文属性，在 QML 环境中直接使用改属性

不管哪种方式，对要导出的 C++ 类都有要求，不是一个类的所有方法、变量都可以被 QML 使用，因此我们先来看看怎样让一个方法或属性可以被 QML 使用。

实现可以导出的 C++ 类

前提条件

要想将一个类或对象导出到 QML 中，下列前提条件必须满足：

从 QObject 或 QObject 的派生类继承
使用 Q_OBJECT 宏

看起来好像和使用信号与槽的前提条件一样……没错，的确是一样的。这两个条件是为了让一个类能够进入 Qt 强大的元对象系统（meta-object system）中，只有使用元对象系统，一个类的某些方法或属性才可能通过字符串形式的名字来调用，才具有了在 QML 中访问的基础条件。

一旦你导出了一个类，在 QML 中就必然要访问该类的实例的属性或方法来达到某种目的，否则我真想不来你要干什么……而具有什么特征的属性或方法才可以被 QML 访问呢？

信号，槽

只要是信号或者槽，都可以在 QML 中访问，你可以把 C++ 对象的信号连接到 QML 中定义的方法上，也可以把 QML 对象的信号连接到 C++ 对象的槽上，还可以直接调用 C++ 对象的槽或信号……所以，这是最简单好用的一种途径。

下面初始 ColorMaker 类的声明：

class ColorMaker : public QObject{    Q_OBJECTpublic:    ColorMaker(QObject *parent = 0);    ~ColorMaker();    signals:    void colorChanged(const QColor & color);    void currentTime(const QString &strTime);public slots:    void start();    void stop();    };

我们定义了 start() / stop() 两个槽， colorChanged() / currentTime() 两个信号，都可以在 QML 中使用。

Q_INVOKABLE 宏

在定义一个类的成员函数时使用 Q_INVOKABLE 宏来修饰，就可以让该方法被元对象系统调用。这个宏必须放在返回类型前面。

我给 ColorMaker 添加了两个使用 Q_INVOKABLE 宏修饰的方法，现在 ColorMaker 类的声明变成了这个样子：

class ColorMaker : public QObject{    Q_OBJECTpublic:    ColorMaker(QObject *parent = 0);    ~ColorMaker();        Q_INVOKABLE GenerateAlgorithm algorithm() const;    Q_INVOKABLE void setAlgorithm(GenerateAlgorithm algorithm);signals:    void colorChanged(const QColor & color);    void currentTime(const QString &strTime);public slots:    void start();    void stop();};

一旦你使用 Q_INVOKABLE 将某个方法注册到元对象系统中，在 QML 中就可以用 ${Object}.${method} 来访问，colorMaker 的 main.qml 中有使用 algorithm() 和 setAlgorithm() 的 QML 代码：

    Component.onCompleted: {        colorMaker.color = Qt.rgba(0,180,120, 255);        colorMaker.setAlgorithm(ColorMaker.LinearIncrease);        changeAlgorithm(colorAlgorithm, colorMaker.algorithm());    }

我在根元素创建完成时初始化 colorMaker 对象，给它设定了颜色生成算法，同时改变界面上切换颜色生成算法的按钮的文字。

Q_ENUMS

如果你要导出的类定义了想在 QML 中使用枚举类型，可以使用 Q_ENUMS 宏将该枚举注册到元对象系统中。

ColorMaker 类定义了 GenerateAlgorithm 枚举类型，支持 RandomRGB / RandomRed 等颜色生成算法。现在 ColorMaker 类的声明变成了这个样子：

class ColorMaker : public QObject{    Q_OBJECT    Q_ENUMS(GenerateAlgorithm)public:    ColorMaker(QObject *parent = 0);    ~ColorMaker();        enum GenerateAlgorithm{        RandomRGB,        RandomRed,        RandomGreen,        RandomBlue,        LinearIncrease    };        Q_INVOKABLE GenerateAlgorithm algorithm() const;    Q_INVOKABLE void setAlgorithm(GenerateAlgorithm algorithm);signals:    void colorChanged(const QColor & color);    void currentTime(const QString &strTime);public slots:    void start();    void stop();};

一旦你使用 Q_ENUMS 宏注册了你的枚举类型，在 QML 中就可以用 ${CLASS_NAME}.${ENUM_VALUE} 的形式来访问，比如 ColorMaker.LinearIncrease ，上节展示的 QML 代码片段已经使用了导出的枚举类型。

Q_PROPERTY

Q_PROPERTY 宏用来定义可通过元对象系统访问的属性，通过它定义的属性，可以在 QML 中访问、修改，也可以在属性变化时发射特定的信号。要想使用 Q_PROPERTY 宏，你的类必须是 QObject 的后裔，必须在类首使用 Q_OBJECT 宏。

下面是 Q_PROPERTY 宏的原型：

Q_PROPERTY(type name           (READ getFunction [WRITE setFunction] |            MEMBER memberName [(READ getFunction | WRITE setFunction)])           [RESET resetFunction]           [NOTIFY notifySignal]           [REVISION int]           [DESIGNABLE bool]           [SCRIPTABLE bool]           [STORED bool]           [USER bool]           [CONSTANT]           [FINAL])

是不是很复杂？你可以为一个属性命名，可以设定的选项数超过10个……我是觉得有点儿头疼。不过，不是所有的选项都必须设定，看一个最简短的属性声明：

Q_PROPERTY(int x READ x)

上面的声明定义了一个类型为 int 名为 x 的属性，通过方法 x() 来访问。

type name 这两个字段想必不用细说了吧？ type 是属性的类型，可以是 int / float / QString / QObject / QColor / QFont 等等， name 就是属性的名字。

其实我们在实际使用中，很少能够用全 Q_PROPERTY 的所有选项，就往 QML 导出类这种场景来说，比较常用的是 READ / WRITE / NOTIFY 三个选项。我们来看看都是什么含义。

READ 标记，如果你没有为属性指定 MEMBER 标记，则 READ 标记必不可少；声明一个读取属性的函数，该函数一般没有参数，返回定义的属性。
WRITE 标记，可选配置。声明一个设定属性的函数。它指定的函数，只能有一个与属性类型匹配的参数，必须返回 void 。
NOTIFY 标记，可选配置。给属性关联一个信号（该信号必须是已经在类中声明过的），当属性的值发生变化时就会触发该信号。信号的参数，一般就是你定义的属性。

其它标记的含义，请参考 Qt SDK 。

QML 中的 Text 类型对应 C++ 中的 QQuickText 类，下面是我摘取的部分代码，可以看到 Q_ENUMS 和 Q_PROPERTY 的使用：

class QQuickText : public QQuickImplicitSizeItem{    Q_OBJECT    Q_ENUMS(HAlignment)    Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged)    Q_PROPERTY(QFont font READ font WRITE setFont NOTIFY fontChanged)    Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged)    ...    public:    enum HAlignment { AlignLeft = Qt::AlignLeft,                       AlignRight = Qt::AlignRight,                       AlignHCenter = Qt::AlignHCenter,                       AlignJustify = Qt::AlignJustify };    ...    QString text() const;    void setText