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