Applied rowspan patch #15276 (dghart)

[wxWidgets.git] / include / wx / bookctrl.h

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index d1065dbde5fd5c837bc9e5f403c1b58454df17e5..324fd94ca1509503fd3d23287052fda10c256458 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -256,6 +256,10 @@ protected:
     // false otherwise.
     bool DoSetSelectionAfterInsertion(size_t n, bool bSelect);
 
+    // Update the selection after removing the page at the given index,
+    // typically called from the derived class overridden DoRemovePage().
+    void DoSetSelectionAfterRemoval(size_t n);
+
     // set the selection to the given page, sending the events (which can
     // possibly prevent the page change from taking place) if SendEvent flag is
     // included
@@ -292,7 +296,11 @@ protected:
     // having nodes without any associated page)
     virtual bool AllowNullPage() const { return false; }
 
-    // remove the page and return a pointer to it
+    // Remove the page and return a pointer to it.
+    //
+    // It also needs to update the current selection if necessary, i.e. if the
+    // page being removed comes before the selected one and the helper method
+    // DoSetSelectionAfterRemoval() can be used for this.
     virtual wxWindow *DoRemovePage(size_t page) = 0;
 
     // our best size is the size which fits all our pages