added TGA handler (somewhat modified patch 1393912)

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

diff --git a/docs/latex/wx/encconv.tex b/docs/latex/wx/encconv.tex
index 0548703ba1eb44ede11206c4284c32b5d12e3677..f24df2dd1e4b52e127b6cd20b4bba85a20b70055 100644 (file)
--- 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
 
 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 wxWindows 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}.
 
 {\tt wxFONTENCODING\_ISO8859\_1..15}, {\tt wxFONTENCODING\_CP1250..1257} and 
 {\tt wxFONTENCODING\_KOI8}.
 


@@ -76,16 +76,16 @@ as input string.
 
 false if given conversion is impossible, true otherwise
 (conversion may be impossible either if you try to convert
 
 false if given conversion is impossible, true otherwise
 (conversion may be impossible either if you try to convert

-to Unicode with non-Unicode build of wxWindows or if input
+to Unicode with non-Unicode build of wxWidgets or if input

 or output encoding is not supported.)
 
 
 \membersection{wxEncodingConverter::CanConvert}\label{wxencodingconvertercanconvert}
 
 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
 
 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
 
 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}
 
 
 \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}.
 
 
 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.
 
 
 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.
 \constfunc{wxString}{Convert}{\param{const wxString\& }{input}}
 
 Convert wxString and return new wxString object.


@@ -121,7 +127,7 @@ Convert wxString and return new wxString object.
 
 You must call \helpref{Init}{wxencodingconverterinit} before using this method!
 
 
 You must call \helpref{Init}{wxencodingconverterinit} before using this method!
 

-{\tt wchar\_t} versions of the method are not available if wxWindows was compiled
+{\tt wchar\_t} versions of the method are not available if wxWidgets was compiled

 with {\tt wxUSE\_WCHAR\_T} set to 0.
 
 
 with {\tt wxUSE\_WCHAR\_T} set to 0.