docs/latex/wx/encconv.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % encconv.h at 30/Dec/99 18:45:16
   4 %
   5
   6 \section{\class{wxEncodingConverter}}\label{wxencodingconverter}
   7
   8 This class is capable of converting strings between any two
   9 8-bit encodings/charsets. It can also convert from/to Unicode (but only
  10 if you compiled wxWindows with wxUSE\_UNICODE set to 1).
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxObject}{wxobject}
  15
  16 \latexignore{\rtfignore{\wxheading{Members}}}
  17
  18 \membersection{wxEncodingConverter::wxEncodingConverter}\label{wxencodingconverterwxencodingconverter}
  19
  20 \func{}{wxEncodingConverter}{\void}
  21
  22 Constructor.
  23
  24 \membersection{wxEncodingConverter::Init}\label{wxencodingconverterinit}
  25
  26 \func{bool}{Init}{\param{wxFontEncoding }{input\_enc}, \param{wxFontEncoding }{output\_enc}, \param{int }{method = wxCONVERT\_STRICT}}
  27
  28 Initialize convertion. Both output or input encoding may
  29 be wxFONTENCODING\_UNICODE, but only if wxUSE\_ENCODING is set to 1.
  30 All subsequent calls to \helpref{Convert()}{wxencodingconverterconvert}
  31 will interpret its argument
  32 as a string in {\it input\_enc} encoding and will output string in
  33 {\it output\_enc} encoding.
  34 You must call this method before calling Convert. You may call
  35 it more than once in order to switch to another conversion.
  36 {\it Method} affects behaviour of Convert() in case input character
  37 cannot be converted because it does not exist in output encoding:
  38
  39 \begin{twocollist}\itemsep=0pt
  40 \twocolitem{{\bf wxCONVERT\_STRICT}}{follow behaviour of GNU Recode -
  41 just copy unconvertable  characters to output and don't change them
  42 (its integer value will stay the same)}
  43 \twocolitem{{\bf wxCONVERT\_SUBSTITUTE}}{try some (lossy) substitutions
  44 - e.g. replace unconvertable latin capitals with acute by ordinary
  45 capitals, replace en-dash or em-dash by '-' etc.}
  46 \end{twocollist}
  47
  48 Both modes gurantee that output string will have same length
  49 as input string.
  50
  51 \wxheading{Return value}
  52
  53 FALSE if given conversion is impossible, TRUE otherwise
  54 (conversion may be impossible either if you try to convert
  55 to Unicode with non-Unicode build of wxWindows or if input
  56 or output encoding is not supported.)
  57
  58 \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert}
  59
  60 \func{wxString}{Convert}{\param{const wxString\& }{input}}
  61
  62 \func{void}{Convert}{\param{const wxChar* }{input}, \param{wxChar* }{output}}
  63
  64 \func{void}{Convert}{\param{wxChar* }{str}}
  65
  66 \func{void}{Convert}{\param{const char* }{input}, \param{wxChar* }{output}}
  67
  68 Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit}.
  69 Note that you must call Init before using Convert!
  70
  71 \membersection{wxEncodingConverter::GetPlatformEquivalents}\label{wxencodingconvertergetplatformequivalents}
  72
  73 \func{static wxFontEncodingArray}{GetPlatformEquivalents}{\param{wxFontEncoding }{enc}, \param{int }{platform = wxPLATFORM\_CURRENT}}
  74
  75 Return equivalents for given font that are used
  76 under given platform. Supported platforms:
  77
  78 \begin{itemize}\itemsep=0pt
  79 \item wxPLATFORM\_UNIX
  80 \item wxPLATFORM\_WINDOWS
  81 \item wxPLATFORM\_OS2
  82 \item wxPLATFORM\_MAC
  83 \item wxPLATFORM\_CURRENT
  84 \end{itemize}
  85
  86 wxPLATFORM\_CURRENT means the plaform this binary was compiled for.
  87
  88 Examples:
  89
  90 \begin{verbatim}
  91 current platform   enc          returned value
  92 ----------------------------------------------
  93 unix            CP1250             {ISO8859_2}
  94 unix         ISO8859_2             {ISO8859_2}
  95 windows      ISO8859_2                {CP1250}
  96 unix            CP1252  {ISO8859_1,ISO8859_15}
  97 \end{verbatim}
  98
  99 Equivalence is defined in terms of convertibility:
 100 2 encodings are equivalent if you can convert text between
 101 then without loosing information (it may - and will - happen
 102 that you loose special chars like quotation marks or em-dashes
 103 but you shouldn't loose any diacritics and language-specific
 104 characters when converting between equivalent encodings).
 105
 106 Remember that this function does {\bf NOT} check for presence of
 107 fonts in system. It only tells you what are most suitable
 108 encodings. (It usually returns only one encoding.)
 109
 110 \wxheading{Notes}
 111
 112 \begin{itemize}\itemsep=0pt
 113 \item Note that argument {\it enc} itself may be present in the returned array,
 114 so that you can - as a side effect - detect whether the
 115 encoding is native for this platform or not.
 116 \item helpref{Convert}{wxencodingconverterconvert} is not limited to
 117 converting between equivalent encodings, it can convert between arbitrary
 118 two encodings.
 119 \item If {\it enc} is present in returned array, then it is {\bf always} first
 120 item of it.
 121 \item Please note that the returned array may not contain any items at all.
 122 \end{itemize}
 123
 124 \membersection{wxEncodingConverter::GetAllEquivalents}\label{wxencodingconvertergetallequivalents}
 125
 126 \func{static wxFontEncodingArray}{GetAllEquivalents}{\param{wxFontEncoding }{enc}}
 127
 128 Similar to
 129 \helpref{GetPlatformEquivalents}{wxencodingconvertergetplatformequivalents},
 130 but this one will return ALL
 131 equivalent encodings, regardless the platform, and including itself.
 132
 133 This platform's encodings are before others in the array. And again, if {\it enc} is in the array,
 134 it is the very first item in it.
 135