X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6ac7ddd334c30a051ecd1d36132a35498f997d20..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/chartype.h

diff --git a/interface/wx/chartype.h b/interface/wx/chartype.h
index 59c51e8232..b66f25b00d 100644
--- a/interface/wx/chartype.h
+++ b/interface/wx/chartype.h
@@ -2,8 +2,7 @@
 // Name:        chartype.h
 // Purpose:     interface of global functions
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /** @addtogroup group_funcmacro_string */
@@ -33,9 +32,38 @@
 #define wxT(string)
 
 /**
-    wxS is macro which can be used with character and string literals (in other words,
-    @c 'x' or @c "foo") to either convert them to wide characters or wide strings
-    in @c wchar_t-based (UTF-16) builds or keep them unchanged in @c char-based
+    Compatibility macro which expands to wxT() in wxWidgets 2 only.
+
+    This macro can be used in code which needs to compile with both
+    wxWidgets 2 and 3 versions, in places where the wx2 API requires a Unicode string
+    (in Unicode build) but the wx3 API only accepts a standard narrow
+    string, as in e.g. wxCmdLineEntryDesc structure objects initializers.
+
+    Example of use:
+    @code
+    const wxCmdLineEntryDesc cmdLineDesc[] =
+    {
+        { wxCMD_LINE_SWITCH, wxT_2("q"), wxT_2("quiet"),
+          wxT_2("Don't output verbose messages") },
+        wxCMD_LINE_DESC_END
+    };
+    @endcode
+
+    Without @c wxT_2 the code above wouldn't compile with wxWidgets 2, but using @c
+    wxT instead, it wouldn't compile with wxWidgets 3.
+
+    @see wxT()
+
+    @since 2.8.12, 2.9.2
+
+    @header{wx/chartype.h}
+ */
+#define wxT_2(string)
+
+/**
+    wxS is a macro which can be used with character and string literals (in other words,
+    @c 'x' or @c "foo") to convert them either to wide characters or wide strings
+    in @c wchar_t-based (UTF-16) builds, or to keep them unchanged in @c char-based
     (UTF-8) builds.
 
     Basically this macro produces characters or strings of type wxStringCharType.
@@ -60,7 +88,10 @@
 
     Don't confuse this macro with _()!
 
-    Note that since wxWidgets 2.9.0 the use of _T() is discouraged just like for wxT().
+    Note that since wxWidgets 2.9.0 the use of _T() is discouraged just like
+    for wxT() and also that this macro may conflict with identifiers defined in
+    standard headers of some compilers (such as Sun CC) so its use should
+    really be avoided.
 
     @header{wx/chartype.h}
 */
@@ -68,30 +99,30 @@
 
 /**
     wxChar is defined to be
-    - @c char when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- @c char when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxChar;
 
 /**
     wxSChar is defined to be
-    - <tt>signed char</tt> when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- <tt>signed char</tt> when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxSChar;
 
 /**
     wxUChar is defined to be
-    - <tt>unsigned char</tt> when <tt>wxUSE_UNICODE==0</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
+    \- <tt>unsigned char</tt> when <tt>wxUSE_UNICODE==0</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE==1</tt> (the default).
 */
 typedef wxUSE_UNICODE_dependent wxUChar;
 
 /**
     wxStringCharType is defined to be:
-    - @c char when <tt>wxUSE_UNICODE==0</tt>
-    - @c char when <tt>wxUSE_UNICODE_WCHAR==0</tt> and <tt>wxUSE_UNICODE==1</tt>
-    - @c wchar_t when <tt>wxUSE_UNICODE_WCHAR==1</tt> and <tt>wxUSE_UNICODE==1</tt>
+    \- @c char when <tt>wxUSE_UNICODE==0</tt>
+    \- @c char when <tt>wxUSE_UNICODE_WCHAR==0</tt> and <tt>wxUSE_UNICODE==1</tt>
+    \- @c wchar_t when <tt>wxUSE_UNICODE_WCHAR==1</tt> and <tt>wxUSE_UNICODE==1</tt>
 
     The @c wxUSE_UNICODE_WCHAR symbol is defined to @c 1 when building on
     Windows while it's defined to @c 0 when building on Unix, Linux or OS X.