From b4a50b1ea7b41e2d72b47ce7093266a0d573320b Mon Sep 17 00:00:00 2001 From: Ian McInerney Date: Fri, 4 Sep 2020 18:23:29 +0100 Subject: [PATCH] Document return types in wxAuiToolBarItem better These functions return only specific flags inside an integer, so in order to use the functions we need to know the flags. Fixes #14972 --- interface/wx/aui/auibar.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/interface/wx/aui/auibar.h b/interface/wx/aui/auibar.h index 5d2e640272..b1c07828b5 100644 --- a/interface/wx/aui/auibar.h +++ b/interface/wx/aui/auibar.h @@ -259,15 +259,22 @@ public: /** Returns the toolbar item kind. + + @return one of @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO, + @c wxITEM_SEPARATOR, @c wxITEM_CONTROL, @c wxITEM_SPACER, @c wxITEM_LABEL, */ int GetKind() const; /** + Set the current state of the toolbar item. + @param new_state is an or'd combination of flags from wxAuiPaneButtonState */ void SetState(int new_state); /** + Gets the current state of the toolbar item. + @return an or'd combination of flags from wxAuiPaneButtonState representing the current state */ int GetState() const;