include/wx/fontenum.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        fontenum.h
   3 // Purpose:     wxFontEnumerator class for getting available fonts
   4 // Author:      Julian Smart, Vadim Zeitlin
   5 // Modified by: extended to enumerate more than just font families and work ot
   6 //              only on Windows (VZ)
   7 // Created:     04/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) Julian Smart, Vadim Zeitlin
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_FONTENUM_H_
  14 #define _WX_FONTENUM_H_
  15
  16 #ifdef __GNUG__
  17     #pragma interface "fontenum.h"
  18 #endif
  19
  20 // ----------------------------------------------------------------------------
  21 // wxFontEnumerator enumerates all available fonts on the system or only the
  22 // fonts with given attributes
  23 // ----------------------------------------------------------------------------
  24
  25 class WXDLLEXPORT wxFontEnumerator
  26 {
  27 public:
  28     // start enumerating font families - will result in OnFontFamily() being
  29     // called for each available font family (unless it returns FALSE)
  30     virtual bool EnumerateFamilies(bool fixedWidthOnly = FALSE);
  31
  32     // enumerate the different encodings either for given font family or for
  33     // all font families - will result in OnFontEncoding() being called for
  34     // each available (family, encoding) couple
  35     virtual bool EnumerateEncodings(const wxString& family = wxT(""));
  36
  37     // callbacks which are called after one of EnumerateXXX() functions from
  38     // above is invoked - all of them may return FALSE to stop enumeration or
  39     // TRUE to continue with it
  40
  41     // called by EnumerateFamilies
  42     virtual bool OnFontFamily(const wxString& WXUNUSED(family))
  43         { return FALSE; }
  44
  45     // called by EnumerateEncodings
  46     virtual bool OnFontEncoding(const wxString& WXUNUSED(family),
  47                                 const wxString& WXUNUSED(encoding))
  48         { return FALSE; }
  49 };
  50
  51 #endif // _WX_FONTENUM_H_