From 7cd6a27e1615eea9806b07e5076e75aee23dde90 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 28 Jan 2019 18:56:03 +0100 Subject: [PATCH] Clarify when wxBookCtrl::AddPage() sends page changing events Notably document that it does not do it when adding the first page. --- interface/wx/bookctrl.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/interface/wx/bookctrl.h b/interface/wx/bookctrl.h index 7789496765..dc775d00a6 100644 --- a/interface/wx/bookctrl.h +++ b/interface/wx/bookctrl.h @@ -249,7 +249,10 @@ public: The page must have the book control itself as the parent and must not have been added to this control previously. - The call to this function may generate the page changing events. + The call to this function will generate the page changing and page + changed events if @a select is true, but not when inserting the very + first page (as there is no previous page selection to switch from in + this case and so it wouldn't make sense to e.g. veto such event). @param page Specifies the new page.