]> git.saurik.com Git - wxWidgets.git/blob - interface/chartype.h
replace @b Note with @note; replace '' with "
[wxWidgets.git] / interface / chartype.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: chartype.h
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /** @ingroup group_funcmacro_string */
10 //@{
11
12 /**
13 This macro can be used with character and string literals (in other words,
14 @c 'x' or @c "foo") to automatically convert them to Unicode in Unicode
15 builds of wxWidgets. This macro is simply returns the value passed to it
16 without changes in ASCII build. In fact, its definition is:
17
18 @code
19 #ifdef UNICODE
20 # define wxT(x) L ## x
21 #else // !Unicode
22 # define wxT(x) x
23 #endif
24 @endcode
25
26 @see @ref overview_unicode
27
28 @header{wx/chartype.h}
29 */
30 #define wxT(string)
31
32 /**
33 wxS is macro which can be used with character and string literals to either
34 convert them to wide characters or strings in @c wchar_t-based Unicode
35 builds or keep them unchanged in UTF-8 builds. The use of this macro is
36 optional as the translation will always be done at run-time even if there
37 is a mismatch between the kind of the literal used and string or character
38 type used in the current build, but using it can be beneficial in
39 performance-sensitive code to do the conversion at compile-time instead.
40
41 @see wxT()
42
43 @header{wx/chartype.h}
44 */
45 #define wxS(string)
46
47 /**
48 This macro is exactly the same as wxT() and is defined in wxWidgets simply
49 because it may be more intuitive for Windows programmers as the standard
50 Win32 headers also define it (as well as yet another name for the same
51 macro which is _TEXT()).
52
53 Don't confuse this macro with _()!
54
55 @header{wx/chartype.h}
56 */
57 #define _T(string)
58
59 //@}