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
This commit is contained in:
Ian McInerney
2020-09-04 18:23:29 +01:00
parent 55f80941bf
commit b4a50b1ea7

View File

@@ -259,15 +259,22 @@ public:
/** /**
Returns the toolbar item kind. 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; 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); 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; int GetState() const;