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