Document wxGridCellAttrProvider.

[wxWidgets.git] / interface / wx / event.h

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 3b8112894596a119f9db77ae83dbb694a45edc47..9ac341c576b5506598f2638b54d91965654fc1b1 100644 (file)
--- 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.