Some doc corrections

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

diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex
index 154f7e2c97375d2cb78156e2ca03ada126e2c445..0548703ba1eb44ede11206c4284c32b5d12e3677 100644 (file)
--- a/docs/latex/wx/encconv.tex
+++ b/docs/latex/wx/encconv.tex
@@ -37,12 +37,14 @@ if you rely on {\tt wxCONVERT\_SUBSTITUTE} mode of operation (see
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter}
 
 \func{}{wxEncodingConverter}{\void}
 
 Constructor.
 
 \membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter}
 
 \func{}{wxEncodingConverter}{\void}
 
 Constructor.
 

+

 \membersection{wxEncodingConverter::Init}\label{wxencodingconverterinit}
 
 \func{bool}{Init}{\param{wxFontEncoding }{input\_enc}, \param{wxFontEncoding }{output\_enc}, \param{int }{method = wxCONVERT\_STRICT}}
 \membersection{wxEncodingConverter::Init}\label{wxencodingconverterinit}
 
 \func{bool}{Init}{\param{wxFontEncoding }{input\_enc}, \param{wxFontEncoding }{output\_enc}, \param{int }{method = wxCONVERT\_STRICT}}


@@ -77,28 +79,41 @@ false if given conversion is impossible, true otherwise
 to Unicode with non-Unicode build of wxWindows or if input
 or output encoding is not supported.)
 
 to Unicode with non-Unicode build of wxWindows or if input
 or output encoding is not supported.)
 

+
+\membersection{wxEncodingConverter::CanConvert}\label{wxencodingconvertercanconvert}
+
+\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.
+
+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
+on the text to convert in the other).
+
+

 \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert}
 
 \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert}
 

-\func{void}{Convert}{\param{const char* }{input}, \param{char* }{output}}
+\constfunc{void}{Convert}{\param{const char* }{input}, \param{char* }{output}}

 
 

-\func{void}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}}
+\constfunc{void}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}}

 
 

-\func{void}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}}
+\constfunc{void}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}}

 
 

-\func{void}{Convert}{\param{const wchar\_t* }{input}, \param{char* }{output}}
+\constfunc{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}.
 
 
 Convert input string according to settings passed to
 \helpref{Init}{wxencodingconverterinit} and writes the result to {\it output}.
 

-\func{void}{Convert}{\param{char* }{str}}
+\constfunc{void}{Convert}{\param{char* }{str}}

 
 

-\func{void}{Convert}{\param{wchar\_t* }{str}}
+\constfunc{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.
 
 
 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}}
+\constfunc{wxString}{Convert}{\param{const wxString\& }{input}}

 
 Convert wxString and return new wxString object.
 
 
 Convert wxString and return new wxString object.
 


@@ -109,6 +124,7 @@ You must call \helpref{Init}{wxencodingconverterinit} before using this method!
 {\tt wchar\_t} versions of the method are not available if wxWindows was compiled
 with {\tt wxUSE\_WCHAR\_T} set to 0.
 
 {\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}
 
 \func{static wxFontEncodingArray}{GetPlatformEquivalents}{\param{wxFontEncoding }{enc}, \param{int }{platform = wxPLATFORM\_CURRENT}}
 \membersection{wxEncodingConverter::GetPlatformEquivalents}\label{wxencodingconvertergetplatformequivalents}
 
 \func{static wxFontEncodingArray}{GetPlatformEquivalents}{\param{wxFontEncoding }{enc}, \param{int }{platform = wxPLATFORM\_CURRENT}}


@@ -162,6 +178,7 @@ item of it.
 \item Please note that the returned array may contain no items at all.
 \end{itemize}
 
 \item Please note that the returned array may contain no items at all.
 \end{itemize}
 

+

 \membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents}
 
 \func{static wxFontEncodingArray}{GetAllEquivalents}{\param{wxFontEncoding }{enc}}
 \membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents}
 
 \func{static wxFontEncodingArray}{GetAllEquivalents}{\param{wxFontEncoding }{enc}}