【VS Code 與 Qt6】運用事件過濾器批次操作子級元件

2023-06-11 21:00:53

如果某個派生自 QObject 的類重寫 eventFilter 方法,那它就成了事件過濾器(Event Filter)。該方法的宣告如下:

virtual bool eventFilter(QObject *watched, QEvent *event);

watched 引數是監聽事件的物件,即事件的接收者;event 引數當然就是待處理的事件了。事件過濾器(也可以翻譯為「篩選器」)可在接收者之前攔截事件,處理完畢後還可以決定是否把事件轉發給接收者。如果不想轉發給事件接收者,就返回 true;若還想讓事件繼續傳播就返回 false。

這玩意兒最有益的用途就是:你的頂層視窗上有 K 個子級元件(正常情形是 QWidget 的子類),如果元件沒有定義你想用的訊號,只能通過處理事件的途徑解決,可你又不想只為了處理一個事件就派生一個類(比如,QLabel元件在滑鼠懸浮時做點事情),就可以用上事件過濾器了。頂層視窗類重寫 eventFilter 方法,攔截髮往子元件的事件(如mouseMove)直接處理,這樣能節省 N 百行程式碼。

重寫了 eventFilter 方法的類就成了事件的過濾者,而呼叫 installEventFilter 方法安裝過濾器的類才是事件的原始接收者。就拿上文咱們舉的 QLabel 元件的例,假設頂層視窗的類名是 DuckWindow,那麼,DuckWindow 重寫 eventFilter 方法,它就是事件的攔截者;而 QLabel 元件就是事件的原始接收者,所以,呼叫 installEventFilter 方法的是它。即 QLabel::installEventFilter( DuckWindow )。

不知道老周這樣說大夥伴們能否理解。就是負責過濾事件的物件重寫 eventFilter 方法;被別人過濾的物件才呼叫 installEventFilter 方法。

我們用範例說事。下面咱們要做的練習是這樣的:

我定義了一個類叫 MyWindow,繼承 QWidget 類,作為頂層視窗。然後在視窗裡,我用一個 QHBoxLayout 佈局,讓視窗內的子級元件水平排列。但每個子元件的顏色不同。常規做法是寫個自定義元件類,從建構函式或通過成員函數傳一個 QColor 物件過去,然後重寫 paintEvent 方法繪圖。這種做法肯定沒問題的。但是!我要是不想寫自定義類呢,那就得考慮事件過濾器了,把 paintEvent 事件過濾,直接用某顏色給子元件畫個背景就行了。

標頭檔案宣告 MyWindow 類。

#ifndef MYWIN
#define MYWIN

#include <QWidget>
#include <QHBoxLayout>
#include <QPainter>
#include <QEvent>
#include <QColor>
#include <QRect>

class MyWindow : public QWidget
{
    Q_OBJECT
public:
    MyWindow(QWidget* parent=nullptr);
    bool eventFilter(QObject *obj, QEvent *event) override;
private:
    // 私有成員,畫痘痘用的
    void paintSomething(QPainter *p, const QColor &color, const QRect &paintRect);
    // 佈局
    QHBoxLayout *layout;
    // 三個子級元件
    QWidget *w1, *w2, *w3;
}; 

#endif

這裡提一下這個 eventFilter 方法,這廝宣告為 public 和 protected 都是可行的。老周這裡就宣告為 public,與基礎類別的宣告一致。

paintSomething 是私有方法,自定義用來畫東西的。有夥伴們會問:QPainter 的 paintDevice 不是可以獲取到繪圖設定(這裡指視窗或元件)的大小的矩形區域嗎,為啥要從引數傳個 QRect?因為這個 rect 來自 QPaintEvent 物件的事件引數,它指的可不一定視窗/元件的整個矩形區域。如果是區域性重繪,這個矩形可能就是其中一小部分割區域。所以,咱們用事件傳遞過來的矩形區域繪圖。

視窗佈局用的是 QHBoxLayout,非常簡單的佈局方式,子級元件在視窗上水平排列。

下面程式碼實現建構函式,初始化各個物件。

MyWindow::MyWindow(QWidget *parent)
    : QWidget(parent)
{
    // 初始化
    layout = new QHBoxLayout;
    this->setLayout(layout);
    w1 = new QWidget(this);
    w2 = new QWidget(this);
    w3 = new QWidget(this);
    layout->addWidget(w1);
    layout->addWidget(w2);
    layout->addWidget(w3);
    // 安裝事件過濾器
    w1->installEventFilter(this);
    w2->installEventFilter(this);
    w3->installEventFilter(this);
}

只有在被攔截的物件上呼叫 installEventFilter 方法系結過濾器後,事件過濾器才會生效。此處,由於 MyWindow 類重寫了 eventFilter 方法,所以過濾器就是 this。

下面是 eventFilter 方法的實現程式碼,只過濾 paint 事件即可,其他傳給基礎類別自己去玩。

