include/wx/fontutil.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/fontutil.h
   3 // Purpose:     font-related helper functions
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     05.11.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // General note: this header is private to wxWindows and is not supposed to be
  13 // included by user code. The functions declared here are implemented in
  14 // msw/fontutil.cpp for Windows, unix/fontutil.cpp for GTK/Motif &c.
  15
  16 #ifndef _WX_FONTUTIL_H_
  17 #define _WX_FONTUTIL_H_
  18
  19 #ifdef __GNUG__
  20     #pragma interface "fontutil.h"
  21 #endif
  22
  23 // ----------------------------------------------------------------------------
  24 // headers
  25 // ----------------------------------------------------------------------------
  26
  27 #include "wx/font.h"        // for wxFont and wxFontEncoding
  28
  29 #if defined(__WXMSW__)
  30     #include <windows.h>
  31     #include "wx/msw/winundef.h"
  32 #endif
  33
  34 #if defined(_WX_X_FONTLIKE)
  35
  36 // the symbolic names for the XLFD fields (with examples for their value)
  37 //
  38 // NB: we suppose that the font always starts with the empty token (font name
  39 //     registry field) as we never use nor generate it anyhow
  40 enum wxXLFDField
  41 {
  42     wxXLFD_FOUNDRY,     // adobe
  43     wxXLFD_FAMILY,      // courier, times, ...
  44     wxXLFD_WEIGHT,      // black, bold, demibold, medium, regular, light
  45     wxXLFD_SLANT,       // r/i/o (roman/italique/oblique)
  46     wxXLFD_SETWIDTH,    // condensed, expanded, ...
  47     wxXLFD_ADDSTYLE,    // whatever - usually nothing
  48     wxXLFD_PIXELSIZE,   // size in pixels
  49     wxXLFD_POINTSIZE,   // size in points
  50     wxXLFD_RESX,        // 72, 75, 100, ...
  51     wxXLFD_RESY,
  52     wxXLFD_SPACING,     // m/p/c (monospaced/proportional/character cell)
  53     wxXLFD_AVGWIDTH,    // average width in 1/10 pixels
  54     wxXLFD_REGISTRY,    // iso8859, rawin, koi8, ...
  55     wxXLFD_ENCODING,    // 1, r, r, ...
  56     wxXLFD_MAX
  57 };
  58
  59 #endif // _WX_X_FONTLIKE
  60
  61 // ----------------------------------------------------------------------------
  62 // types
  63 // ----------------------------------------------------------------------------
  64
  65 // wxNativeFontInfo is platform-specific font representation: this struct
  66 // should be considered as opaque font description only used by the native
  67 // functions, the user code can only get the objects of this type from
  68 // somewhere and pass it somewhere else (possibly save them somewhere using
  69 // ToString() and restore them using FromString())
  70 //
  71 // NB: it is a POD currently for max efficiency but if it continues to grow
  72 //     further it might make sense to make it a real class with virtual methods
  73 struct WXDLLEXPORT wxNativeFontInfo
  74 {
  75 #if defined(_WX_X_FONTLIKE)
  76     // the members can't be accessed directly as we only parse the
  77     // xFontName on demand
  78 private:
  79     // the components of the XLFD
  80     wxString     fontElements[wxXLFD_MAX];
  81
  82     // the full XLFD
  83     wxString     xFontName;
  84
  85     // true until SetXFontName() is called
  86     bool         m_isDefault;
  87
  88     // return true if we have already initialized fontElements
  89     inline bool HasElements() const;
  90
  91 public:
  92     // init the elements from an XLFD, return TRUE if ok
  93     bool FromXFontName(const wxString& xFontName);
  94
  95     // return false if we were never initialized with a valid XLFD
  96     bool IsDefault() const { return m_isDefault; }
  97
  98     // return the XLFD (using the fontElements if necessary)
  99     wxString GetXFontName() const;
 100
 101     // get the given XFLD component
 102     wxString GetXFontComponent(wxXLFDField field) const;
 103
 104     // change the font component
 105     void SetXFontComponent(wxXLFDField field, const wxString& value);
 106
 107     // set the XFLD
 108     void SetXFontName(const wxString& xFontName);
 109 #elif defined(__WXMSW__)
 110     LOGFONT      lf;
 111 #elif defined(__WXPM__)
 112     // OS/2 native structures that define a font
 113     FATTRS       fa;
 114     FONTMETRICS  fm;
 115     FACENAMEDESC fn;
 116 #else // other platforms
 117     //
 118     //  This is a generic implementation that should work on all ports
 119     //  without specific support by the port.
 120     //
 121     #define wxNO_NATIVE_FONTINFO
 122
 123     int           pointSize;
 124     wxFontFamily  family;
 125     wxFontStyle   style;
 126     wxFontWeight  weight;
 127     bool          underlined;
 128     wxString      faceName;
 129     wxFontEncoding encoding;
 130 #endif // platforms
 131
 132     // default ctor (default copy ctor is ok)
 133     wxNativeFontInfo() { Init(); }
 134
 135     // reset to the default state
 136     void Init();
 137
 138     // accessors and modifiers for the font elements
 139     int GetPointSize() const;
 140     wxFontStyle GetStyle() const;
 141     wxFontWeight GetWeight() const;
 142     bool GetUnderlined() const;
 143     wxString GetFaceName() const;
 144     wxFontFamily GetFamily() const;
 145     wxFontEncoding GetEncoding() const;
 146
 147     void SetPointSize(int pointsize);
 148     void SetStyle(wxFontStyle style);
 149     void SetWeight(wxFontWeight weight);
 150     void SetUnderlined(bool underlined);
 151     void SetFaceName(wxString facename);
 152     void SetFamily(wxFontFamily family);
 153     void SetEncoding(wxFontEncoding encoding);
 154
 155     // it is important to be able to serialize wxNativeFontInfo objects to be
 156     // able to store them (in config file, for example)
 157     bool FromString(const wxString& s);
 158     wxString ToString() const;
 159
 160     // we also want to present the native font descriptions to the user in some
 161     // human-readable form (it is not platform independent neither, but can
 162     // hopefully be understood by the user)
 163     bool FromUserString(const wxString& s);
 164     wxString ToUserString() const;
 165 };
 166
 167 // ----------------------------------------------------------------------------
 168 // font-related functions (common)
 169 // ----------------------------------------------------------------------------
 170
 171 // translate a wxFontEncoding into native encoding parameter (defined above),
 172 // returning TRUE if an (exact) macth could be found, FALSE otherwise (without
 173 // attempting any substitutions)
 174 extern bool wxGetNativeFontEncoding(wxFontEncoding encoding,
 175                                     wxNativeEncodingInfo *info);
 176
 177 // test for the existence of the font described by this facename/encoding,
 178 // return TRUE if such font(s) exist, FALSE otherwise
 179 extern bool wxTestFontEncoding(const wxNativeEncodingInfo& info);
 180
 181 // ----------------------------------------------------------------------------
 182 // font-related functions (X and GTK)
 183 // ----------------------------------------------------------------------------
 184
 185 #ifdef _WX_X_FONTLIKE
 186     #include "wx/unix/fontutil.h"
 187 #endif // X || GDK
 188
 189 // ----------------------------------------------------------------------------
 190 // font-related functions (MGL)
 191 // ----------------------------------------------------------------------------
 192
 193 #ifdef __WXMGL__
 194     #include "wx/mgl/fontutil.h"
 195 #endif // __WXMGL__
 196
 197 #endif // _WX_FONTUTIL_H_