solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Document correct way of handling wxAuiNotebookEvents

Browse source 
They need to be handled at wxAuiNotebook level as they are all processed
there and don't propagate up to the parent.

Closes #24118.
This commit is contained in:
Vadim Zeitlin 2023-12-25 15:01:15 +01:00
parent 83707a975d
commit 18bba7b70b
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
interface/wx/aui/auibook.h
View file

@ -114,6 +114,9 @@ enum wxAuiNotebookOption
Double clicked on the tabs background area. Processes a @c wxEVT_AUINOTEBOOK_BG_DCLICK event.
@endEventTable
Please see the note in wxAuiNotebookEvent documentation about handling
these events.
@library{wxaui}
@category{aui}
*/
@ -712,6 +715,13 @@ public:
This class is used by the events generated by wxAuiNotebook.
Please note that most events generated by wxAuiNotebook are handled by the
notebook object itself, i.e. they do _not_ propagate upwards to the
notebook parent window, in spite of being command events. In order to
handle these events you should use wxEvtHandler::Bind() to connect to the
events on the notebook object itself and don't forget to use
wxEvent::Skip() to ensure that the notebook still processes them too.
@beginEventEmissionTable{wxAuiNotebookEvent}
@event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)}
A page is about to be closed. Processes a @c wxEVT_AUINOTEBOOK_PAGE_CLOSE event.