include/wx/font.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/font.h
   3 // Purpose:     wxFontBase class: the interface of wxFont
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     20.09.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FONT_H_BASE_
  13 #define _WX_FONT_H_BASE_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "fontbase.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #include "wx/defs.h"        // for wxDEFAULT &c
  24 #include "wx/fontenc.h"     // the font encoding constants
  25 #include "wx/gdiobj.h"      // the base class
  26
  27 // ----------------------------------------------------------------------------
  28 // forward declarations
  29 // ----------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxFontData;
  32 class WXDLLEXPORT wxFontBase;
  33 class WXDLLEXPORT wxFont;
  34
  35 // ----------------------------------------------------------------------------
  36 // font constants
  37 // ----------------------------------------------------------------------------
  38
  39 // standard font families
  40 enum wxFontFamily
  41 {
  42     wxFONTFAMILY_DEFAULT = wxDEFAULT,
  43     wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
  44     wxFONTFAMILY_ROMAN = wxROMAN,
  45     wxFONTFAMILY_SCRIPT = wxSCRIPT,
  46     wxFONTFAMILY_SWISS = wxSWISS,
  47     wxFONTFAMILY_MODERN = wxMODERN,
  48     wxFONTFAMILY_TELETYPE = wxTELETYPE,
  49     wxFONTFAMILY_MAX
  50 };
  51
  52 // font styles
  53 enum wxFontStyle
  54 {
  55     wxFONTSTYLE_NORMAL = wxNORMAL,
  56     wxFONTSTYLE_ITALIC = wxITALIC,
  57     wxFONTSTYLE_SLANT = wxSLANT,
  58     wxFONTSTYLE_MAX
  59 };
  60
  61 // font weights
  62 enum wxFontWeight
  63 {
  64     wxFONTWEIGHT_NORMAL = wxNORMAL,
  65     wxFONTWEIGHT_LIGHT = wxLIGHT,
  66     wxFONTWEIGHT_BOLD = wxBOLD,
  67     wxFONTWEIGHT_MAX
  68 };
  69
  70 // ----------------------------------------------------------------------------
  71 // wxFontBase represents a font object
  72 // ----------------------------------------------------------------------------
  73
  74 class WXDLLEXPORT wxFontRefData;
  75 struct WXDLLEXPORT wxNativeFontInfo;
  76
  77 class WXDLLEXPORT wxFontBase : public wxGDIObject
  78 {
  79 public:
  80     // creator function
  81 #ifdef __DARWIN__
  82     virtual ~wxFontBase() { }
  83 #endif
  84
  85     // from the font components
  86     static wxFont *New(
  87         int pointSize,              // size of the font in points
  88         int family,                 // see wxFontFamily enum
  89         int style,                  // see wxFontStyle enum
  90         int weight,                 // see wxFontWeight enum
  91         bool underlined = FALSE,    // not underlined by default
  92         const wxString& face = wxEmptyString,              // facename
  93         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
  94
  95     // from the (opaque) native font description object
  96     static wxFont *New(const wxNativeFontInfo& nativeFontDesc);
  97
  98     // from the string representation of wxNativeFontInfo
  99     static wxFont *New(const wxString& strNativeFontDesc);
 100
 101     // was the font successfully created?
 102     bool Ok() const { return m_refData != NULL; }
 103
 104     // comparison
 105     bool operator == (const wxFont& font) const;
 106     bool operator != (const wxFont& font) const;
 107
 108     // accessors: get the font characteristics
 109     virtual int GetPointSize() const = 0;
 110     virtual int GetFamily() const = 0;
 111     virtual int GetStyle() const = 0;
 112     virtual int GetWeight() const = 0;
 113     virtual bool GetUnderlined() const = 0;
 114     virtual wxString GetFaceName() const = 0;
 115     virtual wxFontEncoding GetEncoding() const = 0;
 116     virtual wxNativeFontInfo *GetNativeFontInfo() const;
 117
 118     wxString GetNativeFontInfoDesc() const;
 119     wxString GetNativeFontInfoUserDesc() const;
 120
 121     // change the font characteristics
 122     virtual void SetPointSize( int pointSize ) = 0;
 123     virtual void SetFamily( int family ) = 0;
 124     virtual void SetStyle( int style ) = 0;
 125     virtual void SetWeight( int weight ) = 0;
 126     virtual void SetFaceName( const wxString& faceName ) = 0;
 127     virtual void SetUnderlined( bool underlined ) = 0;
 128     virtual void SetEncoding(wxFontEncoding encoding) = 0;
 129     virtual void SetNativeFontInfo(const wxNativeFontInfo& info);
 130
 131     void SetNativeFontInfo(const wxString& info);
 132     void SetNativeFontInfoUserDesc(const wxString& info);
 133
 134     // translate the fonts into human-readable string (i.e. GetStyleString()
 135     // will return "wxITALIC" for an italic font, ...)
 136     wxString GetFamilyString() const;
 137     wxString GetStyleString() const;
 138     wxString GetWeightString() const;
 139
 140     // the default encoding is used for creating all fonts with default
 141     // encoding parameter
 142     static wxFontEncoding GetDefaultEncoding()
 143         { return ms_encodingDefault; }
 144     static void SetDefaultEncoding(wxFontEncoding encoding)
 145         { ms_encodingDefault = encoding; }
 146
 147 protected:
 148     // get the internal data
 149     wxFontRefData *GetFontData() const
 150         { return (wxFontRefData *)m_refData; }
 151
 152 private:
 153     // the currently default encoding: by default, it's the default system
 154     // encoding, but may be changed by the application using
 155     // SetDefaultEncoding() to make all subsequent fonts created without
 156     // specifing encoding parameter using this encoding
 157     static wxFontEncoding ms_encodingDefault;
 158 };
 159
 160 // include the real class declaration
 161 #if defined(__WXMSW__)
 162     #include "wx/msw/font.h"
 163 #elif defined(__WXMOTIF__)
 164     #include "wx/motif/font.h"
 165 #elif defined(__WXGTK__)
 166     #include "wx/gtk/font.h"
 167 #elif defined(__WXMGL__)
 168     #include "wx/mgl/font.h"
 169 #elif defined(__WXMAC__)
 170     #include "wx/mac/font.h"
 171 #elif defined(__WXPM__)
 172     #include "wx/os2/font.h"
 173 #elif defined(__WXSTUBS__)
 174     #include "wx/stubs/font.h"
 175 #endif
 176
 177 // ----------------------------------------------------------------------------
 178 // macros
 179 // ----------------------------------------------------------------------------
 180
 181 #define M_FONTDATA GetFontData()
 182
 183 #endif
 184     // _WX_FONT_H_BASE_