Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / osx / font.h

diff --git a/include/wx/osx/font.h b/include/wx/osx/font.h
index 0d449c9c2d37d2d05fda41b4b6d05ce702b32b39..d5e277f979c0b0e86c09bcf215a736f9a9f3c390 100644 (file)
--- a/include/wx/osx/font.h
+++ b/include/wx/osx/font.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        font.h
+// Name:        wx/osx/font.h
 // Purpose:     wxFont class
 // Author:      Julian Smart
 // Modified by:
@@ -37,6 +37,26 @@ public:
     // ctors and such
     wxFont() { }
 
+    wxFont(const wxFontInfo& info)
+    {
+        Create(info.GetPointSize(),
+               info.GetFamily(),
+               info.GetStyle(),
+               info.GetWeight(),
+               info.IsUnderlined(),
+               info.GetFaceName(),
+               info.GetEncoding());
+
+        if ( info.IsUsingSizeInPixels() )
+            SetPixelSize(info.GetPixelSize());
+    }
+
+    wxFont( wxOSXSystemFont systemFont );
+
+#if wxOSX_USE_COCOA
+    wxFont(WX_NSFont nsfont);
+#endif
+
 #if FUTURE_WXWIN_COMPATIBILITY_3_0
     wxFont(int size,
            int family,
@@ -60,7 +80,7 @@ public:
     {
         Create(size, family, style, weight, underlined, face, encoding);
     }
-    
+
     wxFont(const wxSize& pixelSize,
            wxFontFamily family,
            wxFontStyle style,
@@ -72,7 +92,7 @@ public:
         Create(10, family, style, weight, underlined, face, encoding);
         SetPixelSize(pixelSize);
     }
-    
+
     bool Create(int size,
                 wxFontFamily family,
                 wxFontStyle style,
@@ -90,14 +110,11 @@ public:
 
     bool Create(const wxNativeFontInfo& info);
 
-    bool CreateSystemFont(wxOSXSystemFont font);
-    
     virtual ~wxFont();
 
     // implement base class pure virtuals
     virtual int GetPointSize() const;
     virtual wxSize GetPixelSize() const;
-    virtual wxFontFamily GetFamily() const;
     virtual wxFontStyle GetStyle() const;
     virtual wxFontWeight GetWeight() const;
     virtual bool GetUnderlined() const;
@@ -105,6 +122,8 @@ public:
     virtual wxFontEncoding GetEncoding() const;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
 
+    virtual bool IsFixedWidth() const;
+
     virtual void SetPointSize(int pointSize);
     virtual void SetFamily(wxFontFamily family);
     virtual void SetStyle(wxFontStyle style);
@@ -113,51 +132,57 @@ public:
     virtual void SetUnderlined(bool underlined);
     virtual void SetEncoding(wxFontEncoding encoding);
 
-    WXDECLARE_COMPAT_SETTERS
+    wxDECLARE_COMMON_FONT_METHODS();
 
     // implementation only from now on
     // -------------------------------
 
     virtual bool RealizeResource();
 
-    // Unofficial API, don't use
-    virtual void SetNoAntiAliasing( bool noAA = TRUE ) ;
-    virtual bool GetNoAntiAliasing() const  ;
-
     // Mac-specific, risks to change, don't use in portable code
 
 #if wxOSX_USE_CARBON && wxOSX_USE_ATSU_TEXT
     wxUint16 MacGetThemeFontID() const ;
+
     // 'old' Quickdraw accessors
     short MacGetFontNum() const;
     wxByte  MacGetFontStyle() const;
 #endif
 
 #if wxOSX_USE_COCOA_OR_CARBON
-    CGFontRef GetCGFont() const;
+    CGFontRef OSXGetCGFont() const;
 #endif
 
 #if wxOSX_USE_CORE_TEXT
-    CTFontRef GetCTFont() const;
+    CTFontRef OSXGetCTFont() const;
 #endif
 
 #if wxOSX_USE_ATSU_TEXT
     // Returns an ATSUStyle not ATSUStyle*
     void* MacGetATSUStyle() const ;
+    void* OSXGetATSUStyle() const { return MacGetATSUStyle() ; }
+
+    wxDEPRECATED( wxUint32 MacGetATSUFontID() const );
+    wxDEPRECATED( wxUint32 MacGetATSUAdditionalQDStyles() const );
 #endif
 
 #if wxOSX_USE_COCOA
-    WX_NSFont GetNSFont() const;
-    static WX_NSFont CreateNSFont(wxOSXSystemFont font, wxNativeFontInfo* info);
-    static WX_NSFont CreateNSFont(const wxNativeFontInfo* info);
+    WX_NSFont OSXGetNSFont() const;
+    static WX_NSFont OSXCreateNSFont(wxOSXSystemFont font, wxNativeFontInfo* info);
+    static WX_NSFont OSXCreateNSFont(const wxNativeFontInfo* info);
+    static void SetNativeInfoFromNSFont(WX_NSFont nsfont, wxNativeFontInfo* info);
 #endif
 
 #if wxOSX_USE_IPHONE
-    WX_UIFont GetUIFont() const;
-    static WX_NSFont CreateUIFont(wxOSXSystemFont font, wxNativeFontInfo* info);
+    WX_UIFont OSXGetUIFont() const;
+    static WX_UIFont OSXCreateUIFont(wxOSXSystemFont font, wxNativeFontInfo* info);
+    static WX_UIFont OSXCreateUIFont(const wxNativeFontInfo* info);
 #endif
 
 protected:
+    virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info);
+    virtual wxFontFamily DoGetFamily() const;
+
     virtual wxGDIRefData *CreateGDIRefData() const;
     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;