Document wxBookCtrlBase::GetControlSizer

The documentation for wxChoiceBook discusses using this method, but it
was not previously documented.

See #23211.

Co-Authored-By: Vadim Zeitlin <vadim@wxwidgets.org>
This commit is contained in:
Scott Talbert 2023-02-02 13:55:26 -05:00 committed by Vadim Zeitlin
parent f7d0742715
commit 3cc00091e2

View file

@ -333,6 +333,21 @@ public:
*/
wxWindow* GetPage(size_t page) const;
/**
Returns the sizer containing the control for page selection, if any.
Some derived classes, e.g. wxChoicebook, use a separate control for
switching the currently selected page and this function returns the
sizer used for positioning this control and the pages themselves inside
the book control.
Note that many classes, notably wxNotebook, do not use any such
control, and this function simply returns @NULL for them.
@return Non-owning pointer to the sizer or @NULL.
*/
wxSizer* GetControlSizer() const;
///@}
@ -360,9 +375,6 @@ public:
void SetFitToCurrentPage(bool fit) { m_fitToCurrentPage = fit; }
bool GetFitToCurrentPage() const { return m_fitToCurrentPage; }
// returns the sizer containing the control, if any
wxSizer* GetControlSizer() const { return m_controlSizer; }
// we do have multiple pages
virtual bool HasMultiplePages() const { return true; }