X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..75d9e502238df95fa53c0030b1fac0d4f43e4025:/docs/latex/wx/csconv.tex diff --git a/docs/latex/wx/csconv.tex b/docs/latex/wx/csconv.tex index 2d09197bf2..42e503e75a 100644 --- a/docs/latex/wx/csconv.tex +++ b/docs/latex/wx/csconv.tex @@ -29,32 +29,43 @@ default user character set. \func{}{wxCSConv}{\param{const wxChar* }{charset}} -Constructor. Specify the name of the character set you want to convert -from/to. +\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. +Destructor frees any resources needed to perform the conversion. + + +\membersection{wxCSConv::IsOk}\label{wxcsconvisok} -\membersection{wxCSConv::LoadNow}\label{wxcsconvloadnow} +\constfunc{bool}{IsOk}{\void} -\func{void}{LoadNow}{\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} -If the conversion tables needs to be loaded from disk, this method -will do so. Otherwise, they will be loaded when any of the conversion -methods are called. \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 the size of the destination buffer. +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 the size of the destination buffer. +Converts from Unicode to the selected character set. Returns length of string written to destination buffer.