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

mention wxPostEvent() and wxQueueEvent() and related wxEvtHandler functions.

Browse Source 
use wx prefix for event table macros.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64836 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2010-07-07 10:12:38 +00:00
parent 4539e90321
commit f53a8f6c0c
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -110,7 +110,7 @@ return information is passed via the argument, which is why it is non-const).
You also need to insert a macro You also need to insert a macro
@code @code
DECLARE_EVENT_TABLE() wxDECLARE_EVENT_TABLE()
@endcode @endcode
somewhere in the class declaration. It doesn't matter where it appears but somewhere in the class declaration. It doesn't matter where it appears but
@@ -150,12 +150,12 @@ placed in an implementation file. The event table tells wxWidgets how to map
events to member functions and in our example it could look like this: events to member functions and in our example it could look like this:
@code @code
BEGIN_EVENT_TABLE(MyFrame, wxFrame) wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU(wxID_EXIT, MyFrame::OnExit) EVT_MENU(wxID_EXIT, MyFrame::OnExit)
EVT_MENU(DO_TEST, MyFrame::DoTest) EVT_MENU(DO_TEST, MyFrame::DoTest)
EVT_SIZE(MyFrame::OnSize) EVT_SIZE(MyFrame::OnSize)
EVT_BUTTON(BUTTON1, MyFrame::OnButton1) EVT_BUTTON(BUTTON1, MyFrame::OnButton1)
END_EVENT_TABLE() wxEND_EVENT_TABLE()
@endcode @endcode
Notice that you must mention a method you want to use for the event handling in Notice that you must mention a method you want to use for the event handling in
@@ -537,7 +537,7 @@ and their parent-child relation are well understood by the programmer while it
may be difficult, if not impossible, to track down all the dialogs that may be difficult, if not impossible, to track down all the dialogs that
may be popped up in a complex program (remember that some are created may be popped up in a complex program (remember that some are created
automatically by wxWidgets). If you need to specify a different behaviour for automatically by wxWidgets). If you need to specify a different behaviour for
some reason, you can use wxWindow::SetExtraStyle(wxWS_EX_BLOCK_EVENTS) some reason, you can use <tt>wxWindow::SetExtraStyle(wxWS_EX_BLOCK_EVENTS)</tt>
explicitly to prevent the events from being propagated beyond the given window explicitly to prevent the events from being propagated beyond the given window
or unset this flag for the dialogs that have it on by default. or unset this flag for the dialogs that have it on by default.
@@ -594,6 +594,16 @@ Both strategies are described in details below. See also the @ref
page_samples_event for a complete example of code defining and working with the page_samples_event for a complete example of code defining and working with the
custom event types. custom event types.
Finally, you will need to generate and post your custom events.
Generation is as simple as instancing your custom event class and initializing
its internal fields.
For posting events to a certain event handler there are two possibilities:
using wxEvtHandler::AddPendingEvent or using wxEvtHandler::QueueEvent.
Basically you will need to use the latter when doing inter-thread communication;
when you use only the main thread you can also safely use the former.
Last, note that there are also two simple global wrapper functions associated
to the two wxEvtHandler mentioned functions: wxPostEvent() and wxQueueEvent().
@subsection overview_events_custom_existing Using Existing Event Classes @subsection overview_events_custom_existing Using Existing Event Classes