include/wx/msw/enhmeta.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/enhmeta.h
   3 // Purpose:     wxEnhMetaFile class for Win32
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     13.01.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSW_ENHMETA_H_
  13 #define _WX_MSW_ENHMETA_H_
  14
  15 #include "wx/dc.h"
  16 #include "wx/gdiobj.h"
  17
  18 #if wxUSE_DRAG_AND_DROP
  19     #include "wx/dataobj.h"
  20 #endif
  21
  22 // ----------------------------------------------------------------------------
  23 // wxEnhMetaFile: encapsulation of Win32 HENHMETAFILE
  24 // ----------------------------------------------------------------------------
  25
  26 class WXDLLIMPEXP_CORE wxEnhMetaFile : public wxGDIObject
  27 {
  28 public:
  29     wxEnhMetaFile(const wxString& file = wxEmptyString) : m_filename(file)
  30         { Init(); }
  31     wxEnhMetaFile(const wxEnhMetaFile& metafile) : wxGDIObject()
  32         { Init(); Assign(metafile); }
  33     wxEnhMetaFile& operator=(const wxEnhMetaFile& metafile)
  34         { Free(); Assign(metafile); return *this; }
  35
  36     virtual ~wxEnhMetaFile()
  37         { Free(); }
  38
  39     // display the picture stored in the metafile on the given DC
  40     bool Play(wxDC *dc, wxRect *rectBound = NULL);
  41
  42     // accessors
  43     virtual bool IsOk() const { return m_hMF != 0; }
  44
  45     wxSize GetSize() const;
  46     int GetWidth() const { return GetSize().x; }
  47     int GetHeight() const { return GetSize().y; }
  48
  49     const wxString& GetFileName() const { return m_filename; }
  50
  51     // copy the metafile to the clipboard: the width and height parameters are
  52     // for backwards compatibility (with wxMetaFile) only, they are ignored by
  53     // this method
  54     bool SetClipboard(int width = 0, int height = 0);
  55
  56     // implementation
  57     WXHANDLE GetHENHMETAFILE() const { return m_hMF; }
  58     void SetHENHMETAFILE(WXHANDLE hMF) { Free(); m_hMF = hMF; }
  59
  60 protected:
  61     void Init();
  62     void Free();
  63     void Assign(const wxEnhMetaFile& mf);
  64
  65     // we don't use these functions (but probably should) but have to implement
  66     // them as they're pure virtual in the base class
  67     virtual wxGDIRefData *CreateGDIRefData() const;
  68     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
  69
  70 private:
  71     wxString m_filename;
  72     WXHANDLE m_hMF;
  73
  74     DECLARE_DYNAMIC_CLASS(wxEnhMetaFile)
  75 };
  76
  77 // ----------------------------------------------------------------------------
  78 // wxEnhMetaFileDC: allows to create a wxEnhMetaFile
  79 // ----------------------------------------------------------------------------
  80
  81 class WXDLLIMPEXP_CORE wxEnhMetaFileDC : public wxDC
  82 {
  83 public:
  84     // the ctor parameters specify the filename (empty for memory metafiles),
  85     // the metafile picture size and the optional description/comment
  86     wxEnhMetaFileDC(const wxString& filename = wxEmptyString,
  87                     int width = 0, int height = 0,
  88                     const wxString& description = wxEmptyString);
  89
  90     // obtain a pointer to the new metafile (caller should delete it)
  91     wxEnhMetaFile *Close();
  92
  93 private:
  94     DECLARE_DYNAMIC_CLASS_NO_COPY(wxEnhMetaFileDC)
  95 };
  96
  97 #if wxUSE_DRAG_AND_DROP
  98
  99 // ----------------------------------------------------------------------------
 100 // wxEnhMetaFileDataObject is a specialization of wxDataObject for enh metafile
 101 // ----------------------------------------------------------------------------
 102
 103 // notice that we want to support both CF_METAFILEPICT and CF_ENHMETAFILE and
 104 // so we derive from wxDataObject and not from wxDataObjectSimple
 105 class WXDLLIMPEXP_CORE wxEnhMetaFileDataObject : public wxDataObject
 106 {
 107 public:
 108     // ctors
 109     wxEnhMetaFileDataObject() { }
 110     wxEnhMetaFileDataObject(const wxEnhMetaFile& metafile)
 111         : m_metafile(metafile) { }
 112
 113     // virtual functions which you may override if you want to provide data on
 114     // demand only - otherwise, the trivial default versions will be used
 115     virtual void SetMetafile(const wxEnhMetaFile& metafile)
 116         { m_metafile = metafile; }
 117     virtual wxEnhMetaFile GetMetafile() const
 118         { return m_metafile; }
 119
 120     // implement base class pure virtuals
 121     virtual wxDataFormat GetPreferredFormat(Direction dir) const;
 122     virtual size_t GetFormatCount(Direction dir) const;
 123     virtual void GetAllFormats(wxDataFormat *formats, Direction dir) const;
 124     virtual size_t GetDataSize(const wxDataFormat& format) const;
 125     virtual bool GetDataHere(const wxDataFormat& format, void *buf) const;
 126     virtual bool SetData(const wxDataFormat& format, size_t len,
 127                          const void *buf);
 128
 129 protected:
 130     wxEnhMetaFile m_metafile;
 131
 132     DECLARE_NO_COPY_CLASS(wxEnhMetaFileDataObject)
 133 };
 134
 135
 136 // ----------------------------------------------------------------------------
 137 // wxEnhMetaFileSimpleDataObject does derive from wxDataObjectSimple which
 138 // makes it more convenient to use (it can be used with wxDataObjectComposite)
 139 // at the price of not supoprting any more CF_METAFILEPICT but only
 140 // CF_ENHMETAFILE
 141 // ----------------------------------------------------------------------------
 142
 143 class WXDLLIMPEXP_CORE wxEnhMetaFileSimpleDataObject : public wxDataObjectSimple
 144 {
 145 public:
 146     // ctors
 147     wxEnhMetaFileSimpleDataObject() : wxDataObjectSimple(wxDF_ENHMETAFILE) { }
 148     wxEnhMetaFileSimpleDataObject(const wxEnhMetaFile& metafile)
 149         : wxDataObjectSimple(wxDF_ENHMETAFILE), m_metafile(metafile) { }
 150
 151     // virtual functions which you may override if you want to provide data on
 152     // demand only - otherwise, the trivial default versions will be used
 153     virtual void SetEnhMetafile(const wxEnhMetaFile& metafile)
 154         { m_metafile = metafile; }
 155     virtual wxEnhMetaFile GetEnhMetafile() const
 156         { return m_metafile; }
 157
 158     // implement base class pure virtuals
 159     virtual size_t GetDataSize() const;
 160     virtual bool GetDataHere(void *buf) const;
 161     virtual bool SetData(size_t len, const void *buf);
 162
 163     virtual size_t GetDataSize(const wxDataFormat& WXUNUSED(format)) const
 164         { return GetDataSize(); }
 165     virtual bool GetDataHere(const wxDataFormat& WXUNUSED(format),
 166                              void *buf) const
 167         { return GetDataHere(buf); }
 168     virtual bool SetData(const wxDataFormat& WXUNUSED(format),
 169                          size_t len, const void *buf)
 170         { return SetData(len, buf); }
 171
 172 protected:
 173     wxEnhMetaFile m_metafile;
 174
 175     DECLARE_NO_COPY_CLASS(wxEnhMetaFileSimpleDataObject)
 176 };
 177
 178 #endif // wxUSE_DRAG_AND_DROP
 179
 180 #endif // _WX_MSW_ENHMETA_H_