Improve multimedia key constants documentation

Add "since 3.1.0" for the constants introduced back in abd46cb99a (Add
support for multimedia keys to wxMSW and wxGTK, 2016-01-08) and also for
the new constants added in the previous commit.

Also document that WXK_LAUNCH_n keys are only generated by wxGTK.
This commit is contained in:
Vadim Zeitlin
2021-11-05 00:35:34 +01:00
parent 61d835d8b3
commit 77f81bae07

View File

@@ -1064,41 +1064,55 @@ enum wxKeyCode
WXK_SPECIAL19, WXK_SPECIAL19,
WXK_SPECIAL20, WXK_SPECIAL20,
WXK_BROWSER_BACK = 501, WXK_BROWSER_BACK = 501, ///< Since wxWidgets 3.1.0
WXK_BROWSER_FORWARD, WXK_BROWSER_FORWARD, ///< Since wxWidgets 3.1.0
WXK_BROWSER_REFRESH, WXK_BROWSER_REFRESH, ///< Since wxWidgets 3.1.0
WXK_BROWSER_STOP, WXK_BROWSER_STOP, ///< Since wxWidgets 3.1.0
WXK_BROWSER_SEARCH, WXK_BROWSER_SEARCH, ///< Since wxWidgets 3.1.0
WXK_BROWSER_FAVORITES, WXK_BROWSER_FAVORITES, ///< Since wxWidgets 3.1.0
WXK_BROWSER_HOME, WXK_BROWSER_HOME, ///< Since wxWidgets 3.1.0
WXK_VOLUME_MUTE, WXK_VOLUME_MUTE, ///< Since wxWidgets 3.1.0
WXK_VOLUME_DOWN, WXK_VOLUME_DOWN, ///< Since wxWidgets 3.1.0
WXK_VOLUME_UP, WXK_VOLUME_UP, ///< Since wxWidgets 3.1.0
WXK_MEDIA_NEXT_TRACK, WXK_MEDIA_NEXT_TRACK, ///< Since wxWidgets 3.1.0
WXK_MEDIA_PREV_TRACK, WXK_MEDIA_PREV_TRACK, ///< Since wxWidgets 3.1.0
WXK_MEDIA_STOP, WXK_MEDIA_STOP, ///< Since wxWidgets 3.1.0
WXK_MEDIA_PLAY_PAUSE, WXK_MEDIA_PLAY_PAUSE, ///< Since wxWidgets 3.1.0
WXK_LAUNCH_MAIL, WXK_LAUNCH_MAIL, ///< Since wxWidgets 3.1.0
/**
First application launch key.
Note that this constant has the same value as WXK_LAUNCH_A.
@since 3.1.0
*/
WXK_LAUNCH_APP1, WXK_LAUNCH_APP1,
/**
Second application launch key.
Note that this constant has the same value as WXK_LAUNCH_B.
@since 3.1.0
*/
WXK_LAUNCH_APP2, WXK_LAUNCH_APP2,
WXK_LAUNCH_0,
WXK_LAUNCH_1, WXK_LAUNCH_0, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_2, WXK_LAUNCH_1, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_3, WXK_LAUNCH_2, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_4, WXK_LAUNCH_3, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_5, WXK_LAUNCH_4, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_6, WXK_LAUNCH_5, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_7, WXK_LAUNCH_6, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_8, WXK_LAUNCH_7, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_9, WXK_LAUNCH_8, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
/* Alias for backwards compatibility with old gtk bindings, WXK_LAUNCH_9, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
* then continue from LAUNCH_9 */ WXK_LAUNCH_A, ///< Available since wxWidgets 3.1.6, generated by wxGTK and wxMSW.
WXK_LAUNCH_A = WXK_LAUNCH_APP1, WXK_LAUNCH_B, ///< Available since wxWidgets 3.1.6, generated by wxGTK and wxMSW.
WXK_LAUNCH_B = WXK_LAUNCH_APP2, WXK_LAUNCH_C, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_C = WXK_LAUNCH_9 + 1, WXK_LAUNCH_D, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_D, WXK_LAUNCH_E, ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_E, WXK_LAUNCH_F ///< Available since wxWidgets 3.1.6 and only generated by wxGTK.
WXK_LAUNCH_F
}; };
/** /**