support for iPhone callbacks

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

diff --git a/interface/wx/accel.h b/interface/wx/accel.h
index e60430af7611a6d7f04644448727623d781213ae..4dcc6fa3d22b577f924c40170315444d377a65ee 100644 (file)
--- a/interface/wx/accel.h
+++ b/interface/wx/accel.h
@@ -16,13 +16,16 @@ enum wxAcceleratorEntryFlags
     /** hold Alt key down */
     wxACCEL_ALT,
 
-    /** hold Ctrl key down */
+    /** hold Ctrl key down, corresponds to Command key on OS X */
     wxACCEL_CTRL,
 
     /** hold Shift key down */
     wxACCEL_SHIFT,
 
-    /** Command key on OS X; identic to wxACCEL_CTRL on other platforms. */
+    /** corresponds to real Ctrl key on OS X, identic to @c wxACCEL_CTRL on other platforms */
+    wxACCEL_RAW_CTRL,
+
+    /** deprecated, identic to @c wxACCEL_CTRL on all platforms. */
     wxACCEL_CMD
 };
 
@@ -105,12 +108,26 @@ 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.
     */
     wxString ToString() const;
 
+    /**
+        Returns a textual representation of this accelerator which is
+        appropriate for saving in configuration files.
+
+        Unlike the string returned by ToString(), this one is never translated
+        so, while it's not suitable for showing to the user, it can be used to
+        uniquely identify the accelerator independently of the user language.
+
+        The returned string can still be parsed by FromString().
+
+        @since 2.9.4
+    */
+    wxString ToRawString() const;
+
     /**
         Parses the given string and sets the accelerator accordingly.
 
@@ -119,7 +136,10 @@ public:
             ToString(), i.e. contain the accelerator itself only, or have the
             format of a full menu item text with i.e. <code>Label TAB
             Accelerator</code>. In the latter case, the part of the string
-            before the TAB is ignored.
+            before the TAB is ignored. Notice that the latter format is only
+            supported for the compatibility with the previous wxWidgets
+            versions and the new code should pass only the accelerator string
+            itself to this function.
 
         @return @true if the given string correctly initialized this object
                 (i.e. if IsOk() returns true after this call)