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 //@{
  10 /**
  11     wxT() is a macro which can be used with character and string literals (in other
  12     words, @c 'x' or @c "foo") to automatically convert them to Unicode in
  13     Unicode build configuration. Please see the
  14     @ref overview_unicode "Unicode overview" for more information.
  15     This macro is simply returns the value passed to it without changes in ASCII
  16     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 wxChar wxT(char ch);
  27 const wxChar* wxT(const char* s);
  28 //@}
  29
  30
  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 is a
  37     mismatch between the kind of the literal used and wxStringCharType used in the
  38     current build, but using it can be beneficial in performance-sensitive code to
  39     do the conversion at compile-time instead.
  40
  41     @see wxT()
  42 */
  43 wxStringCharType wxS(char ch);
  44 const wxStringCharType* wxS(const char* s);
  45 //@}
  46