Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/cocoa/font.h b/include/wx/cocoa/font.h
index c11e4e3e0134d8b883ccaa505ad4985bc8e88fce..9ea87d6c2f8e75f414afce34d2ab11e8903ded52 100644 (file)
--- a/include/wx/cocoa/font.h
+++ b/include/wx/cocoa/font.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        font.h
+// Name:        wx/cocoa/font.h

 // Purpose:     wxFont class
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxFont class
 // Author:      Julian Smart
 // Modified by:


@@ -38,8 +38,23 @@ public:
      */
     wxFont() { }
 
      */
     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());
+    }
+

     /*! @abstract   Platform-independent construction with individual properties
      */
     /*! @abstract   Platform-independent construction with individual properties
      */

+#if FUTURE_WXWIN_COMPATIBILITY_3_0

     wxFont(int size,
            int family,
            int style,
     wxFont(int size,
            int family,
            int style,


@@ -47,10 +62,33 @@ public:
            bool underlined = FALSE,
            const wxString& face = wxEmptyString,
            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
            bool underlined = FALSE,
            const wxString& face = wxEmptyString,
            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)

+    {
+        (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
+    }
+#endif
+    wxFont(int size,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = FALSE,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT)

     {
         (void)Create(size, family, style, weight, underlined, face, encoding);
     }
 
     {
         (void)Create(size, family, style, weight, underlined, face, encoding);
     }
 

+    wxFont(const wxSize& pixelSize,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = false,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
+    {
+        Create(10, family, style, weight, underlined, face, encoding);
+        SetPixelSize(pixelSize);
+    }
+

     /*! @abstract   Construction with opaque wxNativeFontInfo
      */
     wxFont(const wxNativeFontInfo& info)
     /*! @abstract   Construction with opaque wxNativeFontInfo
      */
     wxFont(const wxNativeFontInfo& info)


@@ -66,9 +104,9 @@ public:
     // NOTE: Copy c-tor and assignment from wxObject is fine
 
     bool Create(int size,
     // NOTE: Copy c-tor and assignment from wxObject is fine
 
     bool Create(int size,

-                int family,
-                int style,
-                int weight,
+                wxFontFamily family,
+                wxFontStyle style,
+                wxFontWeight weight,

                 bool underlined = FALSE,
                 const wxString& face = wxEmptyString,
                 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
                 bool underlined = FALSE,
                 const wxString& face = wxEmptyString,
                 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);


@@ -79,22 +117,23 @@ public:
 
     // implement base class pure virtuals
     virtual int GetPointSize() const;
 
     // implement base class pure virtuals
     virtual int GetPointSize() const;

-    virtual int GetFamily() const;
-    virtual int GetStyle() const;
-    virtual int GetWeight() const;
+    virtual wxFontStyle GetStyle() const;
+    virtual wxFontWeight GetWeight() const;

     virtual bool GetUnderlined() const;
     virtual wxString GetFaceName() const;
     virtual wxFontEncoding GetEncoding() const;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
 
     virtual void SetPointSize(int pointSize);
     virtual bool GetUnderlined() const;
     virtual wxString GetFaceName() const;
     virtual wxFontEncoding GetEncoding() const;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
 
     virtual void SetPointSize(int pointSize);

-    virtual void SetFamily(int family);
-    virtual void SetStyle(int style);
-    virtual void SetWeight(int weight);
+    virtual void SetFamily(wxFontFamily family);
+    virtual void SetStyle(wxFontStyle style);
+    virtual void SetWeight(wxFontWeight weight);

     virtual bool SetFaceName(const wxString& faceName);
     virtual void SetUnderlined(bool underlined);
     virtual void SetEncoding(wxFontEncoding encoding);
 
     virtual bool SetFaceName(const wxString& faceName);
     virtual void SetUnderlined(bool underlined);
     virtual void SetEncoding(wxFontEncoding encoding);
 

+    wxDECLARE_COMMON_FONT_METHODS();
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -123,6 +162,8 @@ protected:
     virtual wxGDIRefData *CreateGDIRefData() const;
     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 
     virtual wxGDIRefData *CreateGDIRefData() const;
     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 

+    virtual wxFontFamily DoGetFamily() const;
+

 private:
     DECLARE_DYNAMIC_CLASS(wxFont)
 };
 private:
     DECLARE_DYNAMIC_CLASS(wxFont)
 };