Qt提供了一個(gè)絕妙的屬性系統(tǒng)。跟那些由編譯器提供的屬性差不多。然而,作為一個(gè)獨(dú)立于編譯器和平臺(tái)的庫(kù),Qt不依賴于非標(biāo)準(zhǔn)的編譯特性,比如 __property 或[property]。Qt可以在任何平臺(tái)上的標(biāo)準(zhǔn)編譯器下編譯。Qt屬性系統(tǒng)基于元數(shù)據(jù)對(duì)象系統(tǒng)--就是那個(gè)提供了對(duì)象內(nèi)置信號(hào)和槽通訊機(jī)制的家伙。
聲明屬性需要什么
要聲明一個(gè)屬性,需在繼承自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])
下面是一些典型的聲明屬性的示例:
- Q_PROPERTY(bool focus READ hasFocus)
- Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)
- Q_PROPERTY(QCursor cursor READ cursor WRITE setCursor RESET unsetCursor)
- 一個(gè)屬性的行為就像類的數(shù)據(jù)成員,但是它還具有附加的特性,這些特性可以被元數(shù)據(jù)對(duì)象系統(tǒng)操作。這些特性是:
需要一個(gè)READ訪問(wèn)器函數(shù)。用于讀屬性的值。理想情況下,有一個(gè)不變的函數(shù)用于此目的,并且它必須返回屬性的類型的值或指針或引用。例如,QWidget::focus是一個(gè)只讀的屬性,它對(duì)應(yīng)一個(gè)讀函數(shù):QWidget::hasFocus()。 - 一 個(gè)可選的WRITE訪問(wèn)器函數(shù)。它用于設(shè)置屬性的值。它必須返回空并且至少具有一個(gè)參數(shù),參數(shù)是屬性類型的值或指針或引用。例 如:QWidget::enabled具有WRITE函數(shù)QWidget::setEnable()。只讀屬性不需要寫函數(shù)。例 如,QWidget::focus沒(méi)有對(duì)應(yīng)的寫函數(shù)。
- 一個(gè)可選的RESET函數(shù)。用于設(shè)置屬性的值到它的默認(rèn)值。例 如:QWidget::cursor具有典型的READ和WRITE函數(shù),QWidget::cursor()和 QWidget::setCursor(),并且它也具有一個(gè)RESET函數(shù),QWidget::unsetCursor()。RESET函數(shù)必須返回 void并且不帶有任何參數(shù)。
- 一個(gè)可選的NOTIFY信號(hào)。如果被定義了,信號(hào)將在屬性的值改變時(shí)發(fā)出。信號(hào)必須帶有一個(gè)參數(shù),這個(gè)參數(shù)的類型必須與屬性相同;參數(shù)保存的是屬性的新值。
- 一個(gè)DESIGNABLE變量表明此屬性是否在界面設(shè)計(jì)器的屬性編輯器中出現(xiàn)。大多數(shù)屬性是可見(jiàn)的,除了為這個(gè)變量傳入true或false,你還可以指定一個(gè)bool型的成員函數(shù)。
- SCRIPTABLE變量表明這個(gè)屬性是否可以被一個(gè)腳本引擎操作(默認(rèn)是true)。你也可以賦予它true或false或bool型函數(shù)。
- STORED 變量表明了屬性是否被認(rèn)為是獨(dú)立存在還是依賴于其它的值而存在。它也表明是否在保存對(duì)象狀態(tài)時(shí)保存此屬性的值。大多數(shù)屬性都是需要保存的,但是,如 QWidget::minimumWidth()就是不被保存的,因?yàn)樗闹凳菑牧硪粋€(gè)屬性QWidget::minimumSize()得來(lái)的。
- USER變量表明屬性是否被設(shè)計(jì)為面向用戶的或用戶可修改的類屬性。通常,每個(gè)類只有一個(gè)USER屬性。例如,QAbstractButton::checked是按鈕類的用戶可修改屬性。注意QItemDelegate獲取和設(shè)置widget的USER屬性。
- CONSTANT的出現(xiàn)表明屬性的值是不變的。對(duì)于一個(gè)object實(shí)例,常量屬性的READ方法在每次被調(diào)用時(shí)必須返回相同的值。此常量值可能在不同的object實(shí)例中不相同。一個(gè)常量屬性不能具有WRITE方法或NOYIFY信號(hào)。
- FINAL變量的出現(xiàn)表明屬性不能被派生類所重寫。有些情況下,這可以用于效率優(yōu)化,但不是被moc強(qiáng)制的。程序員必須永遠(yuǎn)注意不能重寫一個(gè)FINAL屬性。
READ,WRITE和RESET函數(shù)都可以被繼承。它們也可以是虛函數(shù)。當(dāng)它們?cè)诒欢嘀乩^承中被繼承時(shí),它們必須出現(xiàn)在第一個(gè)被繼承的類中。
屬性的類型可以是被QVariant支持的所有類型,也可以是用戶定義的類型。在下面的例子中,類QDate被當(dāng)作用戶自定義類型。
Q_PROPERTY(QDate data READ getDate WRITE setDate)
因?yàn)镼Date是用戶定義的,你必須包含<QDate>頭文件。
對(duì) 于QMap,QList和QValueList屬性,屬性的值是一個(gè)QVariant,它包含整個(gè)list或map。注意Q_PROPERTY字符串不能 包含逗號(hào),因?yàn)槎禾?hào)會(huì)劃分宏的參數(shù)。因此,你必須使用QMap作為屬性的類型而不是QMap<QString,QVariant>。為了保持 一致性,也需要用QList和QValueList而不是QList<QVariant>和 QValueList<QVariant>。
通過(guò)元數(shù)據(jù)對(duì)象系統(tǒng)讀寫屬性
一 個(gè)屬性可以使用常規(guī)函數(shù)QObject::property()和QObject::setProperty()進(jìn)行讀寫,不用知道屬性所在類的任何細(xì) 節(jié),除了屬性的名字。在下面的小代碼片段中,調(diào)用QAbstractButton::setDown()和QObject::setProperty() 都把屬性設(shè)置為“down”。
- QPushButton *button = new QPushButton;
- QObject *object = button;
- button->setDown(true);
- object->setProperty("down", true);
通 過(guò)WRITE操作器來(lái)操作一個(gè)屬性是上面兩者中更好的,因?yàn)樗觳⑶以诰幾g時(shí)給于更好的診斷幫助,但是以這種方式設(shè)置屬性要求你必須在編譯時(shí)了解其類。通 過(guò)名字來(lái)操作屬性使你可以操作在編譯器你不了解的類。你可以在運(yùn)行時(shí)發(fā)現(xiàn)一個(gè)類的屬性們,通過(guò)查詢它的QObject,QMetaObject和 QMetaProerties。
- QObject *object = ...
- const QMetaObject *metaobject = object->metaObject();
- int count = metaobject->propertyCount();
- for (int i=0; i<count; ++i) {
- QMetaProperty metaproperty = metaobject->property(i);
- const char *name = metaproperty.name();
- QVariant value = object->property(name);
- ...
- }
在上面的代碼片段中,QMetaObject::property()被用于獲取未知類中的屬性的metadata。從metadata中獲取屬性名然后傳給QObject::property()來(lái)獲取
一個(gè)簡(jiǎn)單例子
假 設(shè)我們有一個(gè)類MyClass,它從QObject派生并且在它的private區(qū)使用 了Q_OBJECT宏。我們想在MyClass類中聲明一個(gè)屬性來(lái)持續(xù)追蹤一個(gè)Priorty值。屬性的值叫做priority,并且它的類型是一個(gè)在類 MyClass中定義的叫做Priority的枚舉。
我們?cè)陬惖膒rivate區(qū)使用Q_PROPERTY()來(lái)聲明屬性。READ函數(shù) 叫做priority,并且我們包含一個(gè)WRITE函數(shù)叫做setPriority。枚舉類型必須使用Q_ENUMS()注冊(cè)到元數(shù)據(jù)對(duì)象系統(tǒng)中。注冊(cè)一 個(gè)枚舉類型使得枚舉的名字可以在調(diào)用QObject::setProperty()時(shí)使用。我們還必須為READ和WRITE函數(shù)提供我們自己的聲明。 MyClass的聲明看起來(lái)應(yīng)該是這樣的:
- class MyClass : public QObject
- {
- Q_OBJECT
- Q_PROPERTY(Priority priority READ priority WRITE setPriority)
- Q_ENUMS(Priority)
- public:
- MyClass(QObject *parent = 0);
- ~MyClass();
- enum Priority { High, Low, VeryHigh, VeryLow };
- void setPriority(Priority priority);
- Priority priority() const;
- };
READ函數(shù)是const的并且返回屬性的類型。WRITE函數(shù)返回void并且具有一個(gè)屬性類型的參數(shù)。元數(shù)據(jù)對(duì)象編譯器強(qiáng)制做這些事情。
在有了一個(gè)指向MyClass實(shí)例的指針時(shí),我們有兩種方法來(lái)設(shè)置priority屬性:
- MyClass *myinstance = new MyClass;
- QObject *object = myinstance;
- myinstance->setPriority(MyClass::VeryHigh);
- object->setProperty("priority", "VeryHigh");
在 此例子中,枚舉類型在MyClass中聲明并被使用Q_ENUMS()注冊(cè)到元數(shù)據(jù)對(duì)象系統(tǒng)中。這使得枚舉值可以在調(diào)用setProperty()時(shí)做為 字符串使用。如果枚舉類型是在其它類中聲明的,那么我們就需要用枚舉的全名(如OtherClass::Priority),并且這個(gè)其它類也必須從 QObject中派生并且也要注冊(cè)枚舉類型。
另一個(gè)簡(jiǎn)單的Q_FLAGS()也是可用的。就像Q_ENUMS(),它注冊(cè)一個(gè)枚舉類型,但是它把 枚舉類型作為一個(gè)flag的集合,也就是,值可以用OR操作來(lái)合并。一個(gè)I/O類可能具有枚舉值Read和Write并且 QObject::setProperty()可以接受 Read|Write。此時(shí)應(yīng)使用Q_FLAGS()來(lái)注冊(cè)枚舉值。
動(dòng)態(tài)屬性
Qobject::setProperty() 也可以用來(lái)在運(yùn)行時(shí)向一個(gè)類的實(shí)例添加新的屬性。當(dāng)使用一個(gè)名字和值調(diào)用它時(shí),如果一個(gè)對(duì)應(yīng)的屬性已經(jīng)存在,并且如果值的類型與屬性的類型兼容,那么值就 被存儲(chǔ)到屬性中,然后返回true。如果值類型不兼容,屬性的值就不會(huì)發(fā)生改變,就會(huì)返回false。但是如果對(duì)應(yīng)名字的屬性不存在,那么一個(gè)新的屬性就 誕生了,以傳入的名字為名,以傳入的值為值,但是依然會(huì)返回false。這表示返回值不能用于確定一個(gè)屬性是否被設(shè)置值,除非你已經(jīng)知道這個(gè)屬性已經(jīng)存在 于QObject中了。
注意動(dòng)態(tài)屬性被添加到單個(gè)實(shí)現(xiàn)的基礎(chǔ)中,也就是,被添加到QObject,而不是QMetaObject。一個(gè)屬性可以從 一個(gè)實(shí)例中刪除,通過(guò)傳入屬性的名字和非法的QVariant值給QObject::setProperty()。默認(rèn)的QVariant構(gòu)造器構(gòu)造一個(gè) 非法的QVariant。
動(dòng)態(tài)屬性可用QObject::property()來(lái)查詢,就行使用Q_PROPERTY()聲明的屬性一樣。
屬性和自定義類型
被屬性使用的自定義類型需要使用Q_DECLARE_METATYPE()宏注冊(cè),以使它們的值能被保存在QVariant對(duì)象中。這使得它們可以用于被Q_PROPERTY()聲明的靜態(tài)類型中,也可以被用于動(dòng)態(tài)類型中。