X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/be5a51fb592f3fa2ba38ac6cd1e488d6d806058c..cbe6a493b66ad18b6a1f490589f2706f0f841b01:/samples/event/event.cpp diff --git a/samples/event/event.cpp b/samples/event/event.cpp index 3604d6e296..072241989a 100644 --- a/samples/event/event.cpp +++ b/samples/event/event.cpp @@ -5,7 +5,7 @@ // Modified by: // Created: 31.01.01 // RCS-ID: $Id$ -// Copyright: (c) 2001 Vadim Zeitlin +// Copyright: (c) 2001-2009 Vadim Zeitlin // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -17,13 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(__APPLE__) - // DO NOT use event.cpp here, it breaks statics initialization in - // src/common/event.cpp and nothing works at all then! - #pragma implementation "eventsample.cpp" - #pragma interface "eventsample.cpp" -#endif - // For compilers that support precompilation, includes "wx/wx.h". #include "wx/wxprec.h" @@ -37,30 +30,26 @@ #include "wx/wx.h" #endif +#ifndef wxHAS_IMAGES_IN_RESOURCES + #include "../sample.xpm" +#endif + +#include +#include + // ---------------------------------------------------------------------------- // event constants // ---------------------------------------------------------------------------- -// declare a custom event type -// -// note that in wxWin 2.3+ these macros expand simply into the following code: -// -// extern const wxEventType wxEVT_MY_CUSTOM_COMMAND; -// -// const wxEventType wxEVT_MY_CUSTOM_COMMAND = wxNewEventType(); -// -// and you may use this code directly if you don't care about 2.2 compatibility -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EVENT_TYPE(wxEVT_MY_CUSTOM_COMMAND, 7777) -END_DECLARE_EVENT_TYPES() - -DEFINE_EVENT_TYPE(wxEVT_MY_CUSTOM_COMMAND) +// define a custom event type (we don't need a separate declaration here but +// usually you would use a matching wxDECLARE_EVENT in a header) +wxDEFINE_EVENT(wxEVT_MY_CUSTOM_COMMAND, wxCommandEvent); // it may also be convenient to define an event table macro for this event type #define EVT_MY_CUSTOM_COMMAND(id, fn) \ DECLARE_EVENT_TABLE_ENTRY( \ - wxEVT_MY_CUSTOM_COMMAND, id, -1, \ - (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxCommandEventFunction, &fn ), \ + wxEVT_MY_CUSTOM_COMMAND, id, wxID_ANY, \ + wxCommandEventHandler(fn), \ (wxObject *) NULL \ ), @@ -79,8 +68,56 @@ public: // initialization (doing it here and not in the ctor allows to have an error // return: if OnInit() returns false, the application terminates) virtual bool OnInit(); + + // these are regular event handlers used to highlight the events handling + // order + void OnClickDynamicHandlerApp(wxCommandEvent& event); + void OnClickStaticHandlerApp(wxCommandEvent& event); + + // we override wxConsoleApp::FilterEvent used to highlight the events + // handling order + virtual int FilterEvent(wxEvent& event); + +private: + DECLARE_EVENT_TABLE() }; +// Define a custom button used to highlight the events handling order +class MyEvtTestButton : public wxButton +{ +public: + static long BUTTON_ID; + + MyEvtTestButton(wxWindow *parent, const wxString& label) + : wxButton(parent, BUTTON_ID, label) + { + // Add a dynamic handler for this button event to button itself + Connect(wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyEvtTestButton::OnClickDynamicHandler)); + } + +private: + void OnClickDynamicHandler(wxCommandEvent& event) + { + wxLogMessage("Step 3 in \"How Events are Processed\":\n" + "Button::ownDynamicHandler"); + + event.Skip(); + } + + void OnClickStaticHandler(wxCommandEvent& event) + { + wxLogMessage("Step 4 in \"How Events are Processed\":\n" + "Button::ownStaticHandler"); + + event.Skip(); + } + + DECLARE_EVENT_TABLE() +}; + +long MyEvtTestButton::BUTTON_ID = wxNewId(); + // Define a new frame type: this is going to be our main frame class MyFrame : public wxFrame { @@ -91,6 +128,9 @@ public: void OnQuit(wxCommandEvent& event); void OnAbout(wxCommandEvent& event); +#ifdef wxHAS_EVENT_BIND + void OnBind(wxCommandEvent& event); +#endif // wxHAS_EVENT_BIND void OnConnect(wxCommandEvent& event); void OnDynamic(wxCommandEvent& event); void OnPushEventHandler(wxCommandEvent& event); @@ -102,11 +142,46 @@ public: void OnUpdateUIPop(wxUpdateUIEvent& event); -protected: - // number of pushed event handlers - size_t m_nPush; + // regular event handlers used to highlight the events handling order + void OnClickDynamicHandlerFrame(wxCommandEvent& event); + void OnClickDynamicHandlerButton(wxCommandEvent& event); + void OnClickStaticHandlerFrame(wxCommandEvent& event); private: + // symbolic names for the status bar fields + enum + { + Status_Main = 0, + Status_Dynamic, + Status_Push + }; + + void UpdateDynamicStatus(bool on) + { +#if wxUSE_STATUSBAR + if ( on ) + { + SetStatusText("You can now use \"Dynamic\" item in the menu"); + SetStatusText("Dynamic: on", Status_Dynamic); + } + else + { + SetStatusText("You can no more use \"Dynamic\" item in the menu"); + SetStatusText("Dynamic: off", Status_Dynamic); + } +#endif // wxUSE_STATUSBAR + } + + // number of pushed event handlers + unsigned m_nPush; + + // the button to whose event we connect dynamically + wxButton *m_btnDynamic; + + // the button used to highlight the event handlers execution order + MyEvtTestButton *m_testBtn; + + // any class wishing to process wxWidgets events must use this macro DECLARE_EVENT_TABLE() }; @@ -119,7 +194,7 @@ public: void OnTest(wxCommandEvent& event) { - wxLogMessage(_T("This is the pushed test event handler #%u"), m_level); + wxLogMessage(wxT("This is the pushed test event handler #%u"), m_level); // if we don't skip the event, the other event handlers won't get it: // try commenting out this line and see what changes @@ -127,7 +202,7 @@ public: } private: - size_t m_level; + unsigned m_level; DECLARE_EVENT_TABLE() }; @@ -142,6 +217,7 @@ enum // menu items Event_Quit = 1, Event_About, + Event_Bind, Event_Connect, Event_Dynamic, Event_Push, @@ -150,25 +226,31 @@ enum Event_Test }; -// status bar fields -enum -{ - Status_Main = 0, - Status_Dynamic, - Status_Push -}; - // ---------------------------------------------------------------------------- // event tables and other macros for wxWidgets // ---------------------------------------------------------------------------- -// the event tables connect the wxWidgets events with the functions (event -// handlers) which process them. It can be also done at run-time, but for the +// The event tables connect the wxWidgets events with the functions (event +// handlers) which process them. +BEGIN_EVENT_TABLE(MyApp, wxApp) + // Add a static handler for button Click event in the app + EVT_BUTTON(MyEvtTestButton::BUTTON_ID, MyApp::OnClickStaticHandlerApp) +END_EVENT_TABLE() + +BEGIN_EVENT_TABLE(MyEvtTestButton, wxButton) + // Add a static handler to this button itself for its own event + EVT_BUTTON(BUTTON_ID, MyEvtTestButton::OnClickStaticHandler) +END_EVENT_TABLE() + +// This can be also done at run-time, but for the // simple menu events like this the static method is much simpler. BEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_MENU(Event_Quit, MyFrame::OnQuit) EVT_MENU(Event_About, MyFrame::OnAbout) +#ifdef wxHAS_EVENT_BIND + EVT_MENU(Event_Bind, MyFrame::OnBind) +#endif // wxHAS_EVENT_BIND EVT_MENU(Event_Connect, MyFrame::OnConnect) EVT_MENU(Event_Custom, MyFrame::OnFireCustom) @@ -178,10 +260,14 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_UPDATE_UI(Event_Pop, MyFrame::OnUpdateUIPop) - EVT_MY_CUSTOM_COMMAND(-1, MyFrame::OnProcessCustom) + EVT_MY_CUSTOM_COMMAND(wxID_ANY, MyFrame::OnProcessCustom) + + // the line below would also work if OnProcessCustom() were defined as + // taking a wxEvent (as required by EVT_CUSTOM) and not wxCommandEvent + //EVT_CUSTOM(wxEVT_MY_CUSTOM_COMMAND, wxID_ANY, MyFrame::OnProcessCustom) - // this would also work: - //EVT_CUSTOM(wxEVT_MY_CUSTOM_COMMAND, -1, MyFrame::OnProcessCustom) + // Add a static handler in the parent frame for button event + EVT_BUTTON(MyEvtTestButton::BUTTON_ID, MyFrame::OnClickStaticHandlerFrame) END_EVENT_TABLE() BEGIN_EVENT_TABLE(MyEvtHandler, wxEvtHandler) @@ -206,18 +292,60 @@ IMPLEMENT_APP(MyApp) // 'Main program' equivalent: the program execution "starts" here bool MyApp::OnInit() { + if ( !wxApp::OnInit() ) + return false; + // create the main application window - MyFrame *frame = new MyFrame(_T("Event wxWidgets Sample"), + MyFrame *frame = new MyFrame(wxT("Event wxWidgets Sample"), wxPoint(50, 50), wxSize(600, 340)); // and show it (the frames, unlike simple controls, are not shown when // created initially) - frame->Show(TRUE); + frame->Show(true); + + // Add a dynamic handler at the application level for the test button + Connect(MyEvtTestButton::BUTTON_ID, wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyApp::OnClickDynamicHandlerApp)); // success: wxApp::OnRun() will be called which will enter the main message - // loop and the application will run. If we returned FALSE here, the + // loop and the application will run. If we returned false here, the // application would exit immediately. - return TRUE; + return true; +} + +// This is always the first to handle an event ! +int MyApp::FilterEvent(wxEvent& event) +{ + if ( event.GetEventType() == wxEVT_COMMAND_BUTTON_CLICKED && + event.GetId() == MyEvtTestButton::BUTTON_ID ) + { + wxLogMessage("Step 0 in \"How Events are Processed\":\n" + "App::FilterEvent"); + } + + return wxApp::FilterEvent(event); +} + +void MyApp::OnClickDynamicHandlerApp(wxCommandEvent& event) +{ + wxLogMessage("Step 7, 3 in \"How Events are Processed\":\n" + "App::DynamicHandler_InAppTable"); + + event.Skip(); +} + +void MyApp::OnClickStaticHandlerApp(wxCommandEvent& event) +{ + wxLogMessage("Step 7, 4 in \"How Events are Processed\":\n" + "App::StaticHandler_InAppTable"); + + wxLogMessage("Button click processed, there should be no more messages " + "about handling events from the button.\n\n" + "The log below shows the order in which the handlers " + "were executed."); + wxLog::FlushActive(); + + event.Skip(); } // ---------------------------------------------------------------------------- @@ -226,49 +354,88 @@ bool MyApp::OnInit() // frame constructor MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) - : wxFrame((wxFrame *)NULL, -1, title, pos, size) + : wxFrame(NULL, wxID_ANY, title, pos, size) { + SetIcon(wxICON(sample)); + // init members m_nPush = 0; + m_btnDynamic = NULL; // create a menu bar wxMenu *menuFile = new wxMenu; - menuFile->Append(Event_About, _T("&About...\tCtrl-A"), _T("Show about dialog")); + menuFile->Append(Event_About, wxT("&About\tCtrl-A"), wxT("Show about dialog")); menuFile->AppendSeparator(); - menuFile->Append(Event_Quit, _T("E&xit\tAlt-X"), _T("Quit this program")); + menuFile->Append(Event_Quit, wxT("E&xit\tAlt-X"), wxT("Quit this program")); wxMenu *menuEvent = new wxMenu; - menuEvent->Append(Event_Connect, _T("&Connect\tCtrl-C"), - _T("Connect or disconnect the dynamic event handler"), - TRUE /* checkable */); - menuEvent->Append(Event_Dynamic, _T("&Dynamic event\tCtrl-D"), - _T("Dynamic event sample - only works after Connect")); +#ifdef wxHAS_EVENT_BIND + menuEvent->AppendCheckItem(Event_Bind, "&Bind\tCtrl-B", + "Bind or unbind a dynamic event handler"); +#endif // wxHAS_EVENT_BIND + menuEvent->AppendCheckItem(Event_Connect, wxT("&Connect\tCtrl-C"), + wxT("Connect or disconnect the dynamic event handler")); + menuEvent->Append(Event_Dynamic, wxT("&Dynamic event\tCtrl-D"), + wxT("Dynamic event sample - only works after Connect")); menuEvent->AppendSeparator(); - menuEvent->Append(Event_Push, _T("&Push event handler\tCtrl-P"), - _T("Push event handler for test event")); - menuEvent->Append(Event_Pop, _T("P&op event handler\tCtrl-O"), - _T("Pop event handler for test event")); - menuEvent->Append(Event_Test, _T("Test event\tCtrl-T"), - _T("Test event processed by pushed event handler")); + menuEvent->Append(Event_Push, wxT("&Push event handler\tCtrl-P"), + wxT("Push event handler for test event")); + menuEvent->Append(Event_Pop, wxT("P&op event handler\tCtrl-O"), + wxT("Pop event handler for test event")); + menuEvent->Append(Event_Test, wxT("Test event\tCtrl-T"), + wxT("Test event processed by pushed event handler")); menuEvent->AppendSeparator(); - menuEvent->Append(Event_Custom, _T("Fire c&ustom event\tCtrl-U"), - _T("Generate a custom event")); + menuEvent->Append(Event_Custom, wxT("Fire c&ustom event\tCtrl-U"), + wxT("Generate a custom event")); // now append the freshly created menu to the menu bar... wxMenuBar *menuBar = new wxMenuBar(); - menuBar->Append(menuFile, _T("&File")); - menuBar->Append(menuEvent, _T("&Event")); + menuBar->Append(menuFile, wxT("&File")); + menuBar->Append(menuEvent, wxT("&Event")); // ... and attach this menu bar to the frame SetMenuBar(menuBar); #if wxUSE_STATUSBAR CreateStatusBar(3); - SetStatusText(_T("Welcome to wxWidgets event sample")); - SetStatusText(_T("Dynamic: off"), Status_Dynamic); - SetStatusText(_T("Push count: 0"), Status_Push); + SetStatusText(wxT("Welcome to wxWidgets event sample")); + SetStatusText(wxT("Dynamic: off"), Status_Dynamic); + SetStatusText(wxT("Push count: 0"), Status_Push); #endif // wxUSE_STATUSBAR + + wxPanel * const panel = new wxPanel(this); + wxSizer * const mainSizer = new wxBoxSizer(wxVERTICAL); + wxSizer * const sizer = new wxBoxSizer(wxHORIZONTAL); + const wxSizerFlags centreY(wxSizerFlags().Centre().Border()); + sizer->Add(new wxStaticText(panel, wxID_ANY, + "This button will only work if its handler is dynamically connected"), + centreY); + m_btnDynamic = new wxButton(panel, Event_Dynamic, "&Dynamic button"); + sizer->Add(m_btnDynamic, centreY); + + mainSizer->Add(sizer, 1, wxEXPAND); + mainSizer->Add(new wxStaticLine(panel), 0, wxEXPAND); + mainSizer->Add(new wxStaticLine(panel), 0, wxEXPAND); + + m_testBtn = new MyEvtTestButton(panel, "Test Event Handlers Execution Order"); + + // After being created, an instance of MyEvtTestButton already has its own + // event handlers (see class definition); + + // Add a dynamic handler for this button event in the parent frame + Connect(m_testBtn->GetId(), wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyFrame::OnClickDynamicHandlerFrame)); + + // Bind a method of this frame (notice "this" argument!) to the button + // itself + m_testBtn->Connect(wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyFrame::OnClickDynamicHandlerButton), + NULL, + this); + + mainSizer->Add(m_testBtn); + panel->SetSizer(mainSizer); } MyFrame::~MyFrame() @@ -277,7 +444,7 @@ MyFrame::~MyFrame() // crashes! while ( m_nPush-- != 0 ) { - PopEventHandler(TRUE /* delete handler */); + PopEventHandler(true /* delete handler */); } } @@ -287,51 +454,113 @@ MyFrame::~MyFrame() void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event)) { - // TRUE is to force the frame to close - Close(TRUE); + // true is to force the frame to close + Close(true); } void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event)) { - wxMessageBox( wxT("Event sample shows different ways of using events\n") - wxT("© 2001 Vadim Zeitlin"), - wxT("About Event Sample"), wxOK | wxICON_INFORMATION, this ); + wxMessageBox("Event sample shows different ways of using events\n" + "(c) 2001-2009 Vadim Zeitlin", + "About wxWidgets Event Sample", + wxOK | wxICON_INFORMATION, this); +} + +void MyFrame::OnClickStaticHandlerFrame(wxCommandEvent& event) +{ + wxLogMessage("Step 6, 4 in \"How Events are Processed\":\n" + "parentWin::StaticHandler_InFrameTable"); + + event.Skip(); } // ---------------------------------------------------------------------------- // dynamic event handling stuff // ---------------------------------------------------------------------------- -void MyFrame::OnDynamic(wxCommandEvent& WXUNUSED(event)) +void MyFrame::OnClickDynamicHandlerFrame(wxCommandEvent& event) { + wxLogMessage("Step 6, 3 in \"How Events are Processed\":\n" + "parentWin::DynamicHandler_InFrameTable"); + + event.Skip(); +} + +void MyFrame::OnClickDynamicHandlerButton(wxCommandEvent& event) +{ + wxLogMessage("Step 3 in \"How Events are Processed\":\n" + "parentWin::DynamicHandler_InButtonTable"); + + event.Skip(); +} + +void MyFrame::OnDynamic(wxCommandEvent& event) +{ + wxString origin; + if ( event.GetEventObject() == this ) + origin = "menu item"; + else if ( event.GetEventObject() == m_btnDynamic ) + origin = "button"; + else + origin = "unknown event source"; + wxMessageBox ( - wxT("This is a dynamic event handler which can be connected ") - wxT("and disconnected at run-time."), - wxT("Dynamic Event Handler"), wxOK | wxICON_INFORMATION, this + "This message box is shown from the dynamically connected " + "event handler in response to event generated by " + origin, + "wxWidgets Event Sample", wxOK | wxICON_INFORMATION, this ); } -void MyFrame::OnConnect(wxCommandEvent& event) +#ifdef wxHAS_EVENT_BIND + +void MyFrame::OnBind(wxCommandEvent& event) { if ( event.IsChecked() ) { - // disconnect - Connect(Event_Dynamic, -1, wxEVT_COMMAND_MENU_SELECTED, - (wxObjectEventFunction) - (wxEventFunction) - (wxCommandEventFunction)&MyFrame::OnDynamic); - - SetStatusText(_T("You can now use \"Dynamic\" item in the menu")); - SetStatusText(_T("Dynamic: on"), Status_Dynamic); + // as we bind directly to the button, there is no need to use an id + // here: the button will only ever get its own events + m_btnDynamic->Bind(wxEVT_COMMAND_BUTTON_CLICKED, &MyFrame::OnDynamic, + this); + + // but we do need the id for the menu command as the frame gets all of + // them + Bind(wxEVT_COMMAND_MENU_SELECTED, &MyFrame::OnDynamic, this, + Event_Dynamic); } - else // connect + else // disconnect { - Disconnect(Event_Dynamic, -1, wxEVT_COMMAND_MENU_SELECTED); + m_btnDynamic->Unbind(wxEVT_COMMAND_BUTTON_CLICKED, + &MyFrame::OnDynamic, this); + Unbind(wxEVT_COMMAND_MENU_SELECTED, &MyFrame::OnDynamic, this, + Event_Dynamic); + } + + UpdateDynamicStatus(event.IsChecked()); +} - SetStatusText(_T("You can no more use \"Dynamic\" item in the menu")); - SetStatusText(_T("Dynamic: off"), Status_Dynamic); +#endif // wxHAS_EVENT_BIND + +void MyFrame::OnConnect(wxCommandEvent& event) +{ + if ( event.IsChecked() ) + { + m_btnDynamic->Connect(wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyFrame::OnDynamic), + NULL, this); + Connect(Event_Dynamic, wxEVT_COMMAND_MENU_SELECTED, + wxCommandEventHandler(MyFrame::OnDynamic)); + } + else // disconnect + { + m_btnDynamic->Disconnect(wxID_ANY, wxEVT_COMMAND_BUTTON_CLICKED, + wxCommandEventHandler(MyFrame::OnDynamic), + NULL, this); + Disconnect(Event_Dynamic, wxEVT_COMMAND_MENU_SELECTED, + wxCommandEventHandler(MyFrame::OnDynamic)); } + + UpdateDynamicStatus(event.IsChecked()); } // ---------------------------------------------------------------------------- @@ -342,22 +571,26 @@ void MyFrame::OnPushEventHandler(wxCommandEvent& WXUNUSED(event)) { PushEventHandler(new MyEvtHandler(++m_nPush)); - SetStatusText(wxString::Format(_T("Push count: %u"), m_nPush), Status_Push); +#if wxUSE_STATUSBAR + SetStatusText(wxString::Format(wxT("Push count: %u"), m_nPush), Status_Push); +#endif // wxUSE_STATUSBAR } void MyFrame::OnPopEventHandler(wxCommandEvent& WXUNUSED(event)) { - wxCHECK_RET( m_nPush, _T("this command should be disabled!") ); + wxCHECK_RET( m_nPush, wxT("this command should be disabled!") ); - PopEventHandler(TRUE /* delete handler */); + PopEventHandler(true /* delete handler */); m_nPush--; - SetStatusText(wxString::Format(_T("Push count: %u"), m_nPush), Status_Push); +#if wxUSE_STATUSBAR + SetStatusText(wxString::Format(wxT("Push count: %u"), m_nPush), Status_Push); +#endif // wxUSE_STATUSBAR } void MyFrame::OnTest(wxCommandEvent& WXUNUSED(event)) { - wxLogMessage(_T("This is the test event handler in the main frame")); + wxLogMessage(wxT("This is the test event handler in the main frame")); } void MyFrame::OnUpdateUIPop(wxUpdateUIEvent& event) @@ -378,6 +611,6 @@ void MyFrame::OnFireCustom(wxCommandEvent& WXUNUSED(event)) void MyFrame::OnProcessCustom(wxCommandEvent& WXUNUSED(event)) { - wxLogMessage(_T("Got a custom event!")); + wxLogMessage(wxT("Got a custom event!")); }