Fix menu event handlers calling order.

Pass the menu event to the window associated with the menu first, before
falling back on wxApp.

This required adding yet another flag to keep state in wxEvent but it seems to
be unavoidable as wxMenuBase::SendEvent() calls ProcessEvent() twice and we
must have some way to distinguish the first call from the second one.

Added a test case verifying that the menu events are indeed processed in the
expected order.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73921 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2013-05-04 23:59:29 +00:00
parent 0492f62e0b
commit 3bad8c3926
4 changed files with 112 additions and 10 deletions

View File

@@ -24,6 +24,9 @@
#include "wx/window.h"
#endif // WX_PRECOMP
#include "wx/frame.h"
#include "wx/menu.h"
#include "wx/scopeguard.h"
namespace
@@ -81,6 +84,14 @@ struct TestEvtHandler : TestEvtHandlerBase<wxCommandEvent>
}
};
struct TestMenuEvtHandler : TestEvtHandlerBase<wxCommandEvent>
{
TestMenuEvtHandler(char tag)
: TestEvtHandlerBase<wxCommandEvent>(wxEVT_MENU, tag)
{
}
};
struct TestPaintEvtHandler : TestEvtHandlerBase<wxPaintEvent>
{
TestPaintEvtHandler(char tag)
@@ -144,7 +155,8 @@ private:
int DoFilterEvent(wxEvent& event)
{
if ( event.GetEventType() == TEST_EVT )
if ( event.GetEventType() == TEST_EVT ||
event.GetEventType() == wxEVT_MENU )
g_str += 'a';
return -1;
@@ -152,7 +164,8 @@ int DoFilterEvent(wxEvent& event)
bool DoProcessEvent(wxEvent& event)
{
if ( event.GetEventType() == TEST_EVT )
if ( event.GetEventType() == TEST_EVT ||
event.GetEventType() == wxEVT_MENU )
g_str += 'A';
return false;
@@ -181,6 +194,7 @@ private:
CPPUNIT_TEST( ForwardEvent );
CPPUNIT_TEST( ScrollWindowWithoutHandler );
CPPUNIT_TEST( ScrollWindowWithHandler );
CPPUNIT_TEST( MenuEvent );
CPPUNIT_TEST_SUITE_END();
void OneHandler();
@@ -190,6 +204,7 @@ private:
void ForwardEvent();
void ScrollWindowWithoutHandler();
void ScrollWindowWithHandler();
void MenuEvent();
DECLARE_NO_COPY_CLASS(EventPropagationTestCase)
};
@@ -347,3 +362,48 @@ void EventPropagationTestCase::ScrollWindowWithHandler()
CPPUNIT_ASSERT_EQUAL( "apA", g_str );
}
// Helper for checking that the menu event processing resulted in the expected
// output from the handlers.
void CheckMenuEvent(wxMenu* menu, const char* expected)
{
g_str.clear();
// Trigger the menu event: this is more reliable than using
// wxUIActionSimulator and currently works in all ports as they all call
// wxMenuBase::SendEvent() from their respective menu event handlers.
menu->SendEvent(wxID_NEW);
CPPUNIT_ASSERT_EQUAL( expected, g_str );
}
void EventPropagationTestCase::MenuEvent()
{
// Create a minimal menu bar.
wxMenu* const menu = new wxMenu;
menu->Append(wxID_NEW);
wxMenuBar* const mb = new wxMenuBar;
mb->Append(menu, "&Menu");
wxFrame* const frame = static_cast<wxFrame*>(wxTheApp->GetTopWindow());
frame->SetMenuBar(mb);
wxON_BLOCK_EXIT_OBJ1( *frame, wxFrame::SetMenuBar, (wxMenuBar*)NULL );
// Check that wxApp gets the event exactly once.
CheckMenuEvent( menu, "aA" );
// Check that the menu event handler is called.
TestMenuEvtHandler hm('m'); // 'm' for "menu"
menu->SetNextHandler(&hm);
wxON_BLOCK_EXIT_OBJ1( *menu,
wxEvtHandler::SetNextHandler, (wxEvtHandler*)NULL );
CheckMenuEvent( menu, "aomA" );
// Also test that the window to which the menu belongs gets the event.
TestMenuEvtHandler hw('w'); // 'w' for "Window"
frame->PushEventHandler(&hw);
wxON_BLOCK_EXIT_OBJ1( *frame, wxWindow::PopEventHandler, false );
CheckMenuEvent( menu, "aomowA" );
}