bool MyWindow::eventFilter(QObject *obj, QEvent *event)
{
    // 如果是paint事件
    // 這裡「與」判斷事件接收者是不是在那三個子元件中
    // 防止有其他意外物件出現
    // 不過這裡不會發生,因為只有install了過濾器的物件才會被攔截事件
    if(event->type() == QEvent::Paint
        && (obj==w1 || obj==w2 || obj==w3))
    {
        QPaintEvent* pe = static_cast<QPaintEvent*>(event);
        QWidget* uiobj = static_cast<QWidget*>(obj);
        QPainter painter;
        // 注意這裡,繪圖裝置不是this了,而是接收繪圖事件的物件
        // 由於它要求的型別是QPaintDevcie*,所以要進行型別轉換
        // 轉換後的uiobj變數的型別是QWidget*,傳參沒問題
        painter.begin(uiobj);
        if(w1 == uiobj)
        {
            // 紅色
            paintSomething(&painter, QColor("red"), pe->rect());
        }
        if(w2 == uiobj)
        {
            // 橙色
            paintSomething(&painter, QColor("orange"), pe->rect());
        }
        if(w3 == uiobj)
        {
            // 紫色
            paintSomething(&painter, QColor("purple"), pe->rect());
        }
        painter.end();
        return true;
    }
    return QWidget::eventFilter(obj, event);
}

攔截並處理了 paint 事件後,記得返回 true,這樣事件就不會傳給目標物件了(咱們幫它處理了,不必再重複處理,畢竟 QWidget 類預設的 paint 事件是啥也不做)。

下面程式碼是 paintSomething 方法。只是畫了顆巨型青春痘……哦不,是一個橢圓。

void MyWindow::paintSomething(QPainter *p, const QColor &color, const QRect &paintRect)
{
    // 設定畫刷
    p->setBrush(QBrush(color));
    // 無輪廓
    p->setPen(Qt::NoPen);
    // 畫橢圓
    p->drawEllipse(paintRect);
}

setPen中設定 NoPen 是為了在繪製圓時去掉輪廓,預設會畫上輪廓線的。

最後,該到 main 函數了。

int main(int argc, char **argv)
{
    QApplication app(argc,argv);
    MyWindow wind;
    // 視窗標題
    wind.setWindowTitle("乾點雜活");
    // 調整視窗大小
    wind.resize(321, 266);
    wind.show();
    return QApplication::exec();
}

執行一下,看,橫躺著三顆痘痘,多好看。

 

再來一例,這次咱們攔截的是視窗的 close 事件,當視窗要關閉的時候,咱們輸出一條偵錯資訊。

#ifndef 奶牛
#define 奶牛

#include <QObject>
#include <QEvent>

class MyFilter : public QObject
{
protected:
    bool eventFilter(QObject *obj, QEvent *e) override;
};

#endif

這次我們不從任何視覺化型別派生,而是直接派生自 QObject 類。這裡只是重寫 eventFilter 方法,沒有用到訊號和 cao,所以,可以不加 Q_OBJECT 宏。也就是說咱們這個過濾器是獨立用的,不打算加入到 Qt 的物件樹中。

下面是實現程式碼:

bool MyFilter::eventFilter(QObject *obj, QEvent *e)
{
    if(e->type() == QEvent::Close)
    {
        // 此處要型別轉換
        QWidget* window = qobject_cast<QWidget*>(obj);
        // 看看這貨是不是視窗(有可能是控制元件)
        if(window->windowFlags() & Qt::Window)
        {
            // 獲取這個視窗的標題
            QString title = window->windowTitle();
            // 輸出偵錯資訊
            qDebug() << "正在關閉的視窗:" << title;
        }
    }
    // 事件繼續傳遞
    return false;
}

最好返回 false,把事件繼續傳遞給視窗,畢竟視窗可能在關閉時要做一些重要的事,比如儲存開啟的檔案。QWidget 的 WindowFlags 如果包含 Window 值,表明它是一個視窗。

下面直接寫main函數。

int main(int argc, char **argv)
{
    QApplication app(argc, argv);

    MyFilter *filter = new MyFilter;
    // 弄三個視窗試試
    QWidget *win1 = new QWidget;
    win1->setWindowTitle("狗頭");
    win1->installEventFilter(filter);
    win1->show();

    QWidget *win2 = new QWidget;
    win2->setWindowTitle("雞頭");
    win2->installEventFilter(filter);
    win2->show();

    QWidget *win3 = new QWidget;
    win3->setWindowTitle("鼠頭");
    win3->installEventFilter(filter);
    win3->show();

    return QApplication::exec();
    // 可選
    delete filter;
    filter = nullptr;
}

filter 是指標型別,它沒有新增到 Qt 物件樹中,不會自動清理,在exec返回後用 delete 解決它。在清理時有個好習慣,就是 del 之後把指標變數重設為 null,這樣下次再參照變數時不容易產生錯誤,只要 if(! filter) 就能測出它是空的。

反正程式都退出了,所以此處你也可以讓它洩漏一下也無妨。程式掛了後進程空間會被系統收回。

