docs/latex/wx/fontmap.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % fontmap.h at 10/Mar/00 23:54:16
   4 %
   5
   6 \section{\class{wxFontMapper}}\label{wxfontmapper}
   7
   8 wxFontMapper manages user-definable correspondence between logical font
   9 names and the fonts present on the machine.
  10
  11 The default implementations of all functions will ask the user if they are
  12 not capable of finding the answer themselves and store the answer in a
  13 config file (configurable via SetConfigXXX functions). This behaviour may
  14 be disabled by giving the value of false to "interactive" parameter.
  15
  16 However, the functions will always consult the config file to allow the
  17 user-defined values override the default logic and there is no way to
  18 disable this - which shouldn't be ever needed because if "interactive" was
  19 never true, the config file is never created anyhow.
  20
  21 In case everything else fails (i.e. there is no record in config file
  22 and "interactive" is false or user denied to choose any replacement),
  23 the class queries \helpref{wxEncodingConverter}{wxencodingconverter}
  24 for "equivalent" encodings (e.g. iso8859-2 and cp1250) and tries them.
  25
  26 \wxheading{Using wxFontMapper in conjunction with wxMBConv classes}
  27
  28 If you need to display text in encoding which is not available at
  29 host system (see \helpref{IsEncodingAvailable}{wxfontmapperisencodingavailable}),
  30 you may use these two classes to find font in some similar encoding
  31 (see \helpref{GetAltForEncoding}{wxfontmappergetaltforencoding})
  32 and convert the text to this encoding
  33 (\helpref{wxMBConv classes}{mbconvclasses}).
  34
  35 Following code snippet demonstrates it:
  36
  37 \begin{verbatim}
  38 if (!wxFontMapper::Get()->IsEncodingAvailable(enc, facename))
  39 {
  40    wxFontEncoding alternative;
  41    if (wxFontMapper::Get()->GetAltForEncoding(enc, &alternative,
  42                                               facename, false))
  43    {
  44        wxCSConv convFrom(wxFontMapper::Get()->GetEncodingName(enc));
  45        wxCSConv convTo(wxFontMapper::Get()->GetEncodingName(alternative));
  46        text = wxString(text.mb_str(convFrom), convTo);
  47    }
  48    else
  49        ...failure (or we may try iso8859-1/7bit ASCII)...
  50 }
  51 ...display text...
  52 \end{verbatim}
  53
  54
  55 \wxheading{Derived from}
  56
  57 No base class
  58
  59 \wxheading{Include files}
  60
  61 <wx/fontmap.h>
  62
  63 \wxheading{See also}
  64
  65 \helpref{wxEncodingConverter}{wxencodingconverter},
  66 \helpref{Writing non-English applications}{nonenglishoverview}
  67
  68 \latexignore{\rtfignore{\wxheading{Members}}}
  69
  70
  71 \membersection{wxFontMapper::wxFontMapper}\label{wxfontmapperwxfontmapper}
  72
  73 \func{}{wxFontMapper}{\void}
  74
  75 Default ctor.
  76
  77 \wxheading{Note}
  78
  79 The preferred way of creating a wxFontMapper instance is to call
  80 \helpref{wxFontMapper::Get}{wxfontmapperget}.
  81
  82
  83 \membersection{wxFontMapper::\destruct{wxFontMapper}}\label{wxfontmapperdtor}
  84
  85 \func{}{\destruct{wxFontMapper}}{\void}
  86
  87 Virtual dtor for a base class.
  88
  89
  90 \membersection{wxFontMapper::CharsetToEncoding}\label{wxfontmappercharsettoencoding}
  91
  92 \func{wxFontEncoding}{CharsetToEncoding}{\param{const wxString\& }{charset}, \param{bool }{interactive = true}}
  93
  94 Returns the encoding for the given charset (in the form of RFC 2046) or
  95 \texttt{wxFONTENCODING\_SYSTEM} if couldn't decode it.
  96
  97 Be careful when using this function with \arg{interactive} set to \true
  98 (default value) as the function then may show a dialog box to the user which
  99 may lead to unexpected reentrancies and may also take a significantly longer
 100 time than a simple function call. For these reasons, it is almost always a bad
 101 idea to call this function from the event handlers for repeatedly generated
 102 events such as \texttt{EVT\_PAINT}.
 103
 104
 105 \membersection{wxFontMapper::Get}\label{wxfontmapperget}
 106
 107 \func{static wxFontMapper *}{Get}{\void}
 108
 109 Get the current font mapper object. If there is no current object, creates
 110 one.
 111
 112 \wxheading{See also}
 113
 114 \helpref{wxFontMapper::Set}{wxfontmapperset}
 115
 116
 117 \membersection{wxFontMapper::GetAltForEncoding}\label{wxfontmappergetaltforencoding}
 118
 119 \func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxNativeEncodingInfo* }{info}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = true}}
 120
 121 \func{bool}{GetAltForEncoding}{\param{wxFontEncoding }{encoding}, \param{wxFontEncoding* }{alt\_encoding}, \param{const wxString\& }{facename = wxEmptyString}, \param{bool }{interactive = true}}
 122
 123 Find an alternative for the given encoding (which is supposed to not be
 124 available on this system). If successful, return true and fill info
 125 structure with the parameters required to create the font, otherwise
 126 return false.
 127
 128 The first form is for wxWidgets' internal use while the second one
 129 is better suitable for general use -- it returns wxFontEncoding which
 130 can consequently be passed to wxFont constructor.
 131
 132
 133 \membersection{wxFontMapper::GetEncoding}\label{wxfontmappergetencoding}
 134
 135 \func{static wxFontEncoding}{GetEncoding}{\param{size\_t }{n}}
 136
 137 Returns the {\it n}-th supported encoding. Together with
 138 \helpref{GetSupportedEncodingsCount()}{wxfontmappergetsupportedencodingscount}
 139 this method may be used to get all supported encodings.
 140
 141
 142 \membersection{wxFontMapper::GetEncodingDescription}\label{wxfontmappergetencodingdescription}
 143
 144 \func{static wxString}{GetEncodingDescription}{\param{wxFontEncoding }{encoding}}
 145
 146 Return user-readable string describing the given encoding.
 147
 148
 149 \membersection{wxFontMapper::GetEncodingFromName}\label{wxfontmappergetencodingfromname}
 150
 151 \func{static wxFontEncoding}{GetEncodingFromName}{\param{const wxString\& }{encoding}}
 152
 153 Return the encoding corresponding to the given internal name. This function is
 154 the inverse of \helpref{GetEncodingName}{wxfontmappergetencodingname} and is
 155 intentionally less general than
 156 \helpref{CharsetToEncoding}{wxfontmappercharsettoencoding}, i.e. it doesn't
 157 try to make any guesses nor ever asks the user. It is meant just as a way of
 158 restoring objects previously serialized using
 159 \helpref{GetEncodingName}{wxfontmappergetencodingname}.
 160
 161
 162 \membersection{wxFontMapper::GetEncodingName}\label{wxfontmappergetencodingname}
 163
 164 \func{static wxString}{GetEncodingName}{\param{wxFontEncoding }{encoding}}
 165
 166 Return internal string identifier for the encoding (see also
 167 \helpref{GetEncodingDescription()}{wxfontmappergetencodingdescription})
 168
 169 \wxheading{See also}
 170
 171 \helpref{GetEncodingFromName}{wxfontmappergetencodingfromname}
 172
 173
 174 \membersection{wxFontMapper::GetSupportedEncodingsCount}\label{wxfontmappergetsupportedencodingscount}
 175
 176 \func{static size\_t}{GetSupportedEncodingsCount}{\void}
 177
 178 Returns the number of the font encodings supported by this class. Together with
 179 \helpref{GetEncoding}{wxfontmappergetencoding} this method may be used to get
 180 all supported encodings.
 181
 182
 183 \membersection{wxFontMapper::IsEncodingAvailable}\label{wxfontmapperisencodingavailable}
 184
 185 \func{bool}{IsEncodingAvailable}{\param{wxFontEncoding }{encoding}, \param{const wxString\& }{facename = wxEmptyString}}
 186
 187 Check whether given encoding is available in given face or not.
 188 If no facename is given, find {\it any} font in this encoding.
 189
 190
 191 \membersection{wxFontMapper::SetDialogParent}\label{wxfontmappersetdialogparent}
 192
 193 \func{void}{SetDialogParent}{\param{wxWindow* }{parent}}
 194
 195 The parent window for modal dialogs.
 196
 197
 198 \membersection{wxFontMapper::SetDialogTitle}\label{wxfontmappersetdialogtitle}
 199
 200 \func{void}{SetDialogTitle}{\param{const wxString\& }{title}}
 201
 202 The title for the dialogs (note that default is quite reasonable).
 203
 204
 205 \membersection{wxFontMapper::Set}\label{wxfontmapperset}
 206
 207 \func{static wxFontMapper *}{Set}{\param{wxFontMapper *}{mapper}}
 208
 209 Set the current font mapper object and return previous one (may be NULL).
 210 This method is only useful if you want to plug-in an alternative font mapper
 211 into wxWidgets.
 212
 213 \wxheading{See also}
 214
 215 \helpref{wxFontMapper::Get}{wxfontmapperget}
 216
 217
 218 \membersection{wxFontMapper::SetConfig}\label{wxfontmappersetconfig}
 219
 220 \func{void}{SetConfig}{\param{wxConfigBase* }{config}}
 221
 222 Set the config object to use (may be NULL to use default).
 223
 224 By default, the global one (from wxConfigBase::Get() will be used)
 225 and the default root path for the config settings is the string returned by
 226 GetDefaultConfigPath().
 227
 228
 229 \membersection{wxFontMapper::SetConfigPath}\label{wxfontmappersetconfigpath}
 230
 231 \func{void}{SetConfigPath}{\param{const wxString\& }{prefix}}
 232
 233 Set the root config path to use (should be an absolute path).
 234