美文网首页程序员
向qml注册类型

向qml注册类型

作者: 杯子和盘子 | 来源:发表于2019-11-24 21:24 被阅读0次

    当我们打算向qml中注册自定义的C++类型时,有几个问题需要考虑:
    1. 怎么将C++类型注册到qml框架中,即怎么在qml文件中访问该类型;
    2. qml文件中怎么访问自定义C++类型的属性;
    3. qml文件中怎么访问自定义C++类型的接口函数;
    4. qml文件中怎么处理该自定义C++类型的信号。

    向qml框架注册自定C++类型:

    注册接口qmlRegisterType<CClassName>("PackageName", basVersion, subVersion, "QmlTypeName")
    例如:

    qmlRegisterType<PieChart>("Charts", 1, 0, "PieChart");
    

    在qml中引用该类型:

    import Charts 1.0
    
    Item {
        width: 300; height: 200
    
        PieChart {
            id: aPieChart
            anchors.centerIn: parent
            width: 100; height: 100
            ...
            ...
            ...
        }
    }
    

    qml访问自定义C++类型的属性:

    首先我们思考一个问题:是不是我们只需要将属性定义为public类型,就可以直接在qml中访问该类型的属性了呢?经过测试,证明这样不可行!必须在C++代码中注册属性,并实现其getter和setter接口:
    Q_PROPERTY(QString propertyName READ getter WRITE setter)
    代码如下:

    class PieChart : public QObject
    {
        Q_OBJECT
        //Q_PROPERTY宏申明的属性,可以在qml中使用,还可以用NOTIFY申明信号
        Q_PROPERTY(QString name READ name WRITE setName)
        Q_PROPERTY(QColor color READ color WRITE setColor)
    
    public:
        PieChart(QQuickItem *parent = 0);
    
        QString name() const;
        void setName(const QString &name);
    
        QColor color() const;
        void setColor(const QColor &color);
    
    private:
        QString m_name;
        QColor m_color;
    };
    

    这样就可以在qml中访问其name和color属性了,其值的读取和设置分别由
    QString name() const;
    void setName(const QString &name);

    QColor color() const;
    void setColor(const QColor &color);提供;
    但是有一点需要注意,此时还只能做简单的属性访问和设置,但是不能再qml中对该属性做动态绑定,因为qml框架无法感知属性的变化,自然无法处理该属性的动态绑定问题,那如何能让qml框架感知属性变化,从而实现动态绑定的效果呢?很显然这要用到Qt的信号槽机制,同样还是需要用到Q_PROPERTY来处理:
    Q_PROPERTY(QString propertyName READ getter WRITE setter NOTITY propertyChanged)
    代码如下:

    class PieChart :  public QObject
    {
        Q_OBJECT
        Q_PROPERTY(QString name READ name WRITE setName)
    //! NOTIFY申明信号,通知qml监听属性变化,可以让qml框架感知属性变化,自动实现数据绑定效果
    //! 否则需要自己处理信号,处理每一处的绑定数据的更新!!!!
        Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged)
    public:
        PieChart(QQuickItem *parent = 0);
    
        QString name() const;
        void setName(const QString &name);
    
        QColor color() const;
        void setColor(const QColor &color);
    
        void paint(QPainter *painter);
    
    signals:
        void colorChanged();
    
    private:
        QString m_name;
        QColor m_color;
    };
    
    //在属性发生变化是,发送信号
    void PieChart::setColor(const QColor &color)
    {
        if (color != m_color) {
            m_color = color;
            update();   // repaint with the new color
            emit colorChanged();
        }
    }
    

    qml访问自定义C++类型的函数:

    同样的不能说只是定义成public的函数,就能被qml访问到,一样的需要申明和注册Q_INVOKABLE:
    代码如下:

    Q_INVOKABLE void clearChart();
    

    在qml中就可以如下访问该接口了:

    Item {
        width: 300; height: 200
    
        PieChart {
            id: aPieChart
            anchors.centerIn: parent
            width: 100; height: 100
            color: "red"
        }
    
        MouseArea {
            anchors.fill: parent
            onClicked: {
               //调用自定义接口
                aPieChart.clearChart();
                }
            }
        }
    }
    

    备注:public slot也可以被qml直接调用!

    qml访问自定义C++类型的信号

    信号可以直接访问:

    //c++文件
    signals:
        void chartCleared();
    
    //qml文件:
    PieChart {
            id: aPieChart
            anchors.centerIn: parent
            width: 100; height: 100
            color: "red"
    
            //可以直接获取到chartCleared,不需要特殊的处理
            onChartCleared: console.log("The chart has been cleared")
        }
    

    相关文章

      网友评论

        本文标题:向qml注册类型

        本文链接:https://www.haomeiwen.com/subject/xqhrwctx.html