From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Wed, 23 May 2012 21:16:28 +0000 (+0000)
Subject: Document "raw control" use with accelerators.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/5ec18516f68f0fd34dff798b1ad7f63479adb714?ds=inline

Document "raw control" use with accelerators.

Mention it in the places where the other accelerator prefixes are documented.

See #13496.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71541 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/accel.h b/interface/wx/accel.h
index bdc72a32ea..4dcc6fa3d2 100644
--- a/interface/wx/accel.h
+++ b/interface/wx/accel.h
@@ -108,7 +108,7 @@ public:
     /**
         Returns a textual representation of this accelerator.
 
-        The returned string is of the form <code>[Alt+][Ctrl+][Shift+]Key</code>
+        The returned string is of the form <code>[Alt+][Ctrl+][RawCtrl+][Shift+]Key</code>
         where the modifier keys are present only if the corresponding flag is
         set.
     */
diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h
index c0e16ffbc3..83b96c7c77 100644
--- a/interface/wx/menuitem.h
+++ b/interface/wx/menuitem.h
@@ -362,9 +362,16 @@ public:
         
         Optionally you can specify also an accelerator string appending a tab character 
         <tt>\\t</tt> followed by a valid key combination (e.g. <tt>CTRL+V</tt>).
-        Its general syntax is any combination of @c "CTRL", @c "ALT" and @c "SHIFT" strings
-        (case doesn't matter) separated by either @c '-' or @c '+' characters and followed
-        by the accelerator itself.
+        Its general syntax is any combination of @c "CTRL", @c "RAWCTRL",  @c
+        "ALT" and @c "SHIFT" strings (case doesn't matter) separated by either
+        @c '-' or @c '+' characters and followed by the accelerator itself.
+        Notice that @c CTRL corresponds to the "Ctrl" key on most platforms but
+        not under Mac OS where it is mapped to "Cmd" key on Mac keyboard.
+        Usually this is exactly what you want in portable code but if you
+        really need to use the (rarely used for this purpose) "Ctrl" key even
+        under Mac, you may use @c RAWCTRL to prevent this mapping. Under the
+        other platforms @c RAWCTRL is the same as plain @c CTRL.
+
         The accelerator may be any alphanumeric character, any function key
         (from F1 to F12) or one of the special characters listed in the table
         below (again, case doesn't matter):