X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..b13cd66e42c77e1c71585e67eeab6560b38178b3:/docs/latex/wx/encconv.tex diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex index 4fd8bf44e6..39e14fbfd9 100644 --- a/docs/latex/wx/encconv.tex +++ b/docs/latex/wx/encconv.tex @@ -7,7 +7,7 @@ This class is capable of converting strings between any two 8-bit encodings/charsets. It can also convert from/to Unicode (but only -if you compiled wxWindows with wxUSE\_UNICODE set to 1). +if you compiled wxWindows with wxUSE\_WCHAR\_T set to 1). \wxheading{Derived from} @@ -17,6 +17,13 @@ if you compiled wxWindows with wxUSE\_UNICODE set to 1). +\wxheading{See also} + +\helpref{wxFontMapper}{wxfontmapper}, +\helpref{wxMBConv}{wxmbconv}, +\helpref{Writing non-English applications}{nonenglishoverview} + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter} @@ -29,7 +36,7 @@ Constructor. \func{bool}{Init}{\param{wxFontEncoding }{input\_enc}, \param{wxFontEncoding }{output\_enc}, \param{int }{method = wxCONVERT\_STRICT}} -Initialize convertion. Both output or input encoding may +Initialize conversion. Both output or input encoding may be wxFONTENCODING\_UNICODE, but only if wxUSE\_ENCODING is set to 1. All subsequent calls to \helpref{Convert()}{wxencodingconverterconvert} will interpret its argument @@ -42,14 +49,14 @@ cannot be converted because it does not exist in output encoding: \begin{twocollist}\itemsep=0pt \twocolitem{{\bf wxCONVERT\_STRICT}}{follow behaviour of GNU Recode - -just copy unconvertable characters to output and don't change them +just copy unconvertible characters to output and don't change them (its integer value will stay the same)} \twocolitem{{\bf wxCONVERT\_SUBSTITUTE}}{try some (lossy) substitutions -- e.g. replace unconvertable latin capitals with acute by ordinary +- e.g. replace unconvertible latin capitals with acute by ordinary capitals, replace en-dash or em-dash by '-' etc.} \end{twocollist} -Both modes gurantee that output string will have same length +Both modes guarantee that output string will have same length as input string. \wxheading{Return value} @@ -61,16 +68,35 @@ or output encoding is not supported.) \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert} +\func{void}{Convert}{\param{const char* }{input}, \param{char* }{output}} + +\func{void}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}} + +\func{void}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}} + +\func{void}{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}. + +\func{void}{Convert}{\param{char* }{str}} + +\func{void}{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. + \func{wxString}{Convert}{\param{const wxString\& }{input}} -\func{void}{Convert}{\param{const wxChar* }{input}, \param{wxChar* }{output}} +Convert wxString and return new wxString object. -\func{void}{Convert}{\param{wxChar* }{str}} +\wxheading{Notes} -\func{void}{Convert}{\param{const char* }{input}, \param{wxChar* }{output}} +You must call \helpref{Init}{wxencodingconverterinit} before using this method! -Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit}. -Note that you must call Init before using Convert! +{\tt wchar\_t} versions of the method are not available if wxWindows was compiled +with {\tt wxUSE\_WCHAR\_T} set to 0. \membersection{wxEncodingConverter::GetPlatformEquivalents}\label{wxencodingconvertergetplatformequivalents} @@ -87,7 +113,7 @@ under given platform. Supported platforms: \item wxPLATFORM\_CURRENT \end{itemize} -wxPLATFORM\_CURRENT means the plaform this binary was compiled for. +wxPLATFORM\_CURRENT means the platform this binary was compiled for. Examples: @@ -101,10 +127,10 @@ unix CP1252 {ISO8859_1,ISO8859_15} \end{verbatim} Equivalence is defined in terms of convertibility: -2 encodings are equivalent if you can convert text between -then without loosing information (it may - and will - happen -that you loose special chars like quotation marks or em-dashes -but you shouldn't loose any diacritics and language-specific +two encodings are equivalent if you can convert text between +then without losing information (it may - and will - happen +that you lose special chars like quotation marks or em-dashes +but you shouldn't lose any diacritics and language-specific characters when converting between equivalent encodings). Remember that this function does {\bf NOT} check for presence of @@ -115,14 +141,14 @@ encodings. (It usually returns only one encoding.) \begin{itemize}\itemsep=0pt \item Note that argument {\it enc} itself may be present in the returned array, -so that you can - as a side effect - detect whether the +so that you can, as a side-effect, detect whether the encoding is native for this platform or not. -\item helpref{Convert}{wxencodingconverterconvert} is not limited to -converting between equivalent encodings, it can convert between arbitrary -two encodings. -\item If {\it enc} is present in returned array, then it is {\bf always} first +\item \helpref{Convert}{wxencodingconverterconvert} is not limited to +converting between equivalent encodings, it can convert between two arbitrary +encodings. +\item If {\it enc} is present in the returned array, then it is {\bf always} the first item of it. -\item Please note that the returned array may not contain any items at all. +\item Please note that the returned array may contain no items at all. \end{itemize} \membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents} @@ -132,7 +158,7 @@ item of it. Similar to \helpref{GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents}, but this one will return ALL -equivalent encodings, regardless the platform, and including itself. +equivalent encodings, regardless of the platform, and including itself. This platform's encodings are before others in the array. And again, if {\it enc} is in the array, it is the very first item in it.