Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor corrections to event handling overview documentation.

Browse Source 
Use "wx" prefix with the macros and correct the event methods used in the
example.

Closes #13752.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69987 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2011-12-11 23:51:18 +00:00
parent bf79972894
commit 1677253b36
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/doxygen/overviews/eventhandling.h
View File

@@ -141,7 +141,7 @@ private:
// obligation to do that; this one is an event handler too: // obligation to do that; this one is an event handler too:
void DoTest(wxCommandEvent& event); void DoTest(wxCommandEvent& event);
DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE()
}; };
@endcode @endcode
@@ -225,7 +225,7 @@ events.
The possibilities of handling events in this way are rather different. The possibilities of handling events in this way are rather different.
Let us start by looking at the syntax: the first obvious difference is that you Let us start by looking at the syntax: the first obvious difference is that you
need not use DECLARE_EVENT_TABLE() nor BEGIN_EVENT_TABLE() and the need not use wxDECLARE_EVENT_TABLE() nor wxBEGIN_EVENT_TABLE() and the
associated macros. Instead, in any place in your code, but usually in associated macros. Instead, in any place in your code, but usually in
the code of the class defining the handler itself (and definitely not in the the code of the class defining the handler itself (and definitely not in the
global scope as with the event tables), call its Bind<>() method like this: global scope as with the event tables), call its Bind<>() method like this:
@@ -621,16 +621,16 @@ wxDECLARE_EVENT(MY_EVENT, wxCommandEvent);
wxDEFINE_EVENT(MY_EVENT, wxCommandEvent); wxDEFINE_EVENT(MY_EVENT, wxCommandEvent);
// example of code handling the event with event tables // example of code handling the event with event tables
BEGIN_EVENT_TABLE(MyFrame, wxFrame) wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU (wxID_EXIT, MyFrame::OnExit) EVT_MENU (wxID_EXIT, MyFrame::OnExit)
... ...
EVT_COMMAND (ID_MY_WINDOW, MY_EVENT, MyFrame::OnMyEvent) EVT_COMMAND (ID_MY_WINDOW, MY_EVENT, MyFrame::OnMyEvent)
END_EVENT_TABLE() wxEND_EVENT_TABLE()
void MyFrame::OnMyEvent(wxCommandEvent& event) void MyFrame::OnMyEvent(wxCommandEvent& event)
{ {
// do something // do something
wxString text = event.GetText(); wxString text = event.GetString();
} }
// example of code handling the event with Bind<>(): // example of code handling the event with Bind<>():
@@ -646,7 +646,7 @@ void MyWindow::SendEvent()
event.SetEventObject(this); event.SetEventObject(this);
// Give it some contents // Give it some contents
event.SetText("Hello"); event.SetString("Hello");
// Do send it // Do send it
ProcessWindowEvent(event); ProcessWindowEvent(event);
@@ -711,9 +711,9 @@ typedef void (wxEvtHandler::*MyPlotEventFunction)(MyPlotEvent&);
// example of code handling the event (you will use one of these methods, not // example of code handling the event (you will use one of these methods, not
// both, of course): // both, of course):
BEGIN_EVENT_TABLE(MyFrame, wxFrame) wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_PLOT(ID_MY_WINDOW, MyFrame::OnPlot) EVT_PLOT(ID_MY_WINDOW, MyFrame::OnPlot)
END_EVENT_TABLE() wxEND_EVENT_TABLE()
MyFrame::MyFrame() MyFrame::MyFrame()
{ {