Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix wxJoystickEvent documentation after the last commit

Browse Source 
Remove left over part of the old sentence.

Also add a link to GetButtonChange() to GetButtonOrdinal()
documentation.
This commit is contained in:
Vadim Zeitlin
2018-11-05 19:17:12 +01:00
parent 291a880d0c
commit 4198107086
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
interface/wx/event.h
View File

@@ -1742,19 +1742,19 @@ public:
Returns the identifier of the button changing state. Returns the identifier of the button changing state.
The return value is @code 1 << n @endcode where @c n is the index of the The return value is @code 1 << n @endcode where @c n is the index of the
button changing state. button changing state, which can also be retrieved using GetButtonOrdinal().
Note that for @c n equal to 1, 2, 3 or 4 there are predefined @c wxJOY_BUTTONn Note that for @c n equal to 1, 2, 3 or 4 there are predefined @c wxJOY_BUTTONn
constants which can be used for more clarity, however these constants are not constants which can be used for more clarity, however these constants are not
defined for the buttons beyond the first four. defined for the buttons beyond the first four.
and whose values were 1 << n. To support more than four buttons, the return value
is now defined as 1 << n.
*/ */
int GetButtonChange() const; int GetButtonChange() const;
/** /**
Returns the 0-indexed ordinal of the button changing state. Returns the 0-indexed ordinal of the button changing state.
@see GetButtonChange()
@since 3.1.2. @since 3.1.2.
*/ */
int GetButtonOrdinal() const; int GetButtonOrdinal() const;