adding default interpolation enum

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

diff --git a/interface/wx/strconv.h b/interface/wx/strconv.h
index eb4bafedb3ed2f8a91f2a1dfbe634a047f1cf736..c5384a8e43f0b7a9f88866521981a5b1d3808986 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

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


@@ -67,7 +67,7 @@ public:
         This method can be used to allocate the buffer with enough space for the
         trailing @c NUL characters for any encoding.
     */
         This method can be used to allocate the buffer with enough space for the
         trailing @c NUL characters for any encoding.
     */

-    const size_t GetMaxMBNulLen();
+    static size_t GetMaxMBNulLen();

 
     /**
         Convert multibyte string to a wide character one.
 
     /**
         Convert multibyte string to a wide character one.


@@ -125,8 +125,7 @@ public:
             The number of character written (or which would have been written
             if it were non-@NULL) to @a dst or @c wxCONV_FAILED on error.
     */
             The number of character written (or which would have been written
             if it were non-@NULL) to @a dst or @c wxCONV_FAILED on error.
     */

-    virtual size_t ToWChar(wchar_t* dst, size_t dstLen,
-                           const char* src,
+    virtual size_t ToWChar(wchar_t* dst, size_t dstLen, const char* src,

                            size_t srcLen = wxNO_LEN) const;
 
     /**
                            size_t srcLen = wxNO_LEN) const;
 
     /**


@@ -153,8 +152,7 @@ public:
             The number of character written (or which would have been written
             if it were non-@NULL) to @a dst or @c wxCONV_FAILED on error.
     */
             The number of character written (or which would have been written
             if it were non-@NULL) to @a dst or @c wxCONV_FAILED on error.
     */

-    virtual size_t FromWChar(char* dst, size_t dstLen,
-                             const wchar_t* src,
+    virtual size_t FromWChar(char* dst, size_t dstLen, const wchar_t* src,

                              size_t srcLen = wxNO_LEN) const;
 
     /**
                              size_t srcLen = wxNO_LEN) const;
 
     /**


@@ -176,8 +174,25 @@ public:
         compatibility concerns).
     */
     const wxWCharBuffer cMB2WC(const char* in,
         compatibility concerns).
     */
     const wxWCharBuffer cMB2WC(const char* in,

-                               size_t inLen = wxNO_LEN,
-                               size_t *outLen = NULL) 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;

 
     //@{
     /**
 
     //@{
     /**


@@ -203,8 +218,25 @@ public:
         FromWChar(), please see the description of cMB2WC() for more details.
     */
     const wxCharBuffer cWC2MB(const wchar_t* in,
         FromWChar(), please see the description of cMB2WC() for more details.
     */
     const wxCharBuffer cWC2MB(const wchar_t* in,

-                              size_t inLen = wxNO_LEN,
-                              size_t *outLen = NULL) 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;

 
     //@{
     /**
 
     //@{
     /**


@@ -245,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


@@ -471,7 +503,7 @@ public:
     could use it like this:
 
     @code
     could use it like this:
 
     @code

-    wxChar *name = wxT("rawfile.doc");
+    wxChar *name = "rawfile.doc";

     FILE *fil = fopen(wxFNCONV(name), "r");
     @endcode
 
     FILE *fil = fopen(wxFNCONV(name), "r");
     @endcode