decouple item index from string value (patch 1905702)

[wxWidgets.git] / include / wx / dataobj.h

diff --git a/include/wx/dataobj.h b/include/wx/dataobj.h
index 572b4f12d216eb7cc9b04824e379b23d83db45ef..04fbee454f0fff610a2d22fe6390794067189ed2 100644 (file)
--- a/include/wx/dataobj.h
+++ b/include/wx/dataobj.h
@@ -5,25 +5,24 @@
 // Modified by:
 // Created:     26.05.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     26.05.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows Team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets Team
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DATAOBJ_H_BASE_
 #define _WX_DATAOBJ_H_BASE_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DATAOBJ_H_BASE_
 #define _WX_DATAOBJ_H_BASE_
 

-#ifdef __GNUG__
-    #pragma interface "dataobjbase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

-

 #include "wx/defs.h"
 #include "wx/defs.h"

+
+#if wxUSE_DATAOBJ
+

 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/list.h"

+#include "wx/arrstr.h"

 
 // ============================================================================
 /*
 
 // ============================================================================
 /*


@@ -56,7 +55,7 @@ public:
     typedef <integral type> NativeFormat;
 
     wxDataFormat(NativeFormat format = wxDF_INVALID);
     typedef <integral type> NativeFormat;
 
     wxDataFormat(NativeFormat format = wxDF_INVALID);

-    wxDataFormat(const wxChar *format);
+    wxDataFormat(const wxString& format);

 
     wxDataFormat& operator=(NativeFormat format);
     wxDataFormat& operator=(const wxDataFormat& format);
 
     wxDataFormat& operator=(NativeFormat format);
     wxDataFormat& operator=(const wxDataFormat& format);


@@ -68,7 +67,7 @@ public:
     NativeFormat GetType() const;
 
     wxString GetId() const;
     NativeFormat GetType() const;
 
     wxString GetId() const;

-    void SetId(const wxChar *format);
+    void SetId(const wxString& format);

 };
 
 */
 };
 
 */


@@ -77,10 +76,24 @@ public:
     #include "wx/msw/ole/dataform.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dataform.h"
     #include "wx/msw/ole/dataform.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dataform.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dataform.h"
     #include "wx/gtk/dataform.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/dataform.h"
+#elif defined(__WXX11__)
+    #include "wx/x11/dataform.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/dataform.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/dataform.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/dataform.h"

 #endif
 
 #endif
 

+// the value for default argument to some functions (corresponds to
+// wxDF_INVALID)
+extern WXDLLEXPORT const wxDataFormat& wxFormatInvalid;
+

 // ----------------------------------------------------------------------------
 // wxDataObject represents a piece of data which knows which formats it
 // supports and knows how to render itself in each of them - GetDataHere(),
 // ----------------------------------------------------------------------------
 // wxDataObject represents a piece of data which knows which formats it
 // supports and knows how to render itself in each of them - GetDataHere(),


@@ -128,16 +141,19 @@ public:
     virtual size_t GetDataSize(const wxDataFormat& format) const = 0;
 
     // copy raw data (in the specified format) to the provided buffer, return
     virtual size_t GetDataSize(const wxDataFormat& format) const = 0;
 
     // copy raw data (in the specified format) to the provided buffer, return

-    // TRUE if data copied successfully, FALSE otherwise
+    // true if data copied successfully, false otherwise

     virtual bool GetDataHere(const wxDataFormat& format, void *buf) const = 0;
 
     // get data from the buffer of specified length (in the given format),
     virtual bool GetDataHere(const wxDataFormat& format, void *buf) const = 0;
 
     // get data from the buffer of specified length (in the given format),

-    // return TRUE if the data was read successfully, FALSE otherwise
-    virtual bool SetData(const wxDataFormat& format,
-                         size_t len, const void *buf)
+    // return true if the data was read successfully, false otherwise
+    virtual bool SetData(const wxDataFormat& WXUNUSED(format),
+                         size_t WXUNUSED(len), const void * WXUNUSED(buf))

     {
     {

-        return FALSE;
+        return false;

     }
     }

+
+    // returns true if this format is supported
+    bool IsSupported(const wxDataFormat& format, Direction dir = Get) const;

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -148,21 +164,23 @@ public:
     #include "wx/msw/ole/dataobj.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dataobj.h"
     #include "wx/msw/ole/dataobj.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dataobj.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXX11__)
+    #include "wx/x11/dataobj.h"
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dataobj.h"
     #include "wx/gtk/dataobj.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/dnd.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/dataobj.h"

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

-    #include "wx/mac/dnd.h"
+    #include "wx/mac/dataobj.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/dataobj.h"

 #elif defined(__WXPM__)
 #elif defined(__WXPM__)

-    #include "wx/os2/dnd.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/dnd.h"
+    #include "wx/os2/dataobj.h"

 #endif
 
 // ----------------------------------------------------------------------------
 // wxDataObjectSimple is a wxDataObject which only supports one format (in
 #endif
 
 // ----------------------------------------------------------------------------
 // wxDataObjectSimple is a wxDataObject which only supports one format (in

-// both Get and Set directions, but you may return FALSE from GetDataHere() or
+// both Get and Set directions, but you may return false from GetDataHere() or

 // SetData() if one of them is not supported). This is the simplest possible
 // wxDataObject implementation.
 //
 // SetData() if one of them is not supported). This is the simplest possible
 // wxDataObject implementation.
 //


@@ -181,7 +199,7 @@ class WXDLLEXPORT wxDataObjectSimple : public wxDataObject
 public:
     // ctor takes the format we support, but it can also be set later with
     // SetFormat()
 public:
     // ctor takes the format we support, but it can also be set later with
     // SetFormat()

-    wxDataObjectSimple(const wxDataFormat& format = wxDF_INVALID)
+    wxDataObjectSimple(const wxDataFormat& format = wxFormatInvalid)

         : m_format(format)
         {
         }
         : m_format(format)
         {
         }


@@ -200,20 +218,20 @@ public:
 
     // copy our data to the buffer
     virtual bool GetDataHere(void *WXUNUSED(buf)) const
 
     // copy our data to the buffer
     virtual bool GetDataHere(void *WXUNUSED(buf)) const

-        { return FALSE; }
+        { return false; }

 
     // copy data from buffer to our data
 
     // copy data from buffer to our data

-    virtual bool SetData(size_t len, const void *WXUNUSED(buf))
-        { return FALSE; }
+    virtual bool SetData(size_t WXUNUSED(len), const void *WXUNUSED(buf))
+        { return false; }

 
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------

-    virtual wxDataFormat GetPreferredFormat(Direction WXUNUSED(dir) = Get) const
+    virtual wxDataFormat GetPreferredFormat(wxDataObjectBase::Direction WXUNUSED(dir) = Get) const

         { return m_format; }
         { return m_format; }

-    virtual size_t GetFormatCount(Direction WXUNUSED(dir) = Get) const
+    virtual size_t GetFormatCount(wxDataObjectBase::Direction WXUNUSED(dir) = Get) const

         { return 1; }
     virtual void GetAllFormats(wxDataFormat *formats,
         { return 1; }
     virtual void GetAllFormats(wxDataFormat *formats,

-                               Direction WXUNUSED(dir) = Get) const
+                               wxDataObjectBase::Direction WXUNUSED(dir) = Get) const

         { *formats = m_format; }
     virtual size_t GetDataSize(const wxDataFormat& WXUNUSED(format)) const
         { return GetDataSize(); }
         { *formats = m_format; }
     virtual size_t GetDataSize(const wxDataFormat& WXUNUSED(format)) const
         { return GetDataSize(); }


@@ -227,6 +245,8 @@ public:
 private:
     // the one and only format we support
     wxDataFormat m_format;
 private:
     // the one and only format we support
     wxDataFormat m_format;

+
+    DECLARE_NO_COPY_CLASS(wxDataObjectSimple)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -239,27 +259,41 @@ private:
 // wxDataObject directly.
 // ----------------------------------------------------------------------------
 
 // wxDataObject directly.
 // ----------------------------------------------------------------------------
 

-WX_DECLARE_LIST(wxDataObjectSimple, wxSimpleDataObjectList);
+WX_DECLARE_EXPORTED_LIST(wxDataObjectSimple, wxSimpleDataObjectList);

 
 class WXDLLEXPORT wxDataObjectComposite : public wxDataObject
 {
 public:
     // ctor
 
 class WXDLLEXPORT wxDataObjectComposite : public wxDataObject
 {
 public:
     // ctor

-    wxDataObjectComposite() { m_preferred = 0; }
+    wxDataObjectComposite();
+    virtual ~wxDataObjectComposite();

 
     // add data object (it will be deleted by wxDataObjectComposite, hence it
     // must be allocated on the heap) whose format will become the preferred
 
     // add data object (it will be deleted by wxDataObjectComposite, hence it
     // must be allocated on the heap) whose format will become the preferred

-    // one if preferred == TRUE
-    void Add(wxDataObjectSimple *dataObject, bool preferred = FALSE);
+    // one if preferred == true
+    void Add(wxDataObjectSimple *dataObject, bool preferred = false);
+
+    // Report the format passed to the SetData method.  This should be the
+    // format of the data object within the composite that recieved data from
+    // the clipboard or the DnD operation.  You can use this method to find
+    // out what kind of data object was recieved.
+    wxDataFormat GetReceivedFormat() const;

 
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------

-    virtual wxDataFormat GetPreferredFormat(Direction dir = Get) const;
-    virtual size_t GetFormatCount(Direction dir = Get) const;
-    virtual void GetAllFormats(wxDataFormat *formats, Direction dir = Get) const;
+    virtual wxDataFormat GetPreferredFormat(wxDataObjectBase::Direction dir = Get) const;
+    virtual size_t GetFormatCount(wxDataObjectBase::Direction dir = Get) const;
+    virtual void GetAllFormats(wxDataFormat *formats, wxDataObjectBase::Direction dir = Get) const;

     virtual size_t GetDataSize(const wxDataFormat& format) const;
     virtual bool GetDataHere(const wxDataFormat& format, void *buf) const;
     virtual bool SetData(const wxDataFormat& format, size_t len, const void *buf);
     virtual size_t GetDataSize(const wxDataFormat& format) const;
     virtual bool GetDataHere(const wxDataFormat& format, void *buf) const;
     virtual bool SetData(const wxDataFormat& format, size_t len, const void *buf);

+#if defined(__WXMSW__)
+    virtual const void* GetSizeFromBuffer( const void* buffer, size_t* size,
+                                           const wxDataFormat& format );
+    virtual void* SetSizeInBuffer( void* buffer, size_t size,
+                                   const wxDataFormat& format );
+    virtual size_t GetBufferOffset( const wxDataFormat& format );
+#endif

 
 protected:
     // returns the pointer to the object which supports this format or NULL
 
 protected:
     // returns the pointer to the object which supports this format or NULL


@@ -272,6 +306,10 @@ private:
     // the index of the preferred one (0 initially, so by default the first
     // one is the preferred)
     size_t m_preferred;
     // the index of the preferred one (0 initially, so by default the first
     // one is the preferred)
     size_t m_preferred;

+
+    wxDataFormat m_receivedFormat;
+
+    DECLARE_NO_COPY_CLASS(wxDataObjectComposite)

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -292,7 +330,14 @@ public:
     // ctor: you can specify the text here or in SetText(), or override
     // GetText()
     wxTextDataObject(const wxString& text = wxEmptyString)
     // ctor: you can specify the text here or in SetText(), or override
     // GetText()
     wxTextDataObject(const wxString& text = wxEmptyString)

-        : wxDataObjectSimple(wxDF_TEXT), m_text(text)
+        : wxDataObjectSimple(
+#if wxUSE_UNICODE
+                             wxDF_UNICODETEXT
+#else
+                             wxDF_TEXT
+#endif
+                            ),
+          m_text(text)

         {
         }
 
         {
         }
 


@@ -304,12 +349,43 @@ public:
 
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------

+
+    // some platforms have 2 and not 1 format for text data
+#if wxUSE_UNICODE && (defined(__WXGTK20__) || defined(__WXMAC__))
+    virtual size_t GetFormatCount(Direction WXUNUSED(dir) = Get) const { return 2; }
+    virtual void GetAllFormats(wxDataFormat *formats,
+                               wxDataObjectBase::Direction WXUNUSED(dir) = Get) const;
+
+    virtual size_t GetDataSize() const { return GetDataSize(GetPreferredFormat()); }
+    virtual bool GetDataHere(void *buf) const { return GetDataHere(GetPreferredFormat(), buf); }
+    virtual bool SetData(size_t len, const void *buf) { return SetData(GetPreferredFormat(), len, buf); }
+
+    size_t GetDataSize(const wxDataFormat& format) const;
+    bool GetDataHere(const wxDataFormat& format, void *pBuf) const;
+    bool SetData(const wxDataFormat& format, size_t nLen, const void* pBuf);
+#else

     virtual size_t GetDataSize() const;
     virtual bool GetDataHere(void *buf) const;
     virtual bool SetData(size_t len, const void *buf);
     virtual size_t GetDataSize() const;
     virtual bool GetDataHere(void *buf) const;
     virtual bool SetData(size_t len, const void *buf);

+    // Must provide overloads to avoid hiding them (and warnings about it)
+    virtual size_t GetDataSize(const wxDataFormat&) const
+    {
+        return GetDataSize();
+    }
+    virtual bool GetDataHere(const wxDataFormat&, void *buf) const
+    {
+        return GetDataHere(buf);
+    }
+    virtual bool SetData(const wxDataFormat&, size_t len, const void *buf)
+    {
+        return SetData(len, buf);
+    }
+#endif

 
 private:
     wxString m_text;
 
 private:
     wxString m_text;

+
+    DECLARE_NO_COPY_CLASS(wxTextDataObject)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -331,8 +407,10 @@ public:
     virtual wxBitmap GetBitmap() const { return m_bitmap; }
     virtual void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
 
     virtual wxBitmap GetBitmap() const { return m_bitmap; }
     virtual void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
 

-private:
+protected:

     wxBitmap m_bitmap;
     wxBitmap m_bitmap;

+
+    DECLARE_NO_COPY_CLASS(wxBitmapDataObjectBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -349,14 +427,12 @@ public:
     wxFileDataObjectBase() : wxDataObjectSimple(wxDF_FILENAME) { }
 
     // get a reference to our array
     wxFileDataObjectBase() : wxDataObjectSimple(wxDF_FILENAME) { }
 
     // get a reference to our array

-    const wxArrayString& GetFilenames() { return m_filenames; }
-
-    // the Get() functions do nothing for us
-    virtual size_t GetDataSize() const { return 0; }
-    virtual bool GetDataHere(void *WXUNUSED(buf)) const { return FALSE; }
+    const wxArrayString& GetFilenames() const { return m_filenames; }

 
 protected:
     wxArrayString m_filenames;
 
 protected:
     wxArrayString m_filenames;

+
+    DECLARE_NO_COPY_CLASS(wxFileDataObjectBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -370,7 +446,7 @@ class WXDLLEXPORT wxCustomDataObject : public wxDataObjectSimple
 public:
     // if you don't specify the format in the ctor, you can still use
     // SetFormat() later
 public:
     // if you don't specify the format in the ctor, you can still use
     // SetFormat() later

-    wxCustomDataObject(const wxDataFormat& format = wxDF_INVALID);
+    wxCustomDataObject(const wxDataFormat& format = wxFormatInvalid);

 
     // the dtor calls Free()
     virtual ~wxCustomDataObject();
 
     // the dtor calls Free()
     virtual ~wxCustomDataObject();


@@ -399,10 +475,25 @@ public:
     virtual size_t GetDataSize() const;
     virtual bool GetDataHere(void *buf) const;
     virtual bool SetData(size_t size, const void *buf);
     virtual size_t GetDataSize() const;
     virtual bool GetDataHere(void *buf) const;
     virtual bool SetData(size_t size, const void *buf);

+    // Must provide overloads to avoid hiding them (and warnings about it)
+    virtual size_t GetDataSize(const wxDataFormat&) const
+    {
+        return GetDataSize();
+    }
+    virtual bool GetDataHere(const wxDataFormat&, void *buf) const
+    {
+        return GetDataHere(buf);
+    }
+    virtual bool SetData(const wxDataFormat&, size_t len, const void *buf)
+    {
+        return SetData(len, buf);
+    }

 
 private:
     size_t m_size;
     void  *m_data;
 
 private:
     size_t m_size;
     void  *m_data;

+
+    DECLARE_NO_COPY_CLASS(wxCustomDataObject)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -411,10 +502,40 @@ private:
 
 #if defined(__WXMSW__)
     #include "wx/msw/ole/dataobj2.h"
 
 #if defined(__WXMSW__)
     #include "wx/msw/ole/dataobj2.h"

-#elif defined(__WXMOTIF__)
-    #include "wx/motif/dataobj2.h"
-#elif defined(__WXGTK__)
+    // wxURLDataObject defined in msw/ole/dataobj2.h
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dataobj2.h"
     #include "wx/gtk/dataobj2.h"

+    // wxURLDataObject defined in msw/ole/dataobj2.h
+
+#else 
+    #if defined(__WXGTK__)
+        #include "wx/gtk1/dataobj2.h"
+    #elif defined(__WXX11__)
+        #include "wx/x11/dataobj2.h"
+    #elif defined(__WXMOTIF__)
+        #include "wx/motif/dataobj2.h"
+    #elif defined(__WXMAC__)
+        #include "wx/mac/dataobj2.h"
+    #elif defined(__WXCOCOA__)
+        #include "wx/cocoa/dataobj2.h"
+    #elif defined(__WXPM__)
+        #include "wx/os2/dataobj2.h"
+    #endif
+
+    // wxURLDataObject is simply wxTextDataObject with a different name
+    class WXDLLEXPORT wxURLDataObject : public wxTextDataObject
+    {
+    public:
+        wxURLDataObject(const wxString& url = wxEmptyString)
+            : wxTextDataObject(url)
+        {
+        }
+
+        wxString GetURL() const { return GetText(); }
+        void SetURL(const wxString& url) { SetText(url); }
+    };

 #endif
 
 #endif
 

+#endif // wxUSE_DATAOBJ
+

 #endif // _WX_DATAOBJ_H_BASE_
 #endif // _WX_DATAOBJ_H_BASE_