Qt-属性系统

Qt提供了强大的基于元对象系统的属性系统,可以在运行Qt的平台上支持标准C+＋编译器。要在一个类中声明属性,该类必须继承自QObject类,而且还要在声明前使用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])

其中, type表示属性的类型,可以是QVariant支持的类型或者是用户自定义的类型。如果是枚举类型,则还需要使用Q_ENUMS()宏在元对象系统中进行注册,这样课后才可以使用QObject :: setProperty()函数来使用该属性。name就是属性的名称。READ后面是读取该属性的函数,这个函数是必须有的,而后面带有“[]”号的选项表示这些函数是可选的。一个属性类似于一个数据成员,不过它添加了一些可以通过元对象系统访问的附加功能:

一个读(READ)操作函数。如果 MEMBER变量没有指定,那么该函数是必须有的,它用来读取属性的值。这个函数一般是const类型的,它的返回值类型必须是该属性的类型,或者是该属性类型的指针或者引用。例如,QWidget : : focus是一个只读属性,其READ函数是QWidget : : hasFocus()。

一个可选的写(WRITE)操作函数。它用来设置属性的值。这个函数必须只有一个参数，而且它的返回值必须为空void。例如，QWidget : : enabled 的WRITE函数是QWidget : : setEnabled()。

如果没有指定READ操作函数,那么必须指定一个 MEMBER变量关联,这样会使给定的成员变量变为可读/写的而不用创建READ和WRITE操作函数。一个可选的重置(RESET)函数。它用来将属性恢复到一个默认的值。这个函数不能有参数,而且返回值必须为空 void。例如,QWidget : : cursor的 RESET函数是QWidget : : unsetCursor()。

一个可选的通知(NOTIFY)信号。如果使用该选项,那么需要指定类中一个已经存在的信号,每当该属性的值改变时都会发射该信号。如果使用MEMBER变量时指定NOTIFY信号,那么信号最多只能有一个参数,并且参数的类型必须与属性的类型相同。

一个可选的版本(REVISION)号。如果包含了该版本号,那么它会定义属性及其通知信号只用于特定版本的API(通常暴露给QML),如果不包含,则默认为0。

可选的DESIGNABLE表明这个属性在GUI设计器(例如Qt Designer)的属性编辑器中是否可见。大多数属性的该值为true,即可见。

可选的SCRIPTABLE表明这个属性是否可以被脚本引擎(scripting engine)访问,默认值为true。

可选的STORED表明是否在对象的状态被存储时也必须存储这个属性的值，大部分属性的该值为true。

可选的USER表明这个属性是否被设计为该类的面向用户或者用户可编辑的属性。一般,每一个类中只有一个USER属性,它的默认值为false。例如，QAbstractButton: :checked是按钮的用户可编辑属性。

可选的CONSTANT表明这个属性的值是一个常量。对于给定的一个对象实例,每一次使用常量属性的READ方法都必须返回相同的值,但对于类的不同的实例,这个常量可以不同。一个常量属性不可以有WRITE方法和 NOTIFY信号。

可选的FINAL表明这个属性不能被派生类重写。

其中,READ、WRITE和 RESET函数可以被继承,也可以是虚的( virtual);当在多继承时,它们必须继承自第一个父类。这一节的内容可以在帮助中参考The Property System关键字,下面来看一个具体的例子。

新建Qwidget项目，完成后目名称为myproperty,基类选择QWidget,类名保持 Widget不变。完成后向项目中添加新文件,模板选择C＋＋类,类名为 MyClass,基类Base class选择QObject。添加完新文件后,到myclass.h文件中更改 MyClass类的定义如下:

class MyClass : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString userName READ getUserName WRITE setUserName
               NOTIFY userNameChanged) // 注册属性userName
public:
    explicit MyClass(QObject *parent = 0);
    QString getUserName() const         // 实现READ读函数
    {return m_userName;}
    void setUserName(QString userName)  // 实现WRITE写函数
    {
        m_userName = userName;
        emit userNameChanged(userName); // 当属性值改变时发射该信号
    }
signals:
    void userNameChanged(QString);      // 声明NOTIFY通知消息
private:
    QString m_userName;                 // 私有变量，存放userName属性的值
};

这里使用Q_PROPERTY()宏向元对象系统注册了属性userName,然后声明了几个相应的函数,因为读/写函数都很简单,所以声明时直接进行了定义。下面来看一下在类外对这个属性的使用。
首先在 widget.h文件中添加一个私有槽的声明:

private slots:
     void userChanged(QString);

然后到widget.cpp中
先添加头文件：

#include "myclass.h"
#include <QDebug>

再到构造函数中添加：

 MyClass *my = new MyClass(this);              // 创建MyClass类实例
    connect(my, &MyClass::userNameChanged, this, &Widget::userChanged);
    my->setUserName("yafei");                     // 设置属性的值
    qDebug() << "userName1:" << my->getUserName(); // 输出属性的值
    // 使用QObject类的setProperty()函数设置属性的值
    my->setProperty("userName", "linux");
    // 输出属性的值，这里使用了QObject类的property()函数，它返回值类型为QVariant
    qDebug() << "userName2:" << my->property("userName").toString();

这里创建了MyClass类的实例,然后进行了userName 属性的写人与读取,这里有两种方法:一种是直接调用该属性的相关函数;另一种是使用QObject类的setProperty()函数和property()函数,使用这两个函数要指定属性名。Property() 函数的返回值类型为QVariant,可以使用这个类的toString()函数将其转换为QString类型的数据。

下面添加处理属性值变化的槽的定义:

void Widget::userChanged(QString userName)
{
    qDebug() << "user changed:" << userName;
}

这里只是简单地将userName进行输出。现在可以运行程序,查看输出结果。

使用QObject类的setProperty()函数还可以设置动态属性，只需要将属性名设置为一个类中没有的属性即可。比如在MyClass类外为其添加动态属性“myValue",可
以在widget.cpp文件中构造函数的最后添加如下代码:

 my->setProperty("myValue", 10);                // 动态属性，只对该实例有效
    qDebug() << "myValue:" << my->property("myValue").toInt();

这样添加的动态属性只对实例my有效，对于MyClass类的其他对象没有作用。