]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/csconv.tex
minor corrections and note about Unicode (patch 1555691)
[wxWidgets.git] / docs / latex / wx / csconv.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{wxCSConv}}\label{wxcsconv}
7
8 This class converts between any character sets and Unicode.
9 It has one predefined instance, {\bf wxConvLocal}, for the
10 default user character set.
11
12 \wxheading{Derived from}
13
14 \helpref{wxMBConv}{wxmbconv}
15
16 \wxheading{Include files}
17
18 <wx/strconv.h>
19
20 \wxheading{See also}
21
22 \helpref{wxMBConv}{wxmbconv},
23 \helpref{wxEncodingConverter}{wxencodingconverter},
24 \helpref{wxMBConv classes overview}{mbconvclasses}
25
26 \latexignore{\rtfignore{\wxheading{Members}}}
27
28 \membersection{wxCSConv::wxCSConv}\label{wxcsconvwxcsconv}
29
30 \func{}{wxCSConv}{\param{const wxChar* }{charset}}
31
32 \func{}{wxCSConv}{\param{wxFontEncoding }{encoding}}
33
34 Constructor. You may specify either the name of the character set you want to
35 convert from/to or an encoding constant. If the character set name is not
36 recognized, ISO 8859-1 is used as fall back.
37
38
39 \membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor}
40
41 \func{}{\destruct{wxCSConv}}{\void}
42
43 Destructor frees any resources needed to perform the conversion.
44
45
46 \membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc}
47
48 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
49
50 Converts from the selected character set to Unicode. Returns length of string written to destination buffer.
51
52 \membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb}
53
54 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
55
56 Converts from Unicode to the selected character set. Returns length of string written to destination buffer.
57