3.7 自定义事件

如果你要使用自定义的事件，你需要下面的几个步骤:

  1. 从一个合适的事件类派生一个你自己的事件类，声明动态类型信息并且实现一个Clone函数，按照你自己的意愿增加新的数据成员和函数成员.如果你希望这个事件在窗口继承关系之间传递，你应该使用的wxCommandEvent派生类，如果你希望这个事件的处理函数可以调用Veto(译者注:某些事件可以调用这个函数来阻止后续可能对这个事件进行的任何操作(如果有的话)，最典型的例子是关闭窗口事件wxEVT_CLOSE)，你应该使用 wxNotifyEvent的派生类.
  2. 为这个事件类的处理函数定义类型.
  3. 定义一个你的事件类支持的事件类型的表。这个表应该定义在你的头文件中。用BEGIN_DECLARE_EVENT_TYPES()宏和END_DECLARE_EVENT_TYPES()宏包含起来。其中的每一个支持的事件的声明应该使用DECLARE_EVENT_TABLE (name, integer)格式的宏.然后在你的.cpp文件中使用DEFINE_EVENT_TYPE(name)来实现这个事件类.
  4. 为每个你的事件类支持的事件定义一个事件映射宏。

我们还是通过例子来让上面这段绕口的话显的更生动一些。假如我们要实现一个新的控件wxFontSelectorCtrl,这个控件将可以显示字体的预览。用户通过点击字体的预览来弹出一个对话框让用户可以更改字体。应用程序也许想拦截这个字体改变事件，因此我们在我们的底层鼠标消息处理过程中将会给应用程序发送一个自定义的字体改变事件。

因此我们需要定义一个新的事件wxFontSelectorCtrlEvent.应用程序可以通过事件映射宏 EVT_FONT_SELECTION_CHANGED(id, func)来增加对这个事件的处理。我们还需要给这个事件定义一个事件类型: wxEVT_COMMAND_FONT_SELECTION_CHANGED. 这样，我们的头文件看上去就象下面的样子:

/*!
 * Font selector event class
 */
class wxFontSelectorCtrlEvent : public wxNotifyEvent
{
public:
    wxFontSelectorCtrlEvent(wxEventType commandType = wxEVT_NULL,
      int id = 0): wxNotifyEvent(commandType, id)
    {}
    wxFontSelectorCtrlEvent(const wxFontSelectorCtrlEvent& event): wxNotifyEvent(event)
    {}
    virtual wxEvent *Clone() const
                  { return new wxFontSelectorCtrlEvent(*this); }
DECLARE_DYNAMIC_CLASS(wxFontSelectorCtrlEvent);
};
typedef void (wxEvtHandler::*wxFontSelectorCtrlEventFunction)
                                        (wxFontSelectorCtrlEvent&);
/*!
 * Font selector control events and macros for handling them
 */
BEGIN_DECLARE_EVENT_TYPES()
    DECLARE_EVENT_TYPE(wxEVT_COMMAND_FONT_SELECTION_CHANGED, 801)
END_DECLARE_EVENT_TYPES()
#define EVT_FONT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(
 wxEVT_COMMAND_FONT_SELECTION_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)
(wxFontSelectorCtrlEventFunction) & fn,
(wxObject *) NULL ),

而在我们的.cpp文件中，看上去则象下面的样子:

DEFINE_EVENT_TYPE(wxEVT_COMMAND_FONT_SELECTION_CHANGED)
IMPLEMENT_DYNAMIC_CLASS(wxFontSelectorCtrlEvent, wxNotifyEvent)

然后，在我们的新控件的鼠标处理函数中，可以通过下面的方法在检测到用户选择了一个新的字体的时候，发送一个自定义的事件：

wxFontSelectorCtrlEvent event(
                    wxEVT_COMMAND_FONT_SELECTION_CHANGED, GetId());
event.SetEventObject(this);
GetEventHandler()->ProcessEvent(event);

现在，在使用我们的新控件的应用程序的代码中就可以通过下面代码来处理我们定义的这个新事件了:

BEGIN_EVENT_TABLE(MyDialog, wxDialog)
  EVT_FONT_SELECTION_CHANGED(ID_FONTSEL, MyDialog::OnChangeFont)
END_EVENT_TABLE()
void MyDialog::OnChangeFont(wxFontSelectorCtrlEvent& event)
{
    // 字体已经更改了，可以作一些必要的处理。
    ...
}

上面用到的事件标识符801在最新的版本中已经没有用处了，之所以这样写只是为了兼容wxWidgets2.4的版本。

让我们再来看一眼事件映射宏的定义：

#define EVT_FONT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(
 wxEVT_COMMAND_FONT_SELECTION_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction)
(wxFontSelectorCtrlEventFunction) & fn,
(wxObject *) NULL ),

这个宏的作用其实是把一个五元组放入到一个数组中，所以这段代码的语法看上去是奇怪了一些，这个五元组的意义分别解释如下：

  • 事件类型:一个事件类可以处理多种事件类型，但是在我们的例子中，只处理了一个事件类型，所以就只有一个事件映射宏的记录。这个事件类型必须要和事件处理函数所有处理的事件的类型一致。
  • 传递给事件映射宏的标识符:只有当事件的标识符和事件表中的标识符一致的时候，相应的事件处理函数才会被调用。
  • 第二标识符。在这里-1表示没有第二标识符。
  • 事件处理函数。如果没有类型的强制转换，一些编译器会报错，这也就是我们要定义事件处理函数类型的原因。
  • 用户数据，通常都是NULL;

随书附带光盘中的examples/chap03目录中有一个完整的自定义事件的例子，其中包括了一个字体选择控件和一个简单验证类，你可以在你的应用程序中使用她们。你还可以阅读你的wxWidgets发行版目录中的include/wx/event.h来获得更多的灵感。