include/wx/mac/metafile.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        metafile.h
   3 // Purpose:     wxMetaFile, wxMetaFileDC classes.
   4 //              This probably should be restricted to Windows platforms,
   5 //              but if there is an equivalent on your platform, great.
   6 // Author:      Stefan Csomor
   7 // Modified by:
   8 // Created:     1998-01-01
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) Stefan Csomor
  11 // Licence:     wxWindows licence
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14
  15 #ifndef _WX_METAFIILE_H_
  16 #define _WX_METAFIILE_H_
  17
  18 #if wxUSE_METAFILE
  19 #include "wx/dc.h"
  20 #include "wx/gdiobj.h"
  21
  22 #if wxUSE_DATAOBJ
  23 #include "wx/dataobj.h"
  24 #endif
  25
  26 /*
  27  * Metafile and metafile device context classes
  28  *
  29  */
  30
  31 #define wxMetaFile wxMetafile
  32 #define wxMetaFileDC wxMetafileDC
  33
  34 class WXDLLEXPORT wxMetafile;
  35
  36 class WXDLLEXPORT wxMetafileRefData: public wxGDIRefData
  37 {
  38     friend class WXDLLEXPORT wxMetafile;
  39 public:
  40     wxMetafileRefData(void);
  41     ~wxMetafileRefData(void);
  42
  43 public:
  44     WXHMETAFILE m_metafile;
  45 };
  46
  47 #define M_METAFILEDATA ((wxMetafileRefData *)m_refData)
  48
  49 class WXDLLEXPORT wxMetafile: public wxGDIObject
  50 {
  51     DECLARE_DYNAMIC_CLASS(wxMetafile)
  52 public:
  53     // Copy constructor
  54     wxMetafile(const wxMetafile& metafile)
  55       : wxGDIObject()
  56     { Ref(metafile); }
  57
  58     wxMetafile(const wxString& file = wxEmptyString);
  59     ~wxMetafile(void);
  60
  61     // After this is called, the metafile cannot be used for anything
  62     // since it is now owned by the clipboard.
  63     virtual bool SetClipboard(int width = 0, int height = 0);
  64
  65     virtual bool Play(wxDC *dc);
  66     inline bool Ok(void) const { return (M_METAFILEDATA && (M_METAFILEDATA->m_metafile != 0)); };
  67
  68     wxSize GetSize() const;
  69     int GetWidth() const { return GetSize().x; }
  70     int GetHeight() const { return GetSize().y; }
  71
  72     // Implementation
  73     inline WXHMETAFILE GetHMETAFILE() const { return M_METAFILEDATA->m_metafile; }
  74     void SetHMETAFILE(WXHMETAFILE mf) ;
  75
  76     // Operators
  77     inline wxMetafile& operator = (const wxMetafile& metafile) { if (*this == metafile) return (*this); Ref(metafile); return *this; }
  78     inline bool operator == (const wxMetafile& metafile) { return m_refData == metafile.m_refData; }
  79     inline bool operator != (const wxMetafile& metafile) { return m_refData != metafile.m_refData; }
  80
  81 protected:
  82 };
  83
  84 class WXDLLEXPORT wxMetafileDC: public wxDC
  85 {
  86   DECLARE_DYNAMIC_CLASS(wxMetafileDC)
  87
  88  public:
  89     // the ctor parameters specify the filename (empty for memory metafiles),
  90     // the metafile picture size and the optional description/comment
  91     wxMetafileDC(const wxString& filename = wxEmptyString,
  92                     int width = 0, int height = 0,
  93                     const wxString& description = wxEmptyString);
  94
  95   ~wxMetafileDC(void);
  96
  97   // Should be called at end of drawing
  98   virtual wxMetafile *Close(void);
  99   virtual void DoGetSize(int *width, int *height) const ;
 100
 101   // Implementation
 102   inline wxMetafile *GetMetaFile(void) const { return m_metaFile; }
 103   inline void SetMetaFile(wxMetafile *mf) { m_metaFile = mf; }
 104
 105 protected:
 106   wxMetafile*   m_metaFile;
 107 };
 108
 109 /*
 110  * Pass filename of existing non-placeable metafile, and bounding box.
 111  * Adds a placeable metafile header, sets the mapping mode to anisotropic,
 112  * and sets the window origin and extent to mimic the wxMM_TEXT mapping mode.
 113  *
 114  */
 115
 116 // No origin or extent
 117 #define wxMakeMetaFilePlaceable wxMakeMetafilePlaceable
 118 bool WXDLLEXPORT wxMakeMetafilePlaceable(const wxString& filename, float scale = 1.0);
 119
 120 // Optional origin and extent
 121 bool WXDLLEXPORT wxMakeMetaFilePlaceable(const wxString& filename, int x1, int y1, int x2, int y2, float scale = 1.0, bool useOriginAndExtent = TRUE);
 122
 123 // ----------------------------------------------------------------------------
 124 // wxMetafileDataObject is a specialization of wxDataObject for metafile data
 125 // ----------------------------------------------------------------------------
 126
 127 #if wxUSE_DATAOBJ
 128 class WXDLLEXPORT wxMetafileDataObject : public wxDataObjectSimple
 129 {
 130 public:
 131   // ctors
 132   wxMetafileDataObject()
 133     : wxDataObjectSimple(wxDF_METAFILE) {  };
 134   wxMetafileDataObject(const wxMetafile& metafile)
 135     : wxDataObjectSimple(wxDF_METAFILE), m_metafile(metafile) { }
 136
 137     // virtual functions which you may override if you want to provide data on
 138     // demand only - otherwise, the trivial default versions will be used
 139     virtual void SetMetafile(const wxMetafile& metafile)
 140         { m_metafile = metafile; }
 141     virtual wxMetafile GetMetafile() const
 142         { return m_metafile; }
 143
 144     // implement base class pure virtuals
 145     virtual size_t GetDataSize() const;
 146     virtual bool GetDataHere(void *buf) const;
 147     virtual bool SetData(size_t len, const void *buf);
 148
 149     virtual size_t GetDataSize(const wxDataFormat& WXUNUSED(format)) const
 150         { return GetDataSize(); }
 151     virtual bool GetDataHere(const wxDataFormat& WXUNUSED(format),
 152                              void *buf) const
 153         { return GetDataHere(buf); }
 154     virtual bool SetData(const wxDataFormat& WXUNUSED(format),
 155                          size_t len, const void *buf)
 156         { return SetData(len, buf); }
 157 protected:
 158   wxMetafile   m_metafile;
 159 };
 160 #endif
 161
 162 #endif // wxUSE_METAFILE
 163
 164
 165 #endif
 166     // _WX_METAFIILE_H_