當然,用Qt專供的「作用域」指標也不錯,超出作用域自動XX掉。

int main(int argc, char **argv)
{
    QApplication app(argc, argv);

    QScopedPointer<MyFilter> filter(new MyFilter);
    // 弄三個視窗試試
    QWidget *win1 = new QWidget;
    win1->setWindowTitle("狗頭");
    win1->installEventFilter(filter.data());
    win1->show();

    QWidget *win2 = new QWidget;
    win2->setWindowTitle("雞頭");
    win2->installEventFilter(filter.data());
    win2->show();

    QWidget *win3 = new QWidget;
    win3->setWindowTitle("鼠頭");
    win3->installEventFilter(filter.data());
    win3->show();

    return QApplication::exec();
}

QScopedPointer 通過建構函式參照要封裝的物件,要存取被封裝的指標物件,可以使用 data 成員。

執行之後,會出現三個視窗。逐個關閉,會輸出以下偵錯資訊:

 

---------------------------------------------------------------------------------------

最後老周扯點別的。

咱們知道,Qt官方推出 Python for Qt,名曰 PySide。五月份的時候,老周遇到一個問題:PySide6 無法載入 QML 檔案,報的錯誤是載入 dll 失敗,找不到指定的模組。

網上的方法都是不行的,首先,Qt 在版本號相同(均為 6.5.1)的情況下,C++是可以正常載入 QML 檔案的。不管是生成資原始檔還是直接存取檔案均可。但 Python 是報錯的。這至少說明我的機器上不缺某些 .dll,不然C++程式碼應該也報錯。

接著,老周想是不是Qt官方編譯的有問題,於是,我把自己編譯的Qt動態庫替換 PySide6 裡面的動態連結庫。報錯依舊,那就排除編譯的差異性。

那麼,老周就想到,就是 Python 的問題了,3.7 到 3.10 幾個版本測試也報錯;用不同路徑建的虛擬環境也報錯;更換 Qt 版本(6.0 到 6.5)同樣報錯。

這時可以直接肯定就是 Python 的問題了。不是版本號的問題,是 Windows 商店安裝的 Python 就會報錯,非 Windows 商店安裝的就正常。

不過,還得再加一句話:想把 Qt 用得 666 還是用 C++ 吧,用 Python 僅適合初學和娛樂。由於 Rust 可以呼叫 C/C++ 程式碼,所以你是可以嘗試用 Rust 的。Rust 也不是什麼鬼自動記憶體管理,要 GC 用 .NET 就完事了。Rust 的重點是記憶體安全。看似挺誘人,官方也把牛吹得入木四分。可用了之後(和用 Go 一樣的感覺),是真的沒 C++ 好用。C++ 能揹負上這麼多的歷史包袱也不是靠吹的。當然 C++ 記憶體漏失也沒你想的那麼恐怖。養成好習慣,作用域短,存放資料不多的物件就直接棧分配就行了;要在不同程式碼上下文傳遞物件,或分配的資料較大的,用指標。指標型別的變數,在不要的時候堅決幹掉,然後記得設定變數為 nullptr。養成這些好習慣基本沒多大問題。

一般程式碼你寫慣了是不會忘記 delete 的,容易遺漏的是龐大複雜的程式碼之間會共用某些物件,在很多地方會參照到某物件。於是,碼著碼著就頭暈了,就不記得銷燬了。

會被多處參照的物件,可以寫上註釋提醒自己或別人要清理它,或者加個書籤。寫完程式碼後去看看書籤列表,就會想起有哪些物件還沒銷燬。程式碼寫複雜了會容易混,經常會存取已清理的物件。於是,不妨在存取指標變數前 if 語句一下,if (ptr),在 bool 表示式中,若指標型別的變數是空會得到 false,非空為 true。這樣就可以避免許多低階錯誤。

哪怕是不常用指標的語言也不見得不出事。C# 裡面你要是存取 null 的變數(VB 是 Nothing)也會報那個很經典的錯誤:「未將物件參照設定到物件的範例」,就是 NullReferenceException。在.NET 程式碼中你只要看到這貨就得明白肯定有某個為 null 的物件被存取了。

C++ 裡面,這樣寫就能範例化 MyClass 類,只是分配在棧上。

MyClass x;

但在 C# 中,初始值是 null,即未初始化的,初始化你還得 new。哦,順便想起個事,C# 中資料的隱式基礎類別是 Array,所以它是參照型別,初始值也是 null 的,就算你資料組裡面的元素是值型別,但陣列自身是參照型別。委託也是參照型別。有的剛入門的同學會以為委託是值型別。

C++函數按「參照」傳值的話,一般會用到指標、參照引數,如 int *p、const int &a、const char *w(不能改)等,C# 中如果是參照型別,直接宣告就行了,如 MyClass x,值型別可以用 ref 關鍵字,ref int v。

C# 中 int?、double? 等可以讓其成為參照型別,你可以類比 C 中的 int* 等。