include/wx/cocoa/font.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 // ----------------------------------------------------------------------------
  16 // wxFont
  17 // ----------------------------------------------------------------------------
  18
  19 DECLARE_WXCOCOA_OBJC_CLASS(NSFont);
  20
  21 // Internal class that bridges us with code like wxSystemSettings
  22 class wxCocoaFontFactory;
  23 // We have c-tors/methods taking pointers of these
  24 class wxFontRefData;
  25
  26 /*! @discussion
  27     wxCocoa's implementation of wxFont is very incomplete.  In particular,
  28     a lot of work needs to be done on wxNativeFontInfo which is currently
  29     using the totally generic implementation.
  30
  31     See the documentation in src/cocoa/font.mm for more implementatoin details.
  32  */
  33 class WXDLLIMPEXP_CORE wxFont : public wxFontBase
  34 {
  35     friend class wxCocoaFontFactory;
  36 public:
  37     /*! @abstract   Default construction of invalid font for 2-step construct then Create process.
  38      */
  39     wxFont() { }
  40
  41     /*! @abstract   Platform-independent construction with individual properties
  42      */
  43 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  44     wxFont(int size,
  45            int family,
  46            int style,
  47            int weight,
  48            bool underlined = FALSE,
  49            const wxString& face = wxEmptyString,
  50            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  51     {
  52         (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
  53     }
  54 #endif
  55     wxFont(int size,
  56            wxFontFamily family,
  57            wxFontStyle style,
  58            wxFontWeight weight,
  59            bool underlined = FALSE,
  60            const wxString& face = wxEmptyString,
  61            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  62     {
  63         (void)Create(size, family, style, weight, underlined, face, encoding);
  64     }
  65
  66     wxFont(const wxSize& pixelSize,
  67            wxFontFamily family,
  68            wxFontStyle style,
  69            wxFontWeight weight,
  70            bool underlined = false,
  71            const wxString& face = wxEmptyString,
  72            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
  73     {
  74         Create(10, family, style, weight, underlined, face, encoding);
  75         SetPixelSize(pixelSize);
  76     }
  77
  78     /*! @abstract   Construction with opaque wxNativeFontInfo
  79      */
  80     wxFont(const wxNativeFontInfo& info)
  81     {
  82         (void)Create(info);
  83     }
  84
  85     /*! @abstract   Construction with platform-dependent font descriptor string.
  86         @param  fontDesc        Usually the result of wxNativeFontInfo::ToUserString()
  87      */
  88     wxFont(const wxString& fontDesc);
  89
  90     // NOTE: Copy c-tor and assignment from wxObject is fine
  91
  92     bool Create(int size,
  93                 wxFontFamily family,
  94                 wxFontStyle style,
  95                 wxFontWeight weight,
  96                 bool underlined = FALSE,
  97                 const wxString& face = wxEmptyString,
  98                 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
  99
 100     bool Create(const wxNativeFontInfo& info);
 101
 102     virtual ~wxFont();
 103
 104     // implement base class pure virtuals
 105     virtual int GetPointSize() const;
 106     virtual wxFontFamily GetFamily() const;
 107     virtual wxFontStyle GetStyle() const;
 108     virtual wxFontWeight GetWeight() const;
 109     virtual bool GetUnderlined() const;
 110     virtual wxString GetFaceName() const;
 111     virtual wxFontEncoding GetEncoding() const;
 112     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
 113
 114     virtual void SetPointSize(int pointSize);
 115     virtual void SetFamily(wxFontFamily family);
 116     virtual void SetStyle(wxFontStyle style);
 117     virtual void SetWeight(wxFontWeight weight);
 118     virtual bool SetFaceName(const wxString& faceName);
 119     virtual void SetUnderlined(bool underlined);
 120     virtual void SetEncoding(wxFontEncoding encoding);
 121
 122     WXDECLARE_COMPAT_SETTERS
 123
 124     // implementation only from now on
 125     // -------------------------------
 126
 127     /*! @abstract   Defined on some ports (not including this one) in wxGDIObject
 128         @discussion
 129         The intention here I suppose is to allow one to create a wxFont without yet
 130         creating the underlying native object.  There's no point not to create the
 131         NSFont immediately in wxCocoa so this is useless.
 132         This method came from the stub code copied in the early days of wxCocoa.
 133         FIXME(1): Remove this in trunk.  FIXME(2): Is it really a good idea for this to
 134         be part of the public API for wxGDIObject?
 135      */
 136     virtual bool RealizeResource();
 137
 138 protected:
 139     /*! @abstract   Internal constructor with ref data
 140         @discussion
 141         Takes ownership of @a refData.  That is, it is assumed that refData has either just been
 142         created using new (which initializes its m_refCount to 1) or if you are sharing a ref that
 143         you have called IncRef on it before passing it to this method.
 144      */
 145     explicit wxFont(wxFontRefData *refData)
 146     {   Create(refData); }
 147     bool Create(wxFontRefData *refData);
 148
 149     virtual wxGDIRefData *CreateGDIRefData() const;
 150     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 151
 152 private:
 153     DECLARE_DYNAMIC_CLASS(wxFont)
 154 };
 155
 156 #endif
 157     // _WX_FONT_H_