Merge branch 'aui-events'

Slightly improve and better document AUI events handling.

No real changes.
This commit is contained in:
Vadim Zeitlin 2024-01-12 18:38:01 +01:00
commit ec80639d79
2 changed files with 40 additions and 30 deletions

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.