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