zhonghua

Qt提供了一個絕妙的屬性系統。跟那些由編譯器提供的屬性差不多。然而，作為一個獨立于編譯器和平臺的庫，Qt不依賴于非標準的編譯特性，比如 __property 或[property]。Qt可以在任何平臺上的標準編譯器下編譯。Qt屬性系統基于元數據對象系統－－就是那個提供了對象內置信號和槽通訊機制的家伙。

聲明屬性需要什么

要聲明一個屬性，需在繼承自QObject的類中使用Q_PROPERTY()宏。
Q_PROPERTY(type name
   READ getFunction
   [WRITE setFunction]
   [RESET resetFunction]
   [NOTIFY notifySignal]
   [DESIGNABLE bool]
   [SCRIPTABLE bool]
   [STORED bool]
   [USER bool]
   [CONSTANT]
   [FINAL])

下面是一些典型的聲明屬性的示例：

• 一個屬性的行為就像類的數據成員，但是它還具有附加的特性，這些特性可以被元數據對象系統操作。這些特性是：
  需要一個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屬性。
  

READ，WRITE和RESET函數都可以被繼承。它們也可以是虛函數。當它們在被多重繼承中被繼承時，它們必須出現在第一個被繼承的類中。

屬性的類型可以是被QVariant支持的所有類型，也可以是用戶定義的類型。在下面的例子中，類QDate被當作用戶自定義類型。
Q_PROPERTY(QDate data READ getDate WRITE setDate)
因為QDate是用戶定義的，你必須包含<QDate>頭文件。

對 于QMap,QList和QValueList屬性，屬性的值是一個QVariant，它包含整個list或map。注意Q_PROPERTY字符串不能 包含逗號，因為逗號會劃分宏的參數。因此，你必須使用QMap作為屬性的類型而不是QMap<QString,QVariant>。為了保持 一致性，也需要用QList和QValueList而不是QList<QVariant>和 QValueList<QVariant>。

通過元數據對象系統讀寫屬性

一 個屬性可以使用常規函數QObject::property()和QObject::setProperty()進行讀寫，不用知道屬性所在類的任何細 節，除了屬性的名字。在下面的小代碼片段中，調用QAbstractButton::setDown()和QObject::setProperty() 都把屬性設置為“down”。

通 過WRITE操作器來操作一個屬性是上面兩者中更好的，因為它快并且在編譯時給于更好的診斷幫助，但是以這種方式設置屬性要求你必須在編譯時了解其類。通 過名字來操作屬性使你可以操作在編譯器你不了解的類。你可以在運行時發現一個類的屬性們，通過查詢它的QObject,QMetaObject和 QMetaProerties。

在上面的代碼片段中，QMetaObject::property()被用于獲取未知類中的屬性的metadata。從metadata中獲取屬性名然后傳給QObject::property()來獲取

一個簡單例子

假 設我們有一個類MyClass，它從QObject派生并且在它的private區使用 了Q_OBJECT宏。我們想在MyClass類中聲明一個屬性來持續追蹤一個Priorty值。屬性的值叫做priority，并且它的類型是一個在類 MyClass中定義的叫做Priority的枚舉。

我們在類的private區使用Q_PROPERTY()來聲明屬性。READ函數 叫做priority,并且我們包含一個WRITE函數叫做setPriority。枚舉類型必須使用Q_ENUMS()注冊到元數據對象系統中。注冊一 個枚舉類型使得枚舉的名字可以在調用QObject::setProperty()時使用。我們還必須為READ和WRITE函數提供我們自己的聲明。 MyClass的聲明看起來應該是這樣的：

READ函數是const的并且返回屬性的類型。WRITE函數返回void并且具有一個屬性類型的參數。元數據對象編譯器強制做這些事情。

在有了一個指向MyClass實例的指針時，我們有兩種方法來設置priority屬性：

在 此例子中，枚舉類型在MyClass中聲明并被使用Q_ENUMS()注冊到元數據對象系統中。這使得枚舉值可以在調用setProperty()時做為 字符串使用。如果枚舉類型是在其它類中聲明的，那么我們就需要用枚舉的全名（如OtherClass::Priority)，并且這個其它類也必須從 QObject中派生并且也要注冊枚舉類型。
另一個簡單的Q_FLAGS()也是可用的。就像Q_ENUMS()，它注冊一個枚舉類型，但是它把 枚舉類型作為一個flag的集合，也就是，值可以用OR操作來合并。一個I/O類可能具有枚舉值Read和Write并且 QObject::setProperty()可以接受 Read|Write。此時應使用Q_FLAGS()來注冊枚舉值。

動態屬性

Qobject::setProperty() 也可以用來在運行時向一個類的實例添加新的屬性。當使用一個名字和值調用它時，如果一個對應的屬性已經存在，并且如果值的類型與屬性的類型兼容，那么值就 被存儲到屬性中，然后返回true。如果值類型不兼容，屬性的值就不會發生改變，就會返回false。但是如果對應名字的屬性不存在，那么一個新的屬性就 誕生了，以傳入的名字為名，以傳入的值為值，但是依然會返回false。這表示返回值不能用于確定一個屬性是否被設置值，除非你已經知道這個屬性已經存在 于QObject中了。
注意動態屬性被添加到單個實現的基礎中，也就是，被添加到QObject，而不是QMetaObject。一個屬性可以從 一個實例中刪除，通過傳入屬性的名字和非法的QVariant值給QObject::setProperty()。默認的QVariant構造器構造一個 非法的QVariant。
動態屬性可用QObject::property()來查詢，就行使用Q_PROPERTY()聲明的屬性一樣。

屬性和自定義類型

被屬性使用的自定義類型需要使用Q_DECLARE_METATYPE()宏注冊，以使它們的值能被保存在QVariant對象中。這使得它們可以用于被Q_PROPERTY()聲明的靜態類型中，也可以被用于動態類型中。