docs/latex/wx/fontenum.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        fontenum.tex
   3 %% Purpose:     wxFontEnumerator documentation
   4 %% Author:      Vadim Zeitlin
   5 %% Modified by:
   6 %% Created:     03.11.99
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) Vadim Zeitlin
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxFontEnumerator}}\label{wxfontenumerator}
  13
  14 wxFontEnumerator enumerates either all available fonts on the system or only
  15 the ones with given attributes - either only fixed-width (suited for use in
  16 programs such as terminal emulators and the like) or the fonts available in
  17 the given \helpref{encoding}{wxfontencodingoverview}.
  18
  19 To do this, you just have to call one of EnumerateXXX() functions - either
  20 \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or
  21 \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the
  22 corresponding callback (\helpref{OnFacename}{wxfontenumeratoronfacename} or
  23 \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called
  24 repeatedly until either all fonts satisfying the specified criteria are
  25 exhausted or the callback returns false.
  26
  27 \wxheading{Virtual functions to override}
  28
  29 Either \helpref{OnFacename}{wxfontenumeratoronfacename} or
  30 \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding} should be overridden
  31 depending on whether you plan to call
  32 \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or
  33 \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings}. Of course,
  34 if you call both of them, you should override both functions.
  35
  36 \wxheading{Derived from}
  37
  38 None
  39
  40 \wxheading{Include files}
  41
  42 <wx/fontenum.h>
  43
  44 \wxheading{Library}
  45
  46 \helpref{wxCore}{librarieslist}
  47
  48 \wxheading{See also}
  49
  50 \helpref{Font encoding overview}{wxfontencodingoverview},
  51 \helpref{Font sample}{samplefont},
  52 \helpref{wxFont}{wxfont},
  53 \helpref{wxFontMapper}{wxfontmapper}
  54
  55
  56
  57 \latexignore{\rtfignore{\wxheading{Members}}}
  58
  59 \membersection{wxFontEnumerator::EnumerateFacenames}\label{wxfontenumeratorenumeratefacenames}
  60
  61 \func{virtual bool}{EnumerateFacenames}{
  62     \param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM},
  63     \param{bool }{fixedWidthOnly = false}}
  64
  65 Call \helpref{OnFacename}{wxfontenumeratoronfacename} for each font which
  66 supports given encoding (only if it is not wxFONTENCODING\_SYSTEM) and is of
  67 fixed width (if \arg{fixedWidthOnly} is true).
  68
  69 Calling this function with default arguments will result in enumerating all
  70 fonts available on the system.
  71
  72
  73 \membersection{wxFontEnumerator::EnumerateEncodings}\label{wxfontenumeratorenumerateencodings}
  74
  75 \func{virtual bool}{EnumerateEncodings}{\param{const wxString\& }{font = ""}}
  76
  77 Call \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding} for each
  78 encoding supported by the given font - or for each encoding supported by at
  79 least some font if {\it font} is not specified.
  80
  81
  82 \membersection{wxFontEnumerator::GetEncodings}\label{wxfontenumeratorgetencodings}
  83
  84 \func{static wxArrayString}{GetEncodings}{\param{const wxString\&}{ facename = ""}}
  85
  86 Return array of strings containing all encodings found by
  87 \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings}.
  88
  89
  90 \membersection{wxFontEnumerator::GetFacenames}\label{wxfontenumeratorgetfacenames}
  91
  92 \func{static wxArrayString}{GetFacenames}{\param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM}, \param{bool }{fixedWidthOnly = false}}
  93
  94 Return array of strings containing all facenames found by
  95 \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames}.
  96
  97
  98 \membersection{wxFontEnumerator::IsValidFacename}\label{wxfontenumeratorisvalidfacename}
  99
 100 \func{static bool}{IsValidFacename}{\param{const wxString \&}{ facename}}
 101
 102 Returns \true if the given string is valid face name, i.e. it's the face name of an installed
 103 font and it can safely be used with \helpref{wxFont::SetFaceName}{wxfontsetfacename}.
 104
 105
 106 \membersection{wxFontEnumerator::OnFacename}\label{wxfontenumeratoronfacename}
 107
 108 \func{virtual bool}{OnFacename}{\param{const wxString\& }{font}}
 109
 110 Called by \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} for
 111 each match. Return true to continue enumeration or false to stop it.
 112
 113
 114 \membersection{wxFontEnumerator::OnFontEncoding}\label{wxfontenumeratoronfontencoding}
 115
 116 \func{virtual bool}{OnFontEncoding}{\param{const wxString\& }{font}, \param{const wxString\& }{encoding}}
 117
 118 Called by \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} for
 119 each match. Return true to continue enumeration or false to stop it.
 120