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