% encconv.h at 30/Dec/99 18:45:16
%
-
\section{\class{wxEncodingConverter}}\label{wxencodingconverter}
This class is capable of converting strings between any two
-8bit encodings/charsets. It can also convert from/to Unicode (but only
+8-bit encodings/charsets. It can also convert from/to Unicode (but only
if you compiled wxWindows with wxUSE_UNICODE set to 1).
-
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter}
\func{}{wxEncodingConverter}{\void}
Initialize convertion. 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 it's argument
-as a string in {\it input\_enc} encoding and will output string in
+will interpret its argument
+as a string in {\it input\_enc} encoding and will output string in
{\it output\_enc} encoding.
You must call this method before calling Convert. You may call
it more than once in order to switch to another conversion.
{\it Method} affects behaviour of Convert() in case input character
cannot be converted because it does not exist in output encoding:
-\begin{twocollist}
+\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxCONVERT\_STRICT}}{follow behaviour of GNU Recode -
just copy unconvertable characters to output and don't change them
(its integer value will stay the same)}
to Unicode with non-Unicode build of wxWindows or if input
or output encoding is not supported.)
-
\membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert}
\func{wxString}{Convert}{\param{const wxString\& }{input}}
Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit}.
Note that you must call Init before using Convert!
-
-
\membersection{wxEncodingConverter::GetPlatformEquivalents}\label{wxencodingconvertergetplatformequivalents}
\func{static wxFontEncodingArray}{GetPlatformEquivalents}{\param{wxFontEncoding }{enc}, \param{int }{platform = wxPLATFORM\_CURRENT}}
Return equivalents for given font that are used
under given platform. Supported platforms:
-\begin{itemize}
+\begin{itemize}\itemsep=0pt
\item wxPLATFORM\_UNIX
\item wxPLATFORM\_WINDOWS
\item wxPLATFORM\_OS2
wxPLATFORM\_CURRENT means the plaform this binary was compiled for.
Examples:
+
\begin{verbatim}
current platform enc returned value
----------------------------------------------
\wxheading{Notes}
-\begin{itemize}
-\item Note that argument {\it enc} itself may be present in returned array!
-(So that you can - as a side effect - detect whether the
-encoding is native for this platform or not.)
-
+\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
+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!
-
+two encodings.
\item If {\it enc} is present in returned array, then it is {\bf always} first
item of it.
-
-\item Please not that returned array may not contain any item at all!
+\item Please note that the returned array may not contain any items at all.
\end{itemize}
-
\membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents}
\func{static wxFontEncodingArray}{GetAllEquivalents}{\param{wxFontEncoding }{enc}}
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.
+