compilation fix after TRUE/FALSE change

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

diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex
index 2c45952bda37c2f8936839cfe5a4286a6422bfe0..bbb4c149e941e256fdbaf1ccd69dbf38ecd3e269 100644 (file)
--- a/docs/latex/wx/encconv.tex
+++ b/docs/latex/wx/encconv.tex
@@ -7,12 +7,23 @@
 
 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}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/encconv.h>
+
+\wxheading{See also}
+
+\helpref{wxFontMapper}{wxfontmapper}, 
+\helpref{wxMBConv}{wxmbconv}, 
+\helpref{Writing non-English applications}{nonenglishoverview}
+
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter}
@@ -38,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} 
@@ -57,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}
 
@@ -97,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
@@ -111,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}
@@ -128,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.