Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/os2/metafile.h b/include/wx/os2/metafile.h
index 55cf236972eeb66682f38e541bd3e766c7be9630..99b81113b55b57a016702fdb3c0b93ecffb1a4ac 100644 (file)
--- a/include/wx/os2/metafile.h
+++ b/include/wx/os2/metafile.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        metafile.h
+// Name:        wx/os2/metafile.h
 // Purpose:     wxMetaFile, wxMetaFileDC classes.
 //              This probably should be restricted to Windows platforms,
 //              but if there is an equivalent on your platform, great.
@@ -17,6 +17,7 @@
 
 #include "wx/dc.h"
 #include "wx/gdiobj.h"
+#include "wx/os2/dc.h"
 
 #if wxUSE_DRAG_AND_DROP
 #include "wx/dataobj.h"
@@ -32,13 +33,15 @@
 
 class WXDLLIMPEXP_FWD_CORE wxMetafile;
 
-class WXDLLEXPORT wxMetafileRefData: public wxGDIRefData
+class WXDLLIMPEXP_CORE wxMetafileRefData: public wxGDIRefData
 {
     friend class WXDLLIMPEXP_FWD_CORE wxMetafile;
 public:
     wxMetafileRefData(void);
     virtual ~wxMetafileRefData(void);
 
+    virtual bool IsOk() const { return m_metafile != 0; }
+
 public:
     WXHANDLE m_metafile;
     int m_windowsMappingMode;
@@ -46,7 +49,7 @@ public:
 
 #define M_METAFILEDATA ((wxMetafileRefData *)m_refData)
 
-class WXDLLEXPORT wxMetafile: public wxGDIObject
+class WXDLLIMPEXP_CORE wxMetafile: public wxGDIObject
 {
     DECLARE_DYNAMIC_CLASS(wxMetafile)
 public:
@@ -58,61 +61,82 @@ public:
     virtual bool SetClipboard(int width = 0, int height = 0);
 
     virtual bool Play(wxDC *dc);
-    inline bool Ok() const { return IsOk(); }
-    inline bool IsOk(void) const { return (M_METAFILEDATA && (M_METAFILEDATA->m_metafile != 0)); };
 
     // Implementation
     inline WXHANDLE GetHMETAFILE(void) { return M_METAFILEDATA->m_metafile; }
     void SetHMETAFILE(WXHANDLE mf) ;
     inline int GetWindowsMappingMode(void) { return M_METAFILEDATA->m_windowsMappingMode; }
     void SetWindowsMappingMode(int mm);
+
+protected:
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 };
 
-class WXDLLEXPORT wxMetafileDC: public wxDC
+class WXDLLIMPEXP_CORE wxMetafileDCImpl: public wxPMDCImpl
 {
-    DECLARE_DYNAMIC_CLASS(wxMetafileDC)
+public:
+    wxMetafileDCImpl(wxDC *owner, const wxString& file = wxEmptyString);
+    wxMetafileDCImpl(wxDC *owner, const wxString& file,
+                     int xext, int yext, int xorg, int yorg);
+    virtual ~wxMetafileDCImpl();
+
+    virtual wxMetafile *Close();
+    virtual void SetMapMode(wxMappingMode mode);
+    virtual void DoGetTextExtent(const wxString& string,
+                                 wxCoord *x, wxCoord *y,
+                                 wxCoord *descent = NULL,
+                                 wxCoord *externalLeading = NULL,
+                                 const wxFont *theFont = NULL) const;
+
+    // Implementation
+    wxMetafile *GetMetaFile() const { return m_metaFile; }
+    void SetMetaFile(wxMetafile *mf) { m_metaFile = mf; }
+    int GetWindowsMappingMode() const { return m_windowsMappingMode; }
+    void SetWindowsMappingMode(int mm) { m_windowsMappingMode = mm; }
+
+protected:
+    virtual void DoGetSize(int *width, int *height) const;
+
+    int           m_windowsMappingMode;
+    wxMetafile*   m_metaFile;
 
+private:
+    DECLARE_CLASS(wxMetafileDCImpl)
+    wxDECLARE_NO_COPY_CLASS(wxMetafileDCImpl);
+};
+
+class WXDLLIMPEXP_CORE wxMetafileDC: public wxDC
+{
 public:
     // Don't supply origin and extent
     // Supply them to wxMakeMetaFilePlaceable instead.
-    wxMetafileDC(const wxString& file = wxEmptyString);
+    wxMetafileDC(const wxString& file = wxEmptyString)
+         :wxDC(new wxMetafileDCImpl( this, file ))
+         { }
 
     // Supply origin and extent (recommended).
     // Then don't need to supply them to wxMakeMetaFilePlaceable.
-    wxMetafileDC(const wxString& file, int xext, int yext, int xorg, int yorg);
+    wxMetafileDC(const wxString& file, int xext, int yext, int xorg, int yorg)
+        : wxDC(new wxMetafileDCImpl( this, file, xext, yext, xorg, yorg ))
+         { }
 
-    virtual ~wxMetafileDC(void);
+    wxMetafile *GetMetafile() const
+        { return ((wxMetafileDCImpl*)m_pimpl)->GetMetaFile(); }
 
-    // Should be called at end of drawing
-    virtual wxMetafile *Close(void);
-    virtual void SetMapMode(int mode);
-    virtual void GetTextExtent(const wxString& string, long *x, long *y,
-                               long *descent = NULL, long *externalLeading = NULL,
-                               const wxFont *theFont = NULL, bool use16bit = false) const;
+    virtual ~wxMetafileDC(void)
+        { delete m_pimpl; }
 
-    // Implementation
-    inline wxMetafile *GetMetaFile(void) const { return m_metaFile; }
-    inline void SetMetaFile(wxMetafile *mf) { m_metaFile = mf; }
-    inline int GetWindowsMappingMode(void) const { return m_windowsMappingMode; }
-    inline void SetWindowsMappingMode(int mm) { m_windowsMappingMode = mm; }
+    // Should be called at end of drawing
+    virtual wxMetafile *Close(void)
+        { return ((wxMetafileDCImpl*)m_pimpl)->Close(); }
 
-protected:
-    int           m_windowsMappingMode;
-    wxMetafile*   m_metaFile;
+    inline void SetMetaFile(wxMetafile *mf)
+        { ((wxMetafileDCImpl*)m_pimpl)->SetMetaFile(mf); }
 
 private:
-#ifndef __WATCOMC__
-    // function hiding warning supression
-    // still required ??
-    inline virtual void   GetTextExtent( const wxString& string
-                                        ,long*           width
-                                        ,long*           height
-                                        ,long*           descent = NULL
-                                        ,long*           externalLeading = NULL
-                                        ,wxFont*         theFont = NULL
-                                       ) const
-    { GetTextExtent( string, width, height, descent, externalLeading, theFont, false);};
-#endif
+    DECLARE_CLASS(wxMetafileDC)
+    wxDECLARE_NO_COPY_CLASS(wxMetafileDC);
 };
 
 /*
@@ -124,10 +148,10 @@ private:
 
 // No origin or extent
 #define wxMakeMetaFilePlaceable wxMakeMetafilePlaceable
-bool WXDLLEXPORT wxMakeMetafilePlaceable(const wxString& filename, float scale = 1.0);
+bool WXDLLIMPEXP_CORE wxMakeMetafilePlaceable(const wxString& filename, float scale = 1.0);
 
 // Optional origin and extent
-bool WXDLLEXPORT wxMakeMetaFilePlaceable( const wxString& filename
+bool WXDLLIMPEXP_CORE wxMakeMetaFilePlaceable( const wxString& filename
                                          ,int x1
                                          ,int y1
                                          ,int x2
@@ -144,11 +168,11 @@ bool WXDLLEXPORT wxMakeMetaFilePlaceable( const wxString& filename
 // use.
 
 #if wxUSE_DRAG_AND_DROP
-class WXDLLEXPORT wxMetafileDataObject : public wxDataObject
+class WXDLLIMPEXP_CORE wxMetafileDataObject : public wxDataObject
 {
 public:
     // ctors
-    wxMetafileDataObject() { m_width = 0; m_height = 0; };
+    wxMetafileDataObject() { m_width = 0; m_height = 0; }
     wxMetafileDataObject(const wxMetafile& metafile, int width = 0,int height = 0)
                         :m_metafile(metafile)
                         ,m_width(width)