Document "raw control" use with accelerators.

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

diff --git a/interface/wx/strconv.h b/interface/wx/strconv.h
index 174133388e839ded8d50d8349873a27b1ec01544..fd0169589c5c43c3da41eaa6b27f7434c1e62b17 100644 (file)
--- a/interface/wx/strconv.h
+++ b/interface/wx/strconv.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxMBConvUTF7
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxMBConvUTF7
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -177,6 +177,23 @@ public:
                                size_t inLen,
                                size_t *outLen) const;
 
                                size_t inLen,
                                size_t *outLen) const;
 

+    /**
+        Converts a char buffer to wide char one.
+
+        This is the most convenient and safest conversion function as you
+        don't have to deal with the buffer lengths directly. Use it if the
+        input buffer is known not to be empty or if you are sure that the
+        conversion is going to succeed -- otherwise, use the overload above to
+        be able to distinguish between empty input and conversion failure.
+
+        @return
+            The buffer containing the converted text, empty if the input was
+            empty or if the conversion failed.
+
+        @since 2.9.1
+     */
+    const wxWCharBuffer cMB2WC(const wxCharBuffer& buf) const;
+

     //@{
     /**
         Converts from multibyte encoding to the current wxChar type (which
     //@{
     /**
         Converts from multibyte encoding to the current wxChar type (which


@@ -204,6 +221,23 @@ public:
                               size_t inLen,
                               size_t *outLen) const;
 
                               size_t inLen,
                               size_t *outLen) const;
 

+    /**
+        Converts a wide char buffer to char one.
+
+        This is the most convenient and safest conversion function as you
+        don't have to deal with the buffer lengths directly. Use it if the
+        input buffer is known not to be empty or if you are sure that the
+        conversion is going to succeed -- otherwise, use the overload above to
+        be able to distinguish between empty input and conversion failure.
+
+        @return
+            The buffer containing the converted text, empty if the input was
+            empty or if the conversion failed.
+
+        @since 2.9.1
+     */
+    const wxCharBuffer cWC2MB(const wxWCharBuffer& buf) const;
+

     //@{
     /**
         Converts from Unicode to the current wxChar type.
     //@{
     /**
         Converts from Unicode to the current wxChar type.


@@ -243,7 +277,7 @@ public:
     /**
         @deprecated This function is deprecated, please use ToWChar() instead.
 
     /**
         @deprecated This function is deprecated, please use ToWChar() instead.
 

-        Converts from a string @a in in multibyte encoding to Unicode putting up to
+        Converts from a string @a in multibyte encoding to Unicode putting up to

         @a outLen characters into the buffer @e out.
 
         If @a out is @NULL, only the length of the string which would result
         @a outLen characters into the buffer @e out.
 
         If @a out is @NULL, only the length of the string which would result


@@ -448,22 +482,19 @@ public:
 
 
 /**
 
 
 /**

-    @class wxMBConvFile
-
-    This class used to define the class instance @b wxConvFileName, but
-    nowadays @b wxConvFileName is either of type wxConvLibc (on most platforms)
-    or wxConvUTF8 (on MacOS X).
+    Conversion object used for converting file names from their external
+    representation to the one used inside the program.

 
     @b wxConvFileName converts filenames between filesystem multibyte encoding
     and Unicode. @b wxConvFileName can also be set to a something else at
 
     @b wxConvFileName converts filenames between filesystem multibyte encoding
     and Unicode. @b wxConvFileName can also be set to a something else at

-    run-time which is used e.g. by wxGTK to use a class which checks the
+    run-time which is used e.g. by wxGTK to use an object which checks the

     environment variable @b G_FILESYSTEM_ENCODING indicating that filenames
     should not be interpreted as UTF8 and also for converting invalid UTF8
     characters (e.g. if there is a filename in iso8859_1) to strings with octal
     values.
 
     Since some platforms (such as Win32) use Unicode in the filenames,
     environment variable @b G_FILESYSTEM_ENCODING indicating that filenames
     should not be interpreted as UTF8 and also for converting invalid UTF8
     characters (e.g. if there is a filename in iso8859_1) to strings with octal
     values.
 
     Since some platforms (such as Win32) use Unicode in the filenames,

-    and others (such as Unix) use multibyte encodings, this class should only
+    and others (such as Unix) use multibyte encodings, this object should only

     be used directly if wxMBFILES is defined to 1. A convenience macro,
     @c wxFNCONV, is defined to @c wxConvFileName->cWX2MB in this case. You
     could use it like this:
     be used directly if wxMBFILES is defined to 1. A convenience macro,
     @c wxFNCONV, is defined to @c wxConvFileName->cWX2MB in this case. You
     could use it like this:


@@ -474,7 +505,7 @@ public:
     @endcode
 
     (although it would be better to just use wxFopen(name, "r") in this
     @endcode
 
     (although it would be better to just use wxFopen(name, "r") in this

-    particular case, you only need to use this class for functions taking file
+    particular case, you only need to use this object for functions taking file

     names not wrapped by wxWidgets.)
 
     @library{wxbase}
     names not wrapped by wxWidgets.)
 
     @library{wxbase}


@@ -482,7 +513,4 @@ public:
 
     @see @ref overview_mbconv
 */
 
     @see @ref overview_mbconv
 */

-class wxMBConvFile : public wxMBConv
-{
-public:
-};
+extern wxMBConv* wxConvFileName;