Correct wxID_SEPARATOR description in menu documentation.

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

diff --git a/interface/wx/defs.h b/interface/wx/defs.h
index 811c187a06db3be0309d68b02609e5bd6c072285..9971fa818e384157789db92c04a72af1b4f02d37 100644 (file)
--- a/interface/wx/defs.h
+++ b/interface/wx/defs.h
@@ -198,7 +198,13 @@ enum wxBackgroundStyle
 
 
 /**
 
 
 /**

-    Standard menu IDs.
+    Standard IDs.
+
+    Notice that some, but @em not all, of these IDs are also stock IDs, i.e.
+    you can use them for the button or menu items without specifying the label
+    which will be provided by the underlying platform itself. See @ref "the
+    list of stock items" for the subset of standard IDs which are stock IDs as
+    well.

 */
 enum wxStandardID
 {
 */
 enum wxStandardID
 {


@@ -480,13 +486,27 @@ enum wxDataFormatId
 /**
     Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
 
 /**
     Virtual keycodes used by wxKeyEvent and some other wxWidgets functions.
 

-    Note that the range @c 33 - @c 126 is reserved for the standard ASCII
-    characters and that the range @c 128 - @c 255 is reserved for the
-    extended ASCII characters (which are not really standard and thus should
-    be avoid in portable apps!).
+    Note that the range <code>0..255</code> corresponds to the characters of
+    the current locale, in particular the <code>32..127</code> subrange is for
+    the ASCII symbols, and all the special key values such as @c WXK_END lie
+    above this range.

 */
 enum wxKeyCode
 {
 */
 enum wxKeyCode
 {

+    /**
+        No key.
+
+        This value is returned by wxKeyEvent::GetKeyCode() if there is no
+        non-Unicode representation for the pressed key (e.g. a Cyrillic letter
+        was entered when not using a Cyrillic locale) and by
+        wxKeyEvent::GetUnicodeKey() if there is no Unicode representation for
+        the key (this happens for the special, non printable, keys only, e.g.
+        WXK_HOME).
+
+        @since 2.9.2 (you can simply use 0 with previous versions).
+     */
+    WXK_NONE    =    0,
+

     WXK_BACK    =    8,     //!< Backspace.
     WXK_TAB     =    9,
     WXK_RETURN  =    13,
     WXK_BACK    =    8,     //!< Backspace.
     WXK_TAB     =    9,
     WXK_RETURN  =    13,


@@ -496,9 +516,11 @@ enum wxKeyCode
     WXK_DELETE  =    127,
 
     /**
     WXK_DELETE  =    127,
 
     /**

-        These are, by design, not compatible with unicode characters.
-        If you want to get a unicode character from a key event, use
-        wxKeyEvent::GetUnicodeKey instead.
+        Special key values.
+
+        These are, by design, not compatible with Unicode characters.
+        If you want to get a Unicode character from a key event, use
+        wxKeyEvent::GetUnicodeKey() instead.

     */
     WXK_START   = 300,
     WXK_LBUTTON,
     */
     WXK_START   = 300,
     WXK_LBUTTON,