Several improvements to the event-related docs.

See #22448.
This commit is contained in:
Vadim Zeitlin
2022-05-23 22:31:34 +01:00
7 changed files with 25 additions and 22 deletions

View File

@@ -315,7 +315,7 @@ In addition to using a method of the object generating the event itself, you
can use a method from a completely different object as an event handler: can use a method from a completely different object as an event handler:
@code @code
void MyFrameHandler::OnFrameExit( wxCommandEvent & ) void MyFrameHandler::OnFrameExit(wxCommandEvent&)
{ {
// Do something useful. // Do something useful.
} }
@@ -324,8 +324,8 @@ MyFrameHandler myFrameHandler;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_MENU, &MyFrameHandler::OnFrameExit, Bind(wxEVT_MENU, &MyFrameHandler::OnFrameExit,
&myFrameHandler, wxID_EXIT ); &myFrameHandler, wxID_EXIT);
} }
@endcode @endcode
@@ -339,14 +339,14 @@ To use an ordinary function or a static method as an event handler you would
write something like this: write something like this:
@code @code
void HandleExit( wxCommandEvent & ) void HandleExit(wxCommandEvent&)
{ {
// Do something useful // Do something useful
} }
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_MENU, &HandleExit, wxID_EXIT ); Bind(wxEVT_MENU, &HandleExit, wxID_EXIT);
} }
@endcode @endcode
@@ -357,7 +357,7 @@ handler:
struct MyFunctor struct MyFunctor
{ {
void operator()( wxCommandEvent & ) void operator()(wxCommandEvent&)
{ {
// Do something useful // Do something useful
} }
@@ -367,7 +367,7 @@ MyFunctor myFunctor;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_MENU, myFunctor, wxID_EXIT ); Bind(wxEVT_MENU, myFunctor, wxID_EXIT);
} }
@endcode @endcode
@@ -389,14 +389,14 @@ Another common example of a generic functor is boost::function<> or, since
C++11, std::function<>: C++11, std::function<>:
@code @code
#if __cplusplus >= 201103L || wxCHECK_VISUALC_VERSION(10) #if wxCHECK_CXX_STD(201103L)
using namespace std; using namespace std;
using namespace std::placeholders; using namespace std::placeholders;
#else // Pre C++11 compiler #else // Pre C++11 compiler
using namespace boost; using namespace boost;
#endif #endif
void MyHandler::OnExit( wxCommandEvent & ) void MyHandler::OnExit(wxCommandEvent&)
{ {
// Do something useful // Do something useful
} }
@@ -405,9 +405,9 @@ MyHandler myHandler;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
function< void ( wxCommandEvent & ) > exitHandler( bind( &MyHandler::OnExit, &myHandler, _1 )); function<void (wxCommandEvent& )> exitHandler(bind(&MyHandler::OnExit, &myHandler, _1));
Bind( wxEVT_MENU, exitHandler, wxID_EXIT ); Bind(wxEVT_MENU, exitHandler, wxID_EXIT);
} }
@endcode @endcode
@@ -416,7 +416,7 @@ With the aid of @c bind<>() you can even use methods or functions which
don't quite have the correct signature: don't quite have the correct signature:
@code @code
void MyHandler::OnExit( int exitCode, wxCommandEvent &, wxString goodByeMessage ) void MyHandler::OnExit(int exitCode, wxCommandEvent&, wxString goodByeMessage)
{ {
// Do something useful // Do something useful
} }
@@ -425,10 +425,10 @@ MyHandler myHandler;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
function< void ( wxCommandEvent & ) > exitHandler( function<void (wxCommandEvent&)> exitHandler(
bind( &MyHandler::OnExit, &myHandler, EXIT_FAILURE, _1, "Bye" )); bind(&MyHandler::OnExit, &myHandler, EXIT_FAILURE, _1, "Bye"));
Bind( wxEVT_MENU, exitHandler, wxID_EXIT ); Bind(wxEVT_MENU, exitHandler, wxID_EXIT);
} }
@endcode @endcode
@@ -477,7 +477,7 @@ doesn't count as having handled the event and the search continues):
checking the static event table entries, so if both a dynamic and a static checking the static event table entries, so if both a dynamic and a static
event handler match the same event, the static one is never going to be event handler match the same event, the static one is never going to be
used unless wxEvent::Skip() is called in the dynamic one. Also note that used unless wxEvent::Skip() is called in the dynamic one. Also note that
the dynamically bound handlers are searched in order of their registration the dynamically bound handlers are searched in reverse order of their registration
during program run-time, i.e. later bound handlers take priority over the during program run-time, i.e. later bound handlers take priority over the
previously bound ones. previously bound ones.
</li> </li>

View File

@@ -150,7 +150,7 @@ enum wxAuiToolBarToolTextOrientation
wxAuiToolBarEvent is used for the events generated by @ref wxAuiToolBar. wxAuiToolBarEvent is used for the events generated by @ref wxAuiToolBar.
@library{wxaui} @library{wxaui}
@category{aui} @category{aui,events}
*/ */
class wxAuiToolBarEvent : public wxNotifyEvent class wxAuiToolBarEvent : public wxNotifyEvent
{ {

View File

@@ -559,7 +559,7 @@ wxEventType wxEVT_HTML_LINK_CLICKED;
@endEventTable @endEventTable
@library{wxhtml} @library{wxhtml}
@category{html} @category{html,events}
*/ */
class wxHtmlLinkEvent : public wxCommandEvent class wxHtmlLinkEvent : public wxCommandEvent
{ {
@@ -592,7 +592,7 @@ public:
@endEventTable @endEventTable
@library{wxhtml} @library{wxhtml}
@category{html} @category{html,events}
*/ */
class wxHtmlCellEvent : public wxCommandEvent class wxHtmlCellEvent : public wxCommandEvent
{ {

View File

@@ -1332,7 +1332,7 @@ public:
@endEventTable @endEventTable
@library{wxpropgrid} @library{wxpropgrid}
@category{propgrid} @category{propgrid,events}
*/ */
class wxPropertyGridEvent : public wxCommandEvent class wxPropertyGridEvent : public wxCommandEvent
{ {

View File

@@ -479,7 +479,7 @@ public:
@endEventTable @endEventTable
@library{wxnet} @library{wxnet}
@category{net} @category{net,events}
@see wxSocketBase, wxSocketClient, wxSocketServer @see wxSocketBase, wxSocketClient, wxSocketServer
*/ */

View File

@@ -902,6 +902,9 @@ public:
/** /**
Event generated by wxTreeListCtrl. Event generated by wxTreeListCtrl.
@category{ctrl,events}
@since 2.9.3 @since 2.9.3
*/ */
class wxTreeListEvent : public wxNotifyEvent class wxTreeListEvent : public wxNotifyEvent

View File

@@ -788,7 +788,7 @@ public:
@since 3.1.5 @since 3.1.5
@library{wxnet} @library{wxnet}
@category{net} @category{net,events}
@see wxWebRequest @see wxWebRequest
*/ */