Qt之emit、signals、slot的使用
參考:https://www.ibm.com/developerworks/cn/linux/guitoolkit/qt/signal-slot/index.html
訊號和槽機制是 QT 的核心機制,要精通 QT 程式設計就必須對訊號和槽有所瞭解。訊號和槽是一種高階介面,應用於物件之間的通訊,它是 QT 的核心特性,也是 QT 區別於其它工具包的重要地方。訊號和槽是 QT 自行定義的一種通訊機制,它獨立於標準的 C/C++ 語言,因此要正確的處理訊號和槽,必須藉助一個稱為 moc(Meta Object Compiler)的 QT 工具,該工具是一個 C++ 預處理程式,它為高層次的事件處理自動生成所需要的附加程式碼。
在我們所熟知的很多 GUI 工具包中,視窗小部件 (widget) 都有一個回撥函式用於響應它們能觸發的每個動作,這個回撥函式通常是一個指向某個函式的指標。但是,在 QT 中訊號和槽取代了這些凌亂的函式指標,使得我們編寫這些通訊程式更為簡潔明瞭。訊號和槽能攜帶任意數量和任意型別的引數,他們是型別完全安全的,不會像回撥函式那樣產生 core dumps。
所有從 QObject 或其子類 ( 例如 Qwidget) 派生的類都能夠包含訊號和槽。當物件改變其狀態時,訊號就由該物件發射 (emit) 出去,這就是物件所要做的全部事情,它不知道另一端是誰在接收這個訊號。這就是真正的資訊封裝,它確保物件被當作一個真正的軟體元件來使用。槽用於接收訊號,但它們是普通的物件成員函式。一個槽並不知道是否有任何訊號與自己相連線。而且,物件並不瞭解具體的通訊機制。
你可以將很多訊號與單個的槽進行連線,也可以將單個的訊號與很多的槽進行連線,甚至於將一個訊號與另外一個訊號相連線也是可能的,這時無論第一個訊號什麼時候發射系統都將立刻發射第二個訊號。總之,訊號與槽構造了一個強大的部件程式設計機制。
訊號
當某個訊號對其客戶或所有者發生的內部狀態發生改變,訊號被一個物件發射。只有定義過這個訊號的類及其派生類能夠發射這個訊號。當一個訊號被髮射時,與其相關聯的槽將被立刻執行,就象一個正常的函式呼叫一樣。訊號 - 槽機制完全獨立於任何 GUI 事件迴圈。只有當所有的槽返回以後發射函式(emit)才返回。如果存在多個槽與某個訊號相關聯,那麼,當這個訊號被髮射時,這些槽將會一個接一個地執行,但是它們執行的順序將會是隨機的、不確定的,我們不能人為地指定哪個先執行、哪 個後執行。
訊號的宣告是在標頭檔案中進行的,QT 的 signals 關鍵字指出進入了訊號宣告區,隨後即可宣告自己的訊號。例如,下面定義了三個訊號:
signals:
void mySignal();
void mySignal(int x);
void mySignalParam(int x,int y);
在上面的定義中,signals 是 QT 的關鍵字,而非 C/C++ 的。接下來的一行 void mySignal() 定義了訊號 mySignal,這個訊號沒有攜帶引數;接下來的一行 void mySignal(int x) 定義 了重名訊號 mySignal,但是它攜帶一個整形引數,這有點類似於 C++ 中的虛擬函式。從形式上講訊號的宣告與普通的 C++ 函式是一樣的,但是訊號卻沒有函式體定義,另外,訊號的返回型別都是 void,不要指望能從訊號返回什麼有用資訊。訊號由
moc 自動產生,它們不應該在 .cpp 檔案中實現。
槽
槽是普通的 C++ 成員函式,可以被正常呼叫,它們唯一的特殊性就是很多訊號可以與其相關聯。當與其關聯的訊號被髮射時,這個槽就會被呼叫。槽可以有引數,但槽的引數不能有預設值。既然槽是普通的成員函式,因此與其它的函式一樣,它們也有存取許可權。槽的存取許可權決定了誰能夠與其相關聯。同普通的 C++ 成員函式一樣,槽函式也分為三種類型,即 public slots、private slots 和 protected slots。
- public slots:在這個區內宣告的槽意味著任何物件都可將訊號與之相連線。這對於元件程式設計非常有用,你可以建立彼此互不瞭解的物件,將它們的訊號與槽進行連線以便資訊能夠正確的傳遞。
- protected slots:在這個區內宣告的槽意味著當前類及其子類可以將訊號與之相連線。這適用於那些槽,它們是類實現的一部分,但是其介面介面卻面向外部。
- private slots:在這個區內宣告的槽意味著只有類自己可以將訊號與之相連線。這適用於聯絡非常緊密的類。
槽也能夠宣告為虛擬函式,這也是非常有用的。
槽的宣告也是在標頭檔案中進行的。例如,下面聲明瞭三個槽:
public slots:
void mySlot();
void mySlot(int x);
void mySignalParam(int x,int y);
訊號與槽的關聯
通過呼叫 QObject 物件的 connect 函式來將某個物件的訊號與另外一個物件的槽函式相關聯,這樣當發射者發射訊號時,接收者的槽函式將被呼叫。該函式的定義如下:
bool QObject::connect ( const QObject * sender, const char * signal,
const QObject * receiver, const char * member ) [static]
這個函式的作用就是將發射者 sender 物件中的訊號 signal 與接收者 receiver 中的 member 槽函式聯絡起來。當指定訊號 signal 時必須使用 QT 的巨集 SIGNAL(),當指定槽函式時必須使用巨集 SLOT()。如果發射者與接收者屬於同一個物件的話,那麼在 connect 呼叫中接收者引數可以省略。
例如,下面定義了兩個物件:標籤物件 label 和滾動條物件 scroll,並將 valueChanged() 訊號與標籤物件的 setNum() 相關聯,另外訊號還攜帶了一個整形引數,這樣標籤總是顯示滾動條所處位置的值。
QLabel *label = new QLabel;
QScrollBar *scroll = new QScrollBar;
QObject::connect( scroll, SIGNAL(valueChanged(int)),
label, SLOT(setNum(int)) );
一個訊號甚至能夠與另一個訊號相關聯,看下面的例子:
class MyWidget : public QWidget
{
public:
MyWidget();
...
signals:
void aSignal();
...
private:
...
QPushButton *aButton;
};
MyWidget::MyWidget()
{
aButton = new QPushButton( this );
connect( aButton, SIGNAL(clicked()), SIGNAL(aSignal()) );
}
在上面的建構函式中,MyWidget 建立了一個私有的按鈕 aButton,按鈕的單擊事件產生的訊號 clicked() 與另外一個訊號 aSignal() 進行了關聯。這樣一來,當訊號 clicked() 被髮射時,訊號 aSignal() 也接著被髮射。當然,你也可以直接將單擊事件與某個私有的槽函式相關聯,然後在槽中發射 aSignal() 訊號,這樣的話似乎有點多餘。
當訊號與槽沒有必要繼續保持關聯時,我們可以使用 disconnect 函式來斷開連線。其定義如下:
bool QObject::disconnect ( const QObject * sender, const char * signal,
const Object * receiver, const char * member ) [static]
這個函式斷開發射者中的訊號與接收者中的槽函式之間的關聯。
有三種情況必須使用 disconnect() 函式:
-
斷開與某個物件相關聯的任何物件。這似乎有點不可理解,事實上,當我們在某個物件中定義了一個或者多個訊號,這些訊號與另外若干個物件中的槽相關聯,如果我們要切斷這些關聯的話,就可以利用這個方法,非常之簡潔。
disconnect( myObject, 0, 0, 0 ) 或者 myObject->disconnect()
斷開與某個特定訊號的任何關聯。
-
disconnect( myObject, SIGNAL(mySignal()), 0, 0 ) 或者 myObject->disconnect( SIGNAL(mySignal()) )
斷開兩個物件之間的關聯。 -
disconnect( myObject, 0, myReceiver, 0 ) 或者 myObject->disconnect( myReceiver )
- 在 disconnect 函式中 0 可以用作一個萬用字元,分別表示任何訊號、任何接收物件、接收物件中的任何槽函式。但是發射者 sender 不能為 0,其它三個引數的值可以等於 0。
元物件工具
元物件編譯器 moc(meta object compiler)對 C++ 檔案中的類宣告進行分析併產生用於初始化元物件的 C++ 程式碼,元物件包含全部訊號和槽的名字以及指向這些函式的指標。
moc 讀 C++ 原始檔,如果發現有 Q_OBJECT 巨集宣告的類,它就會生成另外一個 C++ 原始檔,這個新生成的檔案中包含有該類的元物件程式碼。例如,假設我們有一個頭檔案 mysignal.h,在這個檔案中包含有訊號或槽的宣告,那麼在編譯之前 moc 工具就會根據該檔案自動生成一個名為 mysignal.moc.h 的 C++ 原始檔並將其提交給編譯器;類似地,對應於 mysignal.cpp 檔案 moc 工具將自動生成一個名為 mysignal.moc.cpp 檔案提交給編譯器。
元物件程式碼是 signal/slot 機制所必須的。用 moc 產生的 C++ 原始檔必須與類實現一起進行編譯和連線,或者用 #include 語句將其包含到類的原始檔中。moc 並不擴充套件 #include 或者 #define 巨集定義 , 它只是簡單的跳過所遇到的任何預處理指令。
程式樣例
這裡給出了一個簡單的樣例程式,程式中定義了三個訊號、三個槽函式,然後將訊號與槽進行了關聯,每個槽函式只是簡單的彈出一個對話方塊視窗。
訊號和槽函式的宣告一般位於標頭檔案中,同時在類宣告的開始位置必須加上 Q_OBJECT 語句,這條語句是不可缺少的,它將告訴編譯器在編譯之前必須先應用 moc 工具進行擴充套件。關鍵字 signals 指出隨後開始訊號的宣告,這裡 signals 用的是複數形式而非單數,siganls 沒有 public、private、protected 等屬性,這點不同於 slots。另外,signals、slots 關鍵字是 QT 自己定義的,不是 C++ 中的關鍵字。
訊號的宣告類似於函式的宣告而非變數的宣告,左邊要有型別,右邊要有括號,如果要向槽中傳遞引數的話,在括號中指定每個形式引數的型別,當然,形式引數的個數可以多於一個。
關鍵字 slots 指出隨後開始槽的宣告,這裡 slots 用的也是複數形式。
槽的宣告與普通函式的宣告一樣,可以攜帶零或多個形式引數。既然訊號的宣告類似於普通 C++ 函式的宣告,那麼,訊號也可採用 C++ 中虛擬函式的形式進行宣告,即同名但引數不同。例如,第一次定義的 void mySignal() 沒有帶引數,而第二次定義的卻帶有引數,從這裡我們可以看到 QT 的訊號機制是非常靈活的。
訊號與槽之間的聯絡必須事先用 connect 函式進行指定。如果要斷開二者之間的聯絡,可以使用函式 disconnect。
//tsignal.h
...
class TsignalApp:public QMainWindow
{
Q_OBJECT
...
// 訊號宣告區
signals:
// 宣告訊號 mySignal()
void mySignal();
// 宣告訊號 mySignal(int)
void mySignal(int x);
// 宣告訊號 mySignalParam(int,int)
void mySignalParam(int x,int y);
// 槽宣告區
public slots:
// 宣告槽函式 mySlot()
void mySlot();
// 宣告槽函式 mySlot(int)
void mySlot(int x);
// 宣告槽函式 mySignalParam (int,int)
void mySignalParam(int x,int y);
}
...
//tsignal.cpp
...
TsignalApp::TsignalApp()
{
...
// 將訊號 mySignal() 與槽 mySlot() 相關聯
connect(this,SIGNAL(mySignal()),SLOT(mySlot()));
// 將訊號 mySignal(int) 與槽 mySlot(int) 相關聯
connect(this,SIGNAL(mySignal(int)),SLOT(mySlot(int)));
// 將訊號 mySignalParam(int,int) 與槽 mySlotParam(int,int) 相關聯
connect(this,SIGNAL(mySignalParam(int,int)),SLOT(mySlotParam(int,int)));
}
// 定義槽函式 mySlot()
void TsignalApp::mySlot()
{
QMessageBox::about(this,"Tsignal", "This is a signal/slot sample without
parameter.");
}
// 定義槽函式 mySlot(int)
void TsignalApp::mySlot(int x)
{
QMessageBox::about(this,"Tsignal", "This is a signal/slot sample with one
parameter.");
}
// 定義槽函式 mySlotParam(int,int)
void TsignalApp::mySlotParam(int x,int y)
{
char s[256];
sprintf(s,"x:%d y:%d",x,y);
QMessageBox::about(this,"Tsignal", s);
}
void TsignalApp::slotFileNew()
{
// 發射訊號 mySignal()
emit mySignal();
// 發射訊號 mySignal(int)
emit mySignal(5);
// 發射訊號 mySignalParam(5,100)
emit mySignalParam(5,100);
}
應注意的問題
訊號與槽機制是比較靈活的,但有些侷限性我們必須瞭解,這樣在實際的使用過程中做到有的放矢,避免產生一些錯誤。下面就介紹一下這方面的情況。
1 .訊號與槽的效率是非常高的,但是同真正的回撥函式比較起來,由於增加了靈活性,因此在速度上還是有所損失,當然這種損失相對來說是比較小的,通過在一臺 i586-133 的機器上測試是 10 微秒(執行 Linux),可見這種機制所提供的簡潔性、靈活性還是值得的。但如果我們要追求高效率的話,比如在實時系統中就要儘可能的少用這種機制。
2 .訊號與槽機制與普通函式的呼叫一樣,如果使用不當的話,在程式執行時也有可能產生死迴圈。因此,在定義槽函式時一定要注意避免間接形成無限迴圈,即在槽中再次發射所接收到的同樣訊號。例如 , 在前面給出的例子中如果在 mySlot() 槽函式中加上語句 emit mySignal() 即可形成死迴圈。
3 .如果一個訊號與多個槽相聯絡的話,那麼,當這個訊號被髮射時,與之相關的槽被啟用的順序將是隨機的。
4. 巨集定義不能用在 signal 和 slot 的引數中。
既然 moc 工具不擴充套件 #define,因此,在 signals 和 slots 中攜帶引數的巨集就不能正確地工作,如果不帶引數是可以的。例如,下面的例子中將帶有引數的巨集 SIGNEDNESS(a) 作為訊號的引數是不合語法的:
#ifdef ultrix
#define SIGNEDNESS(a) unsigned a
#else
#define SIGNEDNESS(a) a
#endif
class Whatever : public QObject
{
[...]
signals:
void someSignal( SIGNEDNESS(a) );
[...]
};
5. 建構函式不能用在 signals 或者 slots 宣告區域內。
的確,將一個建構函式放在 signals 或者 slots 區內有點不可理解,無論如何,不能將它們放在 private slots、protected slots 或者 public slots 區內。下面的用法是不合語法要求的:
class SomeClass : public QObject
{
Q_OBJECT
public slots:
SomeClass( QObject *parent, const char *name )
: QObject( parent, name ) {} // 在槽宣告區內宣告建構函式不合語法
[...]
};
6. 函式指標不能作為訊號或槽的引數。
例如,下面的例子中將 void (*applyFunction)(QList*, void*) 作為引數是不合語法的:
class someClass : public QObject
{
Q_OBJECT
[...]
public slots:
void apply(void (*applyFunction)(QList*, void*), char*); // 不合語法
};
你可以採用下面的方法繞過這個限制:
typedef void (*ApplyFunctionType)(QList*, void*);
class someClass : public QObject
{
Q_OBJECT
[...]
public slots:
void apply( ApplyFunctionType, char *);
};
7. 訊號與槽不能有預設引數。
既然 signal->slot 繫結是發生在執行時刻,那麼,從概念上講使用預設引數是困難的。下面的用法是不合理的:
class SomeClass : public QObject
{
Q_OBJECT
public slots:
void someSlot(int x=100); // 將 x 的預設值定義成 100,在槽函式宣告中使用是錯誤的
};
8. 訊號與槽也不能攜帶模板類引數。
如果將訊號、槽宣告為模板類引數的話,即使 moc 工具不報告錯誤,也不可能得到預期的結果。 例如,下面的例子中當訊號發射時,槽函式不會被正確呼叫:
[...]
public slots:
void MyWidget::setLocation (pair<int,int> location);
[...]
public signals:
void MyObject::moved (pair<int,int> location);
但是,你可以使用 typedef 語句來繞過這個限制。如下所示:
typedef pair<int,int> IntPair;
[...]
public slots:
void MyWidget::setLocation (IntPair location);
[...]
public signals:
void MyObject::moved (IntPair location);
這樣使用的話,你就可以得到正確的結果。
9. 巢狀的類不能位於訊號或槽區域內,也不能有訊號或者槽。
例如,下面的例子中,在 class B 中宣告槽 b() 是不合語法的,在訊號區內宣告槽 b() 也是不合語法的。
class A
{
Q_OBJECT
public:
class B
{
public slots: // 在巢狀類中宣告槽不合語法
void b();
[....]
};
signals:
class B
{
// 在訊號區內宣告巢狀類不合語法
void b();
[....]
}:
};
10. 友元宣告不能位於訊號或者槽宣告區內。
相反,它們應該在普通 C++ 的 private、protected 或者 public 區內進行宣告。下面的例子是不合語法規範的:
class someClass : public QObject
{
Q_OBJECT
[...]
signals: // 訊號定義區
friend class ClassTemplate; // 此處定義不合語法
};