Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/os2/font.h b/include/wx/os2/font.h
index fc8c8e55560eb7f1915173d7d7be4773759933fe..e0eabda61f31e61f337ed3b57ca76077d48a230c 100644 (file)
--- a/include/wx/os2/font.h
+++ b/include/wx/os2/font.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxFont class
 // Author:      David Webster
 // Modified by:
 // Purpose:     wxFont class
 // Author:      David Webster
 // Modified by:


@@ -14,110 +14,143 @@
 
 #include "wx/gdiobj.h"
 #include "wx/os2/private.h"
 
 #include "wx/gdiobj.h"
 #include "wx/os2/private.h"

-#include "wx/fontutil.h"

 
 

-WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
+WXDLLIMPEXP_DATA_CORE(extern const wxChar*) wxEmptyString;

 
 // ----------------------------------------------------------------------------
 // wxFont
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxFont
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFont : public wxFontBase
+class WXDLLIMPEXP_CORE wxFont : public wxFontBase

 {
 public:
     // ctors and such
 {
 public:
     // ctors and such

-    wxFont() { Init(); }
-    wxFont(const wxFont& rFont) { Init(); Ref(rFont); }
-
-    wxFont( int             nSize
-           ,int             nFamily
-           ,int             nStyle
-           ,int             nWeight
-           ,bool            bUnderlined = FALSE
-           ,const wxString& rsFace = wxEmptyString
-           ,wxFontEncoding  vEncoding = wxFONTENCODING_DEFAULT
-          )
+    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());
+    }
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxFont(int size,
+           int family,
+           int style,
+           int weight,
+           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)

     {
     {

-        Init();
+        Create(size, family, style, weight, underlined, face, encoding);
+    }

 
 

-        (void)Create(nSize, nFamily, nStyle, nWeight, bUnderlined, rsFace, vEncoding);
+    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);

     }
 
     }
 

-    wxFont(const wxNativeFontInfo& rInfo)
+    bool Create(int size,
+                wxFontFamily family,
+                wxFontStyle style,
+                wxFontWeight weight,
+                bool underlined = false,
+                const wxString& face = wxEmptyString,
+                wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+
+    wxFont( const wxNativeFontInfo& rInfo
+           ,WXHFONT                 hFont = 0
+          )
+

     {
     {

-        Init();
-
-        (void)Create( rInfo.pointSize
-                     ,rInfo.family
-                     ,rInfo.style
-                     ,rInfo.weight
-                     ,rInfo.underlined
-                     ,rInfo.faceName
-                     ,rInfo.encoding
+        (void)Create( rInfo
+                     ,hFont

                     );
     }
 
                     );
     }
 

-    bool Create( int             nSize
-                ,int             nFamily
-                ,int             nStyle
-                ,int             nWeight
-                ,bool            bUnderlined = FALSE
-                ,const wxString& rsFace = wxEmptyString
-                ,wxFontEncoding  vEncoding = wxFONTENCODING_DEFAULT
+    wxFont(const wxString& rsFontDesc);
+
+    bool Create( const wxNativeFontInfo& rInfo
+                ,WXHFONT                 hFont = 0

                );
 
     virtual ~wxFont();
 
                );
 
     virtual ~wxFont();
 

-    //
-    // Assignment
-    //
-    wxFont& operator=(const wxFont& rFont);
-

     //
     // Implement base class pure virtuals
     //
     //
     // Implement base class pure virtuals
     //

-    virtual int            GetPointSize(void) const;
-    virtual int            GetFamily(void) const;
-    virtual int            GetStyle(void) const;
-    virtual int            GetWeight(void) const;
-    virtual bool           GetUnderlined(void) const;
-    virtual wxString       GetFaceName(void) const;
-    virtual wxFontEncoding GetEncoding(void) const;
-    virtual HPS            GetPS(void) const;
+    virtual int               GetPointSize(void) const;
+    virtual wxFontStyle GetStyle() const;
+    virtual wxFontWeight GetWeight() const;
+    virtual bool              GetUnderlined(void) const;
+    virtual wxString          GetFaceName(void) const;
+    virtual wxFontEncoding    GetEncoding(void) const;
+    virtual const wxNativeFontInfo* GetNativeFontInfo() const;

 
     virtual void SetPointSize(int nPointSize);
 
     virtual void SetPointSize(int nPointSize);

-    virtual void SetFamily(int nFamily);
-    virtual void SetStyle(int nStyle);
-    virtual void SetWeight(int nWeight);
-    virtual void SetFaceName(const wxString& rsFaceName);
+    virtual void SetFamily(wxFontFamily family);
+    virtual void SetStyle(wxFontStyle style);
+    virtual void SetWeight(wxFontWeight weight);
+    virtual bool SetFaceName(const wxString& rsFaceName);

     virtual void SetUnderlined(bool bUnderlined);
     virtual void SetEncoding(wxFontEncoding vEncoding);
     virtual void SetUnderlined(bool bUnderlined);
     virtual void SetEncoding(wxFontEncoding vEncoding);

-    virtual void SetPS(HPS hPS);
-    virtual void SetFM( PFONTMETRICS pFM
-                       ,int          nNumFonts
-                      );

 
 

+    wxDECLARE_COMMON_FONT_METHODS();
+
+    //
+    // For internal use only!
+    //
+    void SetPS(HPS hPS);
+    void SetFM( PFONTMETRICS pFM
+               ,int          nNumFonts
+              );

     //
     // Implementation only from now on
     // -------------------------------
     //
     //
     // Implementation only from now on
     // -------------------------------
     //

-    int              GetFontId(void) const;

     virtual bool     IsFree(void) const;
     virtual bool     RealizeResource(void);
     virtual bool     IsFree(void) const;
     virtual bool     RealizeResource(void);

-    virtual WXHANDLE GetResourceHandle(void);
-    virtual bool     FreeResource(bool bForce = FALSE);
+    virtual WXHANDLE GetResourceHandle(void) const;
+    virtual bool     FreeResource(bool bForce = false);

 
     WXHFONT GetHFONT(void) const;
 
     WXHFONT GetHFONT(void) const;

+

 protected:
 protected:

-    //
-    // Common part of all ctors
-    //
-    void Init(void);
-    void Unshare(void);
+    virtual void DoSetNativeFontInfo(const wxNativeFontInfo& rInfo);
+    virtual wxFontFamily DoGetFamily() const;

 
 

-private:
-    void OS2SelectMatchingFontByName(void);
+    // implement wxObject virtuals which are used by AllocExclusive()
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;

 
 

+private:

     DECLARE_DYNAMIC_CLASS(wxFont)
 }; // end of wxFont
 
     DECLARE_DYNAMIC_CLASS(wxFont)
 }; // end of wxFont