X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..c00fed0ef4d70c9b45d9b8405f636d30eadb7ea6:/docs/latex/wx/encconv.tex?ds=inline diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex index d9db707ce0..f24df2dd1e 100644 --- a/docs/latex/wx/encconv.tex +++ b/docs/latex/wx/encconv.tex @@ -7,8 +7,8 @@ This class is capable of converting strings between two 8-bit encodings/charsets. It can also convert from/to Unicode (but only -if you compiled wxWidgets with wxUSE\_WCHAR\_T set to 1). Only limited subset -of encodings in supported by wxEncodingConverter: +if you compiled wxWidgets with wxUSE\_WCHAR\_T set to 1). Only a limited subset +of encodings is supported by wxEncodingConverter: {\tt wxFONTENCODING\_ISO8859\_1..15}, {\tt wxFONTENCODING\_CP1250..1257} and {\tt wxFONTENCODING\_KOI8}. @@ -82,10 +82,10 @@ or output encoding is not supported.) \membersection{wxEncodingConverter::CanConvert}\label{wxencodingconvertercanconvert} -\func{static bool}{CanConvert}{\param{wxFontEncoding}{encIn}, \param{wxFontEncoding }{encOut}} +\func{static bool}{CanConvert}{\param{wxFontEncoding }{encIn}, \param{wxFontEncoding }{encOut}} Return true if (any text in) multibyte encoding \arg{encIn} can be converted to -another one (\it{encOut}) losslessly. +another one ({\it encOut}) losslessly. Do not call this method with \texttt{wxFONTENCODING\_UNICODE} as either parameter, it doesn't make sense (always works in one sense and always depends @@ -94,25 +94,31 @@ on the text to convert in the other). \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert} -\constfunc{void}{Convert}{\param{const char* }{input}, \param{char* }{output}} +\constfunc{bool}{Convert}{\param{const char* }{input}, \param{char* }{output}} -\constfunc{void}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}} +\constfunc{bool}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}} -\constfunc{void}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}} +\constfunc{bool}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}} -\constfunc{void}{Convert}{\param{const wchar\_t* }{input}, \param{char* }{output}} +\constfunc{bool}{Convert}{\param{const wchar\_t* }{input}, \param{char* }{output}} Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit} and writes the result to {\it output}. -\constfunc{void}{Convert}{\param{char* }{str}} +\constfunc{bool}{Convert}{\param{char* }{str}} -\constfunc{void}{Convert}{\param{wchar\_t* }{str}} +\constfunc{bool}{Convert}{\param{wchar\_t* }{str}} Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit} in-place, i.e. write the result to the same memory area. +All of the versions above return \true if the conversion was lossless and +\false if at least one of the characters couldn't be converted and was replaced +with {\tt '?'} in the output. Note that if {\tt wxCONVERT\_SUBSTITUTE} was +passed to \helpref{Init}{wxencodingconverterinit}, substitution is considered +lossless operation. + \constfunc{wxString}{Convert}{\param{const wxString\& }{input}} Convert wxString and return new wxString object.