Macros | |
#define | wxT(string) |
This macro can be used with character and string literals (in other words, 'x' or "foo" ) to automatically convert them to wide strings in Unicode builds of wxWidgets. | |
#define | wxT_2(string) |
Compatibility macro which expands to wxT() in wxWidgets 2 only. | |
#define | wxS(string) |
wxS is a macro which can be used with character and string literals (in other words, 'x' or "foo" ) to convert them either to wide characters or wide strings in wchar_t-based (UTF-16) builds, or to keep them unchanged in char-based (UTF-8) builds. | |
#define | _T(string) |
This macro is exactly the same as wxT() and is defined in wxWidgets simply because it may be more intuitive for Windows programmers as the standard Win32 headers also define it (as well as yet another name for the same macro which is _TEXT()). | |
Typedefs | |
typedef wxUSE_UNICODE_dependent | wxChar |
wxChar is defined to be - char when wxUSE_UNICODE==0 - wchar_t when wxUSE_UNICODE==1 (the default). | |
typedef wxUSE_UNICODE_dependent | wxSChar |
wxSChar is defined to be - signed char when wxUSE_UNICODE==0 - wchar_t when wxUSE_UNICODE==1 (the default). | |
typedef wxUSE_UNICODE_dependent | wxUChar |
wxUChar is defined to be - unsigned char when wxUSE_UNICODE==0 - wchar_t when wxUSE_UNICODE==1 (the default). | |
typedef wxUSE_UNICODE_WCHAR_dependent | wxStringCharType |
wxStringCharType is defined to be: - char when wxUSE_UNICODE==0 - char when wxUSE_UNICODE_WCHAR==0 and wxUSE_UNICODE==1 - wchar_t when wxUSE_UNICODE_WCHAR==1 and wxUSE_UNICODE==1 | |
#define _T | ( | string | ) |
This macro is exactly the same as wxT() and is defined in wxWidgets simply because it may be more intuitive for Windows programmers as the standard Win32 headers also define it (as well as yet another name for the same macro which is _TEXT()).
Don't confuse this macro with _()!
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.
Include file:
#include <wx/chartype.h>
#define wxS | ( | string | ) |
wxS is a macro which can be used with character and string literals (in other words, 'x'
or "foo"
) to convert them either to wide characters or wide strings in wchar_t-based
(UTF-16) builds, or to keep them unchanged in char-based
(UTF-8) builds.
Basically this macro produces characters or strings of type wxStringCharType.
The use of this macro is optional as the translation will always be done at run-time even if there is a mismatch between the kind of the literal used and the string or character type used in the current build. However using it can be beneficial in performance-sensitive code to do the conversion at compile-time instead.
Include file:
#include <wx/chartype.h>
#define wxT | ( | string | ) |
This macro can be used with character and string literals (in other words, 'x'
or "foo"
) to automatically convert them to wide strings in Unicode builds of wxWidgets.
This macro simply returns the value passed to it without changes in ASCII build. In fact, its definition is:
Note that since wxWidgets 2.9.0 you shouldn't use wxT() anymore in your program sources (it was previously required if you wanted to support Unicode).
Include file:
#include <wx/chartype.h>
#define wxT_2 | ( | string | ) |
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:
Without wxT_2
the code above wouldn't compile with wxWidgets 2, but using wxT
instead, it wouldn't compile with wxWidgets 3.
Include file:
#include <wx/chartype.h>
typedef wxUSE_UNICODE_dependent wxChar |
wxChar is defined to be - char
when wxUSE_UNICODE==0
- wchar_t
when wxUSE_UNICODE==1
(the default).
typedef wxUSE_UNICODE_dependent wxSChar |
wxSChar is defined to be - signed char
when wxUSE_UNICODE==0
- wchar_t
when wxUSE_UNICODE==1
(the default).
typedef wxUSE_UNICODE_WCHAR_dependent wxStringCharType |
wxStringCharType is defined to be: - char
when wxUSE_UNICODE==0
- char
when wxUSE_UNICODE_WCHAR==0
and wxUSE_UNICODE==1
- wchar_t
when wxUSE_UNICODE_WCHAR==1
and wxUSE_UNICODE==1
The wxUSE_UNICODE_WCHAR
symbol is defined to 1
when building on Windows while it's defined to 0
when building on Unix, Linux or OS X. (Note that wxUSE_UNICODE_UTF8
symbol is defined as the opposite of wxUSE_UNICODE_WCHAR
.)
Note that wxStringCharType (as the name says) is the type used by wxString for internal storage of the characters.
typedef wxUSE_UNICODE_dependent wxUChar |
wxUChar is defined to be - unsigned char
when wxUSE_UNICODE==0
- wchar_t
when wxUSE_UNICODE==1
(the default).