include/wx/msw/font.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/font.h
   3 // Purpose:     wxFont class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FONT_H_
  13 #define _WX_FONT_H_
  14
  15 #include "wx/gdicmn.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxFont
  19 // ----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxFont : public wxFontBase
  22 {
  23 public:
  24     // ctors and such
  25     wxFont() { }
  26
  27 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  28     wxFont(int size,
  29            int family,
  30            int style,
  31            int weight,
  32            bool underlined = false,
  33            const wxString& face = wxEmptyString,
  34            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  35     {
  36         (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
  37     }
  38 #endif
  39
  40     wxFont(int size,
  41            wxFontFamily family,
  42            wxFontStyle style,
  43            wxFontWeight weight,
  44            bool underlined = false,
  45            const wxString& face = wxEmptyString,
  46            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  47     {
  48         Create(size, family, style, weight, underlined, face, encoding);
  49     }
  50
  51     bool Create(int size,
  52                 wxFontFamily family,
  53                 wxFontStyle style,
  54                 wxFontWeight weight,
  55                 bool underlined = false,
  56                 const wxString& face = wxEmptyString,
  57                 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  58     {
  59         return DoCreate(size, wxDefaultSize, false, family, style,
  60                         weight, underlined, face, encoding);
  61     }
  62
  63 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  64     wxFont(const wxSize& pixelSize,
  65            int family,
  66            int style,
  67            int weight,
  68            bool underlined = false,
  69            const wxString& face = wxEmptyString,
  70            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  71     {
  72         (void)Create(pixelSize, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight,
  73                      underlined, face, encoding);
  74     }
  75 #endif
  76
  77     wxFont(const wxSize& pixelSize,
  78            wxFontFamily family,
  79            wxFontStyle style,
  80            wxFontWeight weight,
  81            bool underlined = false,
  82            const wxString& face = wxEmptyString,
  83            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  84     {
  85         (void)Create(pixelSize, family, style, weight,
  86                      underlined, face, encoding);
  87     }
  88
  89     wxFont(const wxNativeFontInfo& info, WXHFONT hFont = 0)
  90     {
  91         Create(info, hFont);
  92     }
  93
  94     wxFont(const wxString& fontDesc);
  95
  96
  97     bool Create(const wxSize& pixelSize,
  98                 wxFontFamily family,
  99                 wxFontStyle style,
 100                 wxFontWeight weight,
 101                 bool underlined = false,
 102                 const wxString& face = wxEmptyString,
 103                 wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
 104     {
 105         return DoCreate(-1, pixelSize, true, family, style,
 106                         weight, underlined, face, encoding);
 107     }
 108
 109     bool Create(const wxNativeFontInfo& info, WXHFONT hFont = 0);
 110
 111     virtual ~wxFont();
 112
 113     // wxFontBase overridden functions
 114     virtual wxString GetNativeFontInfoDesc() const;
 115     virtual wxString GetNativeFontInfoUserDesc() const;
 116
 117     // implement base class pure virtuals
 118     virtual int GetPointSize() const;
 119     virtual wxSize GetPixelSize() const;
 120     virtual bool IsUsingSizeInPixels() const;
 121     virtual wxFontFamily GetFamily() const;
 122     virtual wxFontStyle GetStyle() const;
 123     virtual wxFontWeight GetWeight() const;
 124     virtual bool GetUnderlined() const;
 125     virtual wxString GetFaceName() const;
 126     virtual wxFontEncoding GetEncoding() const;
 127     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
 128
 129     virtual void SetPointSize(int pointSize);
 130     virtual void SetPixelSize(const wxSize& pixelSize);
 131     virtual void SetFamily(wxFontFamily family);
 132     virtual void SetStyle(wxFontStyle style);
 133     virtual void SetWeight(wxFontWeight weight);
 134     virtual bool SetFaceName(const wxString& faceName);
 135     virtual void SetUnderlined(bool underlined);
 136     virtual void SetEncoding(wxFontEncoding encoding);
 137
 138     WXDECLARE_COMPAT_SETTERS
 139
 140     virtual bool IsFixedWidth() const;
 141
 142     // implementation only from now on
 143     // -------------------------------
 144
 145     virtual bool IsFree() const;
 146     virtual bool RealizeResource();
 147     virtual WXHANDLE GetResourceHandle() const;
 148     virtual bool FreeResource(bool force = false);
 149
 150     // for consistency with other wxMSW classes
 151     WXHFONT GetHFONT() const;
 152
 153 protected:
 154     // real font creation function, used in all cases
 155     bool DoCreate(int size,
 156                   const wxSize& pixelSize,
 157                   bool sizeUsingPixels,
 158                   wxFontFamily family,
 159                   wxFontStyle style,
 160                   wxFontWeight weight,
 161                   bool underlined = false,
 162                   const wxString& face = wxEmptyString,
 163                   wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 164
 165     virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info);
 166
 167     // implement wxObject virtuals which are used by AllocExclusive()
 168     virtual wxGDIRefData *CreateGDIRefData() const;
 169     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 170
 171 private:
 172     DECLARE_DYNAMIC_CLASS(wxFont)
 173 };
 174
 175 #endif // _WX_FONT_H_