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

Don't mention deprecated event type constants in the documentation

Browse Source 
Several wxEVT_COMMAND_xxx constants were replaced with alternative (shorter) names in ce7fe42e84 and since 2.9.5 they are actually deprecated and shouldn't be mentioned in the documentation.
This commit is contained in:
Artur Wieczorek
2019-07-22 21:09:37 +02:00
parent 66b798692e
commit 9eb4c8ee2b
4 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/doxygen/overviews/bookctrl.h
View File

@@ -41,12 +41,12 @@ The mapping consists of:
@beginTable @beginTable
@row2col{ ::wxBookCtrl, wxChoicebook or wxNotebook } @row2col{ ::wxBookCtrl, wxChoicebook or wxNotebook }
@row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED, @row2col{ @c wxEVT_BOOKCTRL_PAGE_CHANGED,
@c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or @c wxEVT_CHOICEBOOK_PAGE_CHANGED or
@c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED } @c wxEVT_NOTEBOOK_PAGE_CHANGED }
@row2col{ @c wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING, @row2col{ @c wxEVT_BOOKCTRL_PAGE_CHANGING,
@c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or @c wxEVT_CHOICEBOOK_PAGE_CHANGING or
@c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING } @c wxEVT_NOTEBOOK_PAGE_CHANGING }
@row2col{ @c EVT_BOOKCTRL_PAGE_CHANGED(id\, fn), @row2col{ @c EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
@c EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or @c EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or
@c EVT_NOTEBOOK_PAGE_CHANGED(id, fn) } @c EVT_NOTEBOOK_PAGE_CHANGED(id, fn) }

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

@@ -225,7 +225,7 @@ global scope as with the event tables), call its Bind<>() method like this:
@code @code
MyFrame::MyFrame(...) MyFrame::MyFrame(...)
{ {
Bind(wxEVT_COMMAND_MENU_SELECTED, &MyFrame::OnExit, this, wxID_EXIT); Bind(wxEVT_MENU, &MyFrame::OnExit, this, wxID_EXIT);
} }
@endcode @endcode
@@ -324,7 +324,7 @@ MyFrameHandler myFrameHandler;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_COMMAND_MENU_SELECTED, &MyFrameHandler::OnFrameExit, Bind( wxEVT_MENU, &MyFrameHandler::OnFrameExit,
&myFrameHandler, wxID_EXIT ); &myFrameHandler, wxID_EXIT );
} }
@endcode @endcode
@@ -346,7 +346,7 @@ void HandleExit( wxCommandEvent & )
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_COMMAND_MENU_SELECTED, &HandleExit, wxID_EXIT ); Bind( wxEVT_MENU, &HandleExit, wxID_EXIT );
} }
@endcode @endcode
@@ -367,7 +367,7 @@ MyFunctor myFunctor;
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind( wxEVT_COMMAND_MENU_SELECTED, myFunctor, wxID_EXIT ); Bind( wxEVT_MENU, myFunctor, wxID_EXIT );
} }
@endcode @endcode
@@ -377,7 +377,7 @@ separate functor class:
@code @code
MyFrame::MyFrame() MyFrame::MyFrame()
{ {
Bind(wxEVT_COMMAND_MENU_SELECTED, Bind(wxEVT_MENU,
[](wxCommandEvent&) { [](wxCommandEvent&) {
// Do something useful // Do something useful
}, },
@@ -407,7 +407,7 @@ MyFrame::MyFrame()
{ {
function< void ( wxCommandEvent & ) > exitHandler( bind( &MyHandler::OnExit, &myHandler, _1 )); function< void ( wxCommandEvent & ) > exitHandler( bind( &MyHandler::OnExit, &myHandler, _1 ));
Bind( wxEVT_COMMAND_MENU_SELECTED, exitHandler, wxID_EXIT ); Bind( wxEVT_MENU, exitHandler, wxID_EXIT );
} }
@endcode @endcode
@@ -428,7 +428,7 @@ 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_COMMAND_MENU_SELECTED, exitHandler, wxID_EXIT ); Bind( wxEVT_MENU, exitHandler, wxID_EXIT );
} }
@endcode @endcode

7
docs/doxygen/overviews/propgrid.h
View File

@@ -807,10 +807,9 @@ See wxPGMultiButton class reference.
@subsection propgrid_customeventhandling Handling Events Passed from Properties @subsection propgrid_customeventhandling Handling Events Passed from Properties
<b>wxEVT_COMMAND_BUTTON_CLICKED </b>(corresponds to event table macro EVT_BUTTON): @c wxEVT_BUTTON: Occurs when editor button click is not handled by the property
Occurs when editor button click is not handled by the property itself itself (as is the case, for example, if you set property's editor
(as is the case, for example, if you set property's editor to TextCtrlAndButton to TextCtrlAndButton from the original TextCtrl).
from the original TextCtrl).
@subsection propgrid_attributes Property Attributes @subsection propgrid_attributes Property Attributes

4
docs/doxygen/overviews/xrc.h
View File

@@ -196,10 +196,10 @@ void MyClass::ShowDialog()
if (!wxXmlResource::Get()->LoadDialog(&dlg, NULL, "SimpleDialog")) if (!wxXmlResource::Get()->LoadDialog(&dlg, NULL, "SimpleDialog"))
return; return;
XRCCTRL(dlg, "text", wxTextCtrl)->Bind(wxEVT_COMMAND_TEXT_UPDATED, XRCCTRL(dlg, "text", wxTextCtrl)->Bind(wxEVT_TEXT,
wxTextEventHandler(MyClass::OnTextEntered), this, XRCID("text")); wxTextEventHandler(MyClass::OnTextEntered), this, XRCID("text"));
XRCCTRL(dlg, "clickme_btn", wxButton)->Bind(wxEVT_COMMAND_BUTTON_CLICKED, XRCCTRL(dlg, "clickme_btn", wxButton)->Bind(wxEVT_BUTTON,
wxCommandEventHandler(MyClass::OnClickme), this, XRCID("clickme_btn")); wxCommandEventHandler(MyClass::OnClickme), this, XRCID("clickme_btn"));
dlg.ShowModal(); dlg.ShowModal();