]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/mbcnvut8.tex
Added missing include
[wxWidgets.git] / docs / latex / wx / mbcnvut8.tex
... / ...
CommitLineData
1%
2% automatically generated by HelpGen from
3% ../include/wx/strconv.h at 25/Mar/00 10:20:56
4%
5
6\section{\class{wxMBConvUTF8}}\label{wxmbconvutf8}
7
8This class converts between the UTF-8 encoding and Unicode.
9It has one predefined instance, {\bf wxConvUTF8}.
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{wxMBConvUTF7}{wxmbconvutf7},
22\helpref{wxMBConv classes overview}{mbconvclasses}
23
24\wxheading{Remarks}
25
26UTF-8 is a compatibility encoding used to encode Unicode text into anything that was
27originally written for 8-bit strings, including (but not limited to) filenames, transfer
28protocols, and database fields. Notable properties include:
29
30\begin{itemize}
31\item Variable-length encoding able to encode up to 31 bits per character
32\item ASCII characters (character values under 128) are encoded as plain ASCII
33(1 byte per character)
34\item Null bytes do not occur in the encoding, except when there's an actual Unicode
35null character
36\item Preserves sort ordering for plain 8-bit comparison routines like strcmp()
37\item High bit patterns disambiguates character boundaries, and makes it easy to
38detect whether a string is encoded with UTF-8 or not
39\end{itemize}
40
41All of these properties make UTF-8 a very favorable solution in any situation
42where full Unicode character support is desired while remaining compatible with
43code written with only 8-bit extended-ASCII characters in mind.
44
45\latexignore{\rtfignore{\wxheading{Members}}}
46
47
48\membersection{wxMBConvUTF8::MB2WC}\label{wxmbconvutf8mb2wc}
49
50\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
51
52Converts from UTF-8 encoding to Unicode. Returns the size of the destination buffer.
53
54\membersection{wxMBConvUTF8::WC2MB}\label{wxmbconvutf8wc2mb}
55
56\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
57
58Converts from Unicode to UTF-8 encoding. Returns the size of the destination buffer.
59