[wxWidgets.git] / docs / latex / wx / csconv.tex

%
% automatically generated by HelpGen from
% ../include/wx/strconv.h at 25/Mar/00 10:20:56
%

\section{\class{wxCSConv}}\label{wxcsconv}

This class converts between any character sets and Unicode.
It has one predefined instance, {\bf wxConvLocal}, for the
default user character set.

\wxheading{Derived from}

\helpref{wxMBConv}{wxmbconv}

\wxheading{Include files}

<wx/strconv.h>

\wxheading{See also}

\helpref{wxMBConv}{wxmbconv}, 
\helpref{wxEncodingConverter}{wxencodingconverter}, 
\helpref{wxMBConv classes overview}{mbconvclasses}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxCSConv::wxCSConv}\label{wxcsconvwxcsconv}

\func{}{wxCSConv}{\param{const wxChar* }{charset}}

\func{}{wxCSConv}{\param{wxFontEncoding }{encoding}}

Constructor. You may specify either the name of the character set you want to
convert from/to or an encoding constant. If the character set name (or the
encoding) is not recognized, ISO 8859-1 is used as fall back.


\membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor}

\func{}{\destruct{wxCSConv}}{\void}

Destructor frees any resources needed to perform the conversion.


\membersection{wxCSConv::IsOk}\label{wxcsconvisok}

\constfunc{bool}{IsOk}{\void}

Returns \true if the charset (or the encoding) given at constructor is really
available to use. Returns \false if ISO 8859-1 will be used instead.

Note this does \emph{not} mean that a given string will be correctly converted.
A malformed string may still make conversion functions return \texttt{wxCONV\_FAILED}.

\newsince{2.8.2}


\membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc}

\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}

Converts from the selected character set to Unicode. Returns length of string written to destination buffer.


\membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb}

\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}

Converts from Unicode to the selected character set. Returns length of string written to destination buffer.
Commit	Line	Data
f6bcfd97 BP	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
f70c0443	32	\func{}{wxCSConv}{\param{wxFontEncoding }{encoding}}
f6bcfd97	33
116b407e	34	Constructor. You may specify either the name of the character set you want to
0f0298b1 VZ	35	convert from/to or an encoding constant. If the character set name (or the
0f0298b1 VZ	36	encoding) is not recognized, ISO 8859-1 is used as fall back.
f6bcfd97	37
f6bcfd97	38
116b407e	39	\membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor}
f6bcfd97	40
116b407e	41	\func{}{\destruct{wxCSConv}}{\void}
f6bcfd97	42
116b407e	43	Destructor frees any resources needed to perform the conversion.
f6bcfd97	44
f6bcfd97	45
0f0298b1 VZ	46	\membersection{wxCSConv::IsOk}\label{wxcsconvisok}
	47
	48	\constfunc{bool}{IsOk}{\void}
	49
	50	Returns \true if the charset (or the encoding) given at constructor is really
	51	available to use. Returns \false if ISO 8859-1 will be used instead.
	52
	53	Note this does \emph{not} mean that a given string will be correctly converted.
	54	A malformed string may still make conversion functions return \texttt{wxCONV\_FAILED}.
	55
	56	\newsince{2.8.2}
	57
	58
f6bcfd97 BP	59	\membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc}
	60
	61	\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
	62
f70c0443	63	Converts from the selected character set to Unicode. Returns length of string written to destination buffer.
116b407e	64
0f0298b1	65
f6bcfd97 BP	66	\membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb}
	67
	68	\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
	69
f70c0443	70	Converts from Unicode to the selected character set. Returns length of string written to destination buffer.
058a62b1	71