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 class WXDLLIMPEXP_FWD_BASE wxArrayString;
  30 struct WXDLLIMPEXP_FWD_CORE wxNativeEncodingInfo;
  31
  32 #if defined(_WX_X_FONTLIKE)
  33
  34 // the symbolic names for the XLFD fields (with examples for their value)
  35 //
  36 // NB: we suppose that the font always starts with the empty token (font name
  37 //     registry field) as we never use nor generate it anyhow
  38 enum wxXLFDField
  39 {
  40     wxXLFD_FOUNDRY,     // adobe
  41     wxXLFD_FAMILY,      // courier, times, ...
  42     wxXLFD_WEIGHT,      // black, bold, demibold, medium, regular, light
  43     wxXLFD_SLANT,       // r/i/o (roman/italique/oblique)
  44     wxXLFD_SETWIDTH,    // condensed, expanded, ...
  45     wxXLFD_ADDSTYLE,    // whatever - usually nothing
  46     wxXLFD_PIXELSIZE,   // size in pixels
  47     wxXLFD_POINTSIZE,   // size in points
  48     wxXLFD_RESX,        // 72, 75, 100, ...
  49     wxXLFD_RESY,
  50     wxXLFD_SPACING,     // m/p/c (monospaced/proportional/character cell)
  51     wxXLFD_AVGWIDTH,    // average width in 1/10 pixels
  52     wxXLFD_REGISTRY,    // iso8859, rawin, koi8, ...
  53     wxXLFD_ENCODING,    // 1, r, r, ...
  54     wxXLFD_MAX
  55 };
  56
  57 #endif // _WX_X_FONTLIKE
  58
  59 // ----------------------------------------------------------------------------
  60 // types
  61 // ----------------------------------------------------------------------------
  62
  63 // wxNativeFontInfo is platform-specific font representation: this struct
  64 // should be considered as opaque font description only used by the native
  65 // functions, the user code can only get the objects of this type from
  66 // somewhere and pass it somewhere else (possibly save them somewhere using
  67 // ToString() and restore them using FromString())
  68
  69 class WXDLLIMPEXP_CORE wxNativeFontInfo
  70 {
  71 public:
  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     wxNativeFontInfo(const LOGFONT& lf_) : lf(lf_) { }
 110
 111     LOGFONT      lf;
 112 #elif defined(__WXPM__)
 113     // OS/2 native structures that define a font
 114     FATTRS       fa;
 115     FONTMETRICS  fm;
 116     FACENAMEDESC fn;
 117 #elif defined(__WXOSX__)
 118 public:
 119     wxNativeFontInfo(const wxNativeFontInfo& info) { Init(info); }
 120     wxNativeFontInfo( int size,
 121                   wxFontFamily family,
 122                   wxFontStyle style,
 123                   wxFontWeight weight,
 124                   bool underlined,
 125                   const wxString& faceName,
 126                   wxFontEncoding encoding)
 127     { Init(size,family,style,weight,underlined,faceName,encoding); }
 128
 129     ~wxNativeFontInfo() { Free(); }
 130
 131     wxNativeFontInfo& operator=(const wxNativeFontInfo& info)
 132     {
 133         if (this != &info)
 134         {
 135             Free();
 136             Init(info);
 137         }
 138         return *this;
 139     }
 140
 141 #if wxOSX_USE_CORE_TEXT
 142     void Init(CTFontDescriptorRef descr);
 143 #endif
 144     void Init(const wxNativeFontInfo& info);
 145     void Init(int size,
 146                   wxFontFamily family,
 147                   wxFontStyle style,
 148                   wxFontWeight weight,
 149                   bool underlined,
 150                   const wxString& faceName ,
 151                   wxFontEncoding encoding);
 152
 153     void Free();
 154     void EnsureValid();
 155
 156     bool m_descriptorValid;
 157
 158 #if wxOSX_USE_ATSU_TEXT
 159     bool            m_atsuFontValid;
 160     // the atsu font ID
 161     wxUint32        m_atsuFontID;
 162     // the qd styles that are not intrinsic to the font above
 163     wxInt16         m_atsuAdditionalQDStyles;
 164 #if wxOSX_USE_CARBON
 165     wxInt16         m_qdFontFamily;
 166     wxInt16         m_qdFontStyle;
 167 #endif
 168 #endif
 169
 170     int           m_pointSize;
 171     wxFontFamily  m_family;
 172     wxFontStyle   m_style;
 173     wxFontWeight  m_weight;
 174     bool          m_underlined;
 175     wxString      m_faceName;
 176     wxFontEncoding m_encoding;
 177 public :
 178 #else // other platforms
 179     //
 180     //  This is a generic implementation that should work on all ports
 181     //  without specific support by the port.
 182     //
 183     #define wxNO_NATIVE_FONTINFO
 184
 185     int           pointSize;
 186     wxFontFamily  family;
 187     wxFontStyle   style;
 188     wxFontWeight  weight;
 189     bool          underlined;
 190     wxString      faceName;
 191     wxFontEncoding encoding;
 192 #endif // platforms
 193
 194     // default ctor (default copy ctor is ok)
 195     wxNativeFontInfo() { Init(); }
 196
 197 #if wxUSE_PANGO
 198 private:
 199     void Init(const wxNativeFontInfo& info);
 200     void Free();
 201
 202 public:
 203     wxNativeFontInfo(const wxNativeFontInfo& info) { Init(info); }
 204     ~wxNativeFontInfo() { Free(); }
 205
 206     wxNativeFontInfo& operator=(const wxNativeFontInfo& info)
 207     {
 208         if (this != &info)
 209         {
 210             Free();
 211             Init(info);
 212         }
 213         return *this;
 214     }
 215 #endif // wxUSE_PANGO
 216
 217     // reset to the default state
 218     void Init();
 219
 220     // init with the parameters of the given font
 221     void InitFromFont(const wxFont& font)
 222     {
 223         // translate all font parameters
 224         SetStyle((wxFontStyle)font.GetStyle());
 225         SetWeight((wxFontWeight)font.GetWeight());
 226         SetUnderlined(font.GetUnderlined());
 227 #if defined(__WXMSW__)
 228         if ( font.IsUsingSizeInPixels() )
 229             SetPixelSize(font.GetPixelSize());
 230         else
 231             SetPointSize(font.GetPointSize());
 232 #else
 233         SetPointSize(font.GetPointSize());
 234 #endif
 235
 236         // set the family/facename
 237         SetFamily((wxFontFamily)font.GetFamily());
 238         const wxString& facename = font.GetFaceName();
 239         if ( !facename.empty() )
 240         {
 241             SetFaceName(facename);
 242         }
 243
 244         // deal with encoding now (it may override the font family and facename
 245         // so do it after setting them)
 246         SetEncoding(font.GetEncoding());
 247     }
 248
 249     // accessors and modifiers for the font elements
 250     int GetPointSize() const;
 251     wxSize GetPixelSize() const;
 252     wxFontStyle GetStyle() const;
 253     wxFontWeight GetWeight() const;
 254     bool GetUnderlined() const;
 255     wxString GetFaceName() const;
 256     wxFontFamily GetFamily() const;
 257     wxFontEncoding GetEncoding() const;
 258
 259     void SetPointSize(int pointsize);
 260     void SetPixelSize(const wxSize& pixelSize);
 261     void SetStyle(wxFontStyle style);
 262     void SetWeight(wxFontWeight weight);
 263     void SetUnderlined(bool underlined);
 264     bool SetFaceName(const wxString& facename);
 265     void SetFamily(wxFontFamily family);
 266     void SetEncoding(wxFontEncoding encoding);
 267
 268     // sets the first facename in the given array which is found
 269     // to be valid. If no valid facename is given, sets the
 270     // first valid facename returned by wxFontEnumerator::GetFacenames().
 271     // Does not return a bool since it cannot fail.
 272     void SetFaceName(const wxArrayString &facenames);
 273
 274
 275     // it is important to be able to serialize wxNativeFontInfo objects to be
 276     // able to store them (in config file, for example)
 277     bool FromString(const wxString& s);
 278     wxString ToString() const;
 279
 280     // we also want to present the native font descriptions to the user in some
 281     // human-readable form (it is not platform independent neither, but can
 282     // hopefully be understood by the user)
 283     bool FromUserString(const wxString& s);
 284     wxString ToUserString() const;
 285 };
 286
 287 // ----------------------------------------------------------------------------
 288 // font-related functions (common)
 289 // ----------------------------------------------------------------------------
 290
 291 // translate a wxFontEncoding into native encoding parameter (defined above),
 292 // returning true if an (exact) macth could be found, false otherwise (without
 293 // attempting any substitutions)
 294 WXDLLIMPEXP_CORE bool wxGetNativeFontEncoding(wxFontEncoding encoding,
 295                                               wxNativeEncodingInfo *info);
 296
 297 // test for the existence of the font described by this facename/encoding,
 298 // return true if such font(s) exist, false otherwise
 299 WXDLLIMPEXP_CORE bool wxTestFontEncoding(const wxNativeEncodingInfo& info);
 300
 301 // ----------------------------------------------------------------------------
 302 // font-related functions (X and GTK)
 303 // ----------------------------------------------------------------------------
 304
 305 #ifdef _WX_X_FONTLIKE
 306     #include "wx/unix/fontutil.h"
 307 #endif // X || GDK
 308
 309 #endif // _WX_FONTUTIL_H_