include/wx/msw/ole/dataobj.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/ole/dataobj.h
   3 // Purpose:     declaration of the wxDataObject class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     10.05.98
   7 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef   _WX_MSW_OLE_DATAOBJ_H
  12 #define   _WX_MSW_OLE_DATAOBJ_H
  13
  14 // ----------------------------------------------------------------------------
  15 // forward declarations
  16 // ----------------------------------------------------------------------------
  17
  18 struct IDataObject;
  19
  20 // ----------------------------------------------------------------------------
  21 // wxDataObject is a "smart" and polymorphic piece of data.
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLIMPEXP_CORE wxDataObject : public wxDataObjectBase
  25 {
  26 public:
  27     // ctor & dtor
  28     wxDataObject();
  29     virtual ~wxDataObject();
  30
  31     // retrieve IDataObject interface (for other OLE related classes)
  32     IDataObject *GetInterface() const { return m_pIDataObject; }
  33
  34     // tell the object that it should be now owned by IDataObject - i.e. when
  35     // it is deleted, it should delete us as well
  36     void SetAutoDelete();
  37
  38     // return true if we support this format in "Get" direction
  39     bool IsSupportedFormat(const wxDataFormat& format) const
  40         { return wxDataObjectBase::IsSupported(format, Get); }
  41
  42     // if this method returns false, this wxDataObject will be copied to
  43     // the clipboard with its size prepended to it, which is compatible with
  44     // older wx versions
  45     //
  46     // if returns true, then this wxDataObject will be copied to the clipboard
  47     // without any additional information and ::HeapSize() function will be used
  48     // to get the size of that data
  49     virtual bool NeedsVerbatimData(const wxDataFormat& WXUNUSED(format)) const
  50     {
  51         // return false from here only for compatibility with earlier wx versions
  52         return true;
  53     }
  54
  55     // function to return symbolic name of clipboard format (for debug messages)
  56 #ifdef __WXDEBUG__
  57     static const wxChar *GetFormatName(wxDataFormat format);
  58
  59     #define wxGetFormatName(format) wxDataObject::GetFormatName(format)
  60 #else // !Debug
  61     #define wxGetFormatName(format) wxT("")
  62 #endif // Debug/!Debug
  63     // they need to be accessed from wxIDataObject, so made them public,
  64     // or wxIDataObject friend
  65 public:
  66     virtual const void* GetSizeFromBuffer( const void* buffer, size_t* size,
  67                                            const wxDataFormat& format );
  68     virtual void* SetSizeInBuffer( void* buffer, size_t size,
  69                                    const wxDataFormat& format );
  70     virtual size_t GetBufferOffset( const wxDataFormat& format );
  71
  72 private:
  73     IDataObject *m_pIDataObject; // pointer to the COM interface
  74
  75     wxDECLARE_NO_COPY_CLASS(wxDataObject);
  76 };
  77
  78 #endif  //_WX_MSW_OLE_DATAOBJ_H