Qt中的Q_PROPERTY宏浅析

1. Q_PROPERTY

Qt提供了一个绝妙的属性系统，Q_PROPERTY()是一个宏，用来在一个类中声明一个属性property，由于该宏是qt特有的，需要用moc进行编译，故必须继承于QObject类。

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

Qt的属性功能使得我们可以选择访问数据成员的方式，属性就像是类的数据成员，但是在元对象系统中，它的其他特性是到处可见的（相比较于类成员的一般情况下私有化）

我们使用这个宏的时候，注意两个问题：

1）类型，属性名和READ（读）方法是必须的。也就是前三个参数可必须有的。类型可以是QVariant支持的任一类型，又或者是我们自定义的类型，其他是可选的。下面的title属性定义可以这么来说明：定义一个属性title，类型是QString，读title的方法是title()函数，写title的方法是setTitle,这里USER表示是否用户自定义类型，这里应该设置为false。

Q_PROPERTY(QString title READ title WRITE setTitle USER true);

2）属性声明完了以后，我们还需要进行读写函数的声明和定义

下面是一些典型的声明属性的示例：

Q_PROPERTY(double minValue READ getMinValue WRITE setMinValue)
Q_PROPERTY(bool animation READ getAnimation WRITE setAnimation)
Q_PROPERTY(QColor barColor READ getBarColor WRITE setBarColor)

• 一个属性的行为就像类的数据成员，但是它还具有附加的特性，这些特性可以被元数据对象系统操作。这些特性是：
  
  需要一个READ访问器函数。用于读属性的值。理想情况下，有一个不变的函数用于此目的，并且它必须返回属性的类型的值或指针或引用。例如，QWidget::focus是一个只读的属性，它对应一个读函数：QWidget::hasFocus()。
• 一个可选的WRITE访问器函数。它用于设置属性的值。它必须返回空并且至少具有一个参数，参数是属性类型的值或指针或引用。例如：QWidget::enabled具有WRITE函数QWidget::setEnable()。只读属性不需要写函数。例如，QWidget::focus没有对应的写函数。
• 一个可选的RESET函数。用于设置属性的值到它的默认值。例如：QWidget::cursor具有典型的READ和WRITE函数，QWidget::cursor()和QWidget::setCursor()，并且它也具有一个RESET函数，QWidget::unsetCursor()。RESET函数必须返回void并且不带有任何参数。
• 一个可选的NOTIFY信号。如果被定义了，信号将在属性的值改变时发出。信号必须带有一个参数，这个参数的类型必须与属性相同；参数保存的是属性的新值。
• 一个DESIGNABLE变量表明此属性是否在界面设计器的属性编辑器中出现。大多数属性是可见的，除了为这个变量传入true或false，你还可以指定一个bool型的成员函数。
• SCRIPTABLE变量表明这个属性是否可以被一个脚本引擎操作（默认是true）。你也可以赋予它true或false或bool型函数。
• STORED变量表明了属性是否被认为是独立存在还是依赖于其它的值而存在。它也表明是否在保存对象状态时保存此属性的值。大多数属性都是需要保存的，但是，如QWidget::minimumWidth()就是不被保存的，因为它的值是从另一个属性QWidget::minimumSize()得来的。
• USER变量表明属性是否被设计为面向用户的或用户可修改的类属性。通常，每个类只有一个USER属性。例如，QAbstractButton::checked是按钮类的用户可修改属性。注意QItemDelegate获取和设置widget的USER属性。
• CONSTANT的出现表明属性的值是不变的。对于一个object实例，常量属性的READ方法在每次被调用时必须返回相同的值。此常量值可能在不同的object实例中不相同。一个常量属性不能具有WRITE方法或NOYIFY信号。
• FINAL变量的出现表明属性不能被派生类所重写。有些情况下，这可以用于效率优化，但不是被moc强制的。程序员必须永远注意不能重写一个FINAL属性。

2. 参考

https://doc.qt.io/