docs/latex/wx/mbconv.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % ../include/wx/strconv.h at 25/Mar/00 10:20:56
   4 %
   5
   6 \section{\class{wxMBConv}}\label{wxmbconv}
   7
   8 This class is the base class of a hierarchy of classes capable of converting
   9 text strings between multibyte (SBCS or DBCS) encodings and Unicode. It is itself
  10 a wrapper around the standard libc mbstowcs() and wcstombs() routines, and has
  11 one predefined instance, {\bf wxConvLibc}.
  12
  13 \wxheading{Derived from}
  14
  15 No base class
  16
  17 \wxheading{Include files}
  18
  19 <wx/strconv.h>
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxCSConv}{wxcsconv},
  24 \helpref{wxEncodingConverter}{wxencodingconverter},
  25 \helpref{wxMBConv classes overview}{mbconvclasses}
  26
  27 \latexignore{\rtfignore{\wxheading{Members}}}
  28
  29
  30 \membersection{wxMBConv::wxMBConv}\label{wxmbconvwxmbconv}
  31
  32 \func{}{wxMBConv}{\void}
  33
  34 Constructor.
  35
  36 \membersection{wxMBConv::MB2WC}\label{wxmbconvmb2wc}
  37
  38 \constfunc{virtual size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
  39
  40 Converts from multibyte encoding to Unicode, using the libc routine mbstowcs()
  41 (this is overridden by derived classes). Returns the size of the destination buffer.
  42
  43 \membersection{wxMBConv::WC2MB}\label{wxmbconvwc2mb}
  44
  45 \constfunc{virtual size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
  46
  47 Converts from Unicode to multibyte encoding, using the libc routine wcstombs()
  48 (this is overridden by derived classes). Returns the size of the destination buffer.
  49
  50 \membersection{wxMBConv::cMB2WC}\label{wxmbconvcmb2wc}
  51
  52 \constfunc{const wxWCharBuffer}{cMB2WC}{\param{const char* }{psz}}
  53
  54 Converts from multibyte encoding to Unicode by calling MB2WC,
  55 allocating a temporary wxWCharBuffer to hold the result.
  56
  57 \membersection{wxMBConv::cWC2MB}\label{wxmbconvcwc2mb}
  58
  59 \constfunc{const wxCharBuffer}{cWC2MB}{\param{const wchar\_t* }{psz}}
  60
  61 Converts from Unicode to multibyte encoding by calling WC2MB,
  62 allocating a temporary wxCharBuffer to hold the result.
  63
  64 \membersection{wxMBConv::cMB2WX}\label{wxmbconvcmb2wx}
  65
  66 \constfunc{const char*}{cMB2WX}{\param{const char* }{psz}}
  67
  68 \constfunc{const wxWCharBuffer}{cMB2WX}{\param{const char* }{psz}}
  69
  70 Converts from multibyte encoding to the current wxChar type
  71 (which depends on whether wxUSE\_UNICODE is set to 1). If wxChar is char,
  72 it returns the parameter unaltered. If wxChar is wchar\_t, it returns the
  73 result in a wxWCharBuffer. The macro wxMB2WXbuf is defined as the correct
  74 return type (without const).
  75
  76 \membersection{wxMBConv::cWX2MB}\label{wxmbconvcwx2mb}
  77
  78 \constfunc{const char*}{cWX2MB}{\param{const wxChar* }{psz}}
  79
  80 \constfunc{const wxCharBuffer}{cWX2MB}{\param{const wxChar* }{psz}}
  81
  82 Converts from the current wxChar type to multibyte encoding. If wxChar is char,
  83 it returns the parameter unaltered. If wxChar is wchar\_t, it returns the
  84 result in a wxCharBuffer. The macro wxWX2MBbuf is defined as the correct
  85 return type (without const).
  86
  87 \membersection{wxMBConv::cWC2WX}\label{wxmbconvcwc2wx}
  88
  89 \constfunc{const wchar\_t*}{cWC2WX}{\param{const wchar\_t* }{psz}}
  90
  91 \constfunc{const wxCharBuffer}{cWC2WX}{\param{const wchar\_t* }{psz}}
  92
  93 Converts from Unicode to the current wxChar type. If wxChar is wchar\_t,
  94 it returns the parameter unaltered. If wxChar is char, it returns the
  95 result in a wxCharBuffer. The macro wxWC2WXbuf is defined as the correct
  96 return type (without const).
  97
  98 \membersection{wxMBConv::cWX2WC}\label{wxmbconvcwx2wc}
  99
 100 \constfunc{const wchar\_t*}{cWX2WC}{\param{const wxChar* }{psz}}
 101
 102 \constfunc{const wxWCharBuffer}{cWX2WC}{\param{const wxChar* }{psz}}
 103
 104 Converts from the current wxChar type to Unicode. If wxChar is wchar\_t,
 105 it returns the parameter unaltered. If wxChar is char, it returns the
 106 result in a wxWCharBuffer. The macro wxWX2WCbuf is defined as the correct
 107 return type (without const).
 108