docs/latex/wx/mbcnvutf.tex

   1 \section{\class{wxMBConvUTF16}}\label{wxmbconvutf16}
   2
   3 This class is used to convert between multibyte encodings and UTF-16 Unicode
   4 encoding (also known as UCS-2). Unlike \helpref{UTF-8}{wxmbconvutf8} encoding,
   5 UTF-16 uses words and not bytes and hence depends on the byte ordering:
   6 big or little endian. Hence this class is provided in two versions:
   7 wxMBConvUTF16LE and wxMBConvUTF16BE and wxMBConvUTF16 itself is just a typedef
   8 for one of them (native for the given platform, e.g. LE under Windows and BE
   9 under Mac).
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxMBConv}{wxmbconv}
  14
  15 \wxheading{Include files}
  16
  17 <wx/strconv.h>
  18
  19 \wxheading{Library}
  20
  21 \helpref{wxBase}{librarieslist}
  22
  23 \wxheading{See also}
  24
  25 \helpref{wxMBConvUTF8}{wxmbconvutf8},
  26 \helpref{wxMBConvUTF32}{wxmbconvutf32},
  27 \helpref{wxMBConv classes overview}{mbconvclasses}
  28
  29 \latexignore{\rtfignore{\wxheading{Members}}}
  30
  31 \membersection{wxMBConvUTF16::MB2WC}\label{wxmbconvutf16mb2wc}
  32
  33 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
  34
  35 Converts from UTF-16 encoding to Unicode. Returns the size of the destination
  36 buffer.
  37
  38 \membersection{wxMBConvUTF16::WC2MB}\label{wxmbconvutf16wc2mb}
  39
  40 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
  41
  42 Converts from Unicode to UTF-16 encoding. Returns the size of the destination
  43 buffer.
  44
  45
  46 \section{\class{wxMBConvUTF32}}\label{wxmbconvutf32}
  47
  48 This class is used to convert between multibyte encodings and UTF-32 Unicode
  49 encoding (also known as UCS-4). Unlike \helpref{UTF-8}{wxmbconvutf8} encoding,
  50 UTF-32 uses (double) words and not bytes and hence depends on the byte ordering:
  51 big or little endian. Hence this class is provided in two versions:
  52 wxMBConvUTF32LE and wxMBConvUTF32BE and wxMBConvUTF32 itself is just a typedef
  53 for one of them (native for the given platform, e.g. LE under Windows and BE
  54 under Mac).
  55
  56 \wxheading{Derived from}
  57
  58 \helpref{wxMBConv}{wxmbconv}
  59
  60 \wxheading{Include files}
  61
  62 <wx/strconv.h>
  63
  64 \wxheading{Library}
  65
  66 \helpref{wxBase}{librarieslist}
  67
  68 \wxheading{See also}
  69
  70 \helpref{wxMBConvUTF8}{wxmbconvutf8},
  71 \helpref{wxMBConvUTF16}{wxmbconvutf16},
  72 \helpref{wxMBConv classes overview}{mbconvclasses}
  73
  74 \latexignore{\rtfignore{\wxheading{Members}}}
  75
  76 \membersection{wxMBConvUTF32::MB2WC}\label{wxmbconvutf32mb2wc}
  77
  78 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
  79
  80 Converts from UTF-32 encoding to Unicode. Returns the size of the destination
  81 buffer.
  82
  83 \membersection{wxMBConvUTF32::WC2MB}\label{wxmbconvutf32wc2mb}
  84
  85 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
  86
  87 Converts from Unicode to UTF-32 encoding. Returns the size of the destination
  88 buffer.
  89