X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ab826fd86ffd5aadd2246c14337369aa6af9fab5..62960a2c6e9c54720126a7207fa47e9e539f6040:/interface/wx/event.h diff --git a/interface/wx/event.h b/interface/wx/event.h index 3b81128945..9ac341c576 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -1083,6 +1083,36 @@ protected: }; +/** + Flags for categories of keys. + + These values are used by wxKeyEvent::IsKeyInCategory(). They may be + combined via the bitwise operators |, &, and ~. + + @since 2.9.1 +*/ +enum wxKeyCategoryFlags +{ + /// arrow keys, on and off numeric keypads + WXK_CATEGORY_ARROW, + + /// page up and page down keys, on and off numeric keypads + WXK_CATEGORY_PAGING, + + /// home and end keys, on and off numeric keypads + WXK_CATEGORY_JUMP, + + /// tab key, on and off numeric keypads + WXK_CATEGORY_TAB, + + /// backspace and delete keys, on and off numeric keypads + WXK_CATEGORY_CUT, + + /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories + WXK_CATEGORY_NAVIGATION +}; + + /** @class wxKeyEvent @@ -1177,6 +1207,16 @@ public: */ int GetKeyCode() const; + /** + Returns true if the key is in the given key category. + + @param category + A bitwise combination of named ::wxKeyCategoryFlags constants. + + @since 2.9.1 + */ + bool IsKeyInCategory(int category) const; + //@{ /** Obtains the position (in client coordinates) at which the key was pressed.