Extend history api using the ie backend to include loading history items, and getting...

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

diff --git a/include/wx/dataobj.h b/include/wx/dataobj.h
index 6c7c1d0d01e3ddba101ed1b6f89051bb43ea9f9e..d255a5064c9e297826a79e737a5036aa1deddb55 100644 (file)
--- a/include/wx/dataobj.h
+++ b/include/wx/dataobj.h
@@ -55,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);


@@ -67,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);

 };
 
 */
 };
 
 */


@@ -83,7 +83,7 @@ public:
 #elif defined(__WXX11__)
     #include "wx/x11/dataform.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXX11__)
     #include "wx/x11/dataform.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/dataform.h"
+    #include "wx/osx/dataform.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/dataform.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/dataform.h"
 #elif defined(__WXPM__)


@@ -92,7 +92,7 @@ public:
 
 // the value for default argument to some functions (corresponds to
 // wxDF_INVALID)
 
 // the value for default argument to some functions (corresponds to
 // wxDF_INVALID)

-extern WXDLLEXPORT const wxDataFormat& wxFormatInvalid;
+extern WXDLLIMPEXP_CORE const wxDataFormat& wxFormatInvalid;

 
 // ----------------------------------------------------------------------------
 // wxDataObject represents a piece of data which knows which formats it
 
 // ----------------------------------------------------------------------------
 // wxDataObject represents a piece of data which knows which formats it


@@ -114,7 +114,7 @@ extern WXDLLEXPORT const wxDataFormat& wxFormatInvalid;
 // to be supported by SetData() or GetDataHere().
 // ----------------------------------------------------------------------------
 
 // to be supported by SetData() or GetDataHere().
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDataObjectBase
+class WXDLLIMPEXP_CORE wxDataObjectBase

 {
 public:
     enum Direction
 {
 public:
     enum Direction


@@ -171,7 +171,7 @@ public:
 #elif defined(__WXGTK__)
     #include "wx/gtk1/dataobj.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXGTK__)
     #include "wx/gtk1/dataobj.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/dataobj.h"
+    #include "wx/osx/dataobj.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/dataobj.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/dataobj.h"
 #elif defined(__WXPM__)


@@ -194,7 +194,7 @@ public:
 // Otherwise, you should use wxDataObjectComposite or wxDataObject directly.
 // ----------------------------------------------------------------------------
 
 // Otherwise, you should use wxDataObjectComposite or wxDataObject directly.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDataObjectSimple : public wxDataObject
+class WXDLLIMPEXP_CORE wxDataObjectSimple : public wxDataObject

 {
 public:
     // ctor takes the format we support, but it can also be set later with
 {
 public:
     // ctor takes the format we support, but it can also be set later with


@@ -246,7 +246,7 @@ private:
     // the one and only format we support
     wxDataFormat m_format;
 
     // the one and only format we support
     wxDataFormat m_format;
 

-    DECLARE_NO_COPY_CLASS(wxDataObjectSimple)
+    wxDECLARE_NO_COPY_CLASS(wxDataObjectSimple);

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


@@ -261,7 +261,7 @@ private:
 
 WX_DECLARE_EXPORTED_LIST(wxDataObjectSimple, wxSimpleDataObjectList);
 
 
 WX_DECLARE_EXPORTED_LIST(wxDataObjectSimple, wxSimpleDataObjectList);
 

-class WXDLLEXPORT wxDataObjectComposite : public wxDataObject
+class WXDLLIMPEXP_CORE wxDataObjectComposite : public wxDataObject

 {
 public:
     // ctor
 {
 public:
     // ctor


@@ -273,6 +273,18 @@ public:
     // 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 received data from
+    // the clipboard or the DnD operation.  You can use this method to find
+    // out what kind of data object was received.
+    wxDataFormat GetReceivedFormat() const;
+
+    // Returns the pointer to the object which supports this format or NULL.
+    // The returned pointer is owned by wxDataObjectComposite and must
+    // therefore not be destroyed by the caller.
+    wxDataObjectSimple *GetObject(const wxDataFormat& format,
+                                  wxDataObjectBase::Direction dir = Get) const;
+

     // implement base class pure virtuals
     // ----------------------------------
     virtual wxDataFormat GetPreferredFormat(wxDataObjectBase::Direction dir = Get) const;
     // implement base class pure virtuals
     // ----------------------------------
     virtual wxDataFormat GetPreferredFormat(wxDataObjectBase::Direction dir = Get) const;


@@ -289,10 +301,6 @@ public:
     virtual size_t GetBufferOffset( const wxDataFormat& format );
 #endif
 
     virtual size_t GetBufferOffset( const wxDataFormat& format );
 #endif
 

-protected:
-    // returns the pointer to the object which supports this format or NULL
-    wxDataObjectSimple *GetObject(const wxDataFormat& format) const;
-

 private:
     // the list of all (simple) data objects whose formats we support
     wxSimpleDataObjectList m_dataObjects;
 private:
     // the list of all (simple) data objects whose formats we support
     wxSimpleDataObjectList m_dataObjects;


@@ -301,7 +309,9 @@ private:
     // one is the preferred)
     size_t m_preferred;
 
     // one is the preferred)
     size_t m_preferred;
 

-    DECLARE_NO_COPY_CLASS(wxDataObjectComposite)
+    wxDataFormat m_receivedFormat;
+
+    wxDECLARE_NO_COPY_CLASS(wxDataObjectComposite);

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


@@ -316,7 +326,15 @@ private:
 // wxTextDataObject contains text data
 // ----------------------------------------------------------------------------
 
 // wxTextDataObject contains text data
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTextDataObject : public wxDataObjectSimple
+#if wxUSE_UNICODE
+    #if defined(__WXGTK20__)
+        #define wxNEEDS_UTF8_FOR_TEXT_DATAOBJ
+    #elif defined(__WXMAC__)
+        #define wxNEEDS_UTF16_FOR_TEXT_DATAOBJ
+    #endif
+#endif // wxUSE_UNICODE
+
+class WXDLLIMPEXP_CORE wxTextDataObject : public wxDataObjectSimple

 {
 public:
     // ctor: you can specify the text here or in SetText(), or override
 {
 public:
     // ctor: you can specify the text here or in SetText(), or override


@@ -343,7 +361,7 @@ public:
     // ----------------------------------
 
     // some platforms have 2 and not 1 format for text data
     // ----------------------------------
 
     // some platforms have 2 and not 1 format for text data

-#if wxUSE_UNICODE && (defined(__WXGTK20__) || defined(__WXMAC__))
+#if defined(wxNEEDS_UTF8_FOR_TEXT_DATAOBJ) || defined(wxNEEDS_UTF16_FOR_TEXT_DATAOBJ)

     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 GetFormatCount(Direction WXUNUSED(dir) = Get) const { return 2; }
     virtual void GetAllFormats(wxDataFormat *formats,
                                wxDataObjectBase::Direction WXUNUSED(dir) = Get) const;


@@ -355,7 +373,7 @@ public:
     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);
     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
+#else // !wxNEEDS_UTF{8,16}_FOR_TEXT_DATAOBJ

     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);


@@ -372,19 +390,19 @@ public:
     {
         return SetData(len, buf);
     }
     {
         return SetData(len, buf);
     }

-#endif
+#endif // different wxTextDataObject implementations

 
 private:
     wxString m_text;
 
 
 private:
     wxString m_text;
 

-    DECLARE_NO_COPY_CLASS(wxTextDataObject)
+    wxDECLARE_NO_COPY_CLASS(wxTextDataObject);

 };
 
 // ----------------------------------------------------------------------------
 // wxBitmapDataObject contains a bitmap
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // wxBitmapDataObject contains a bitmap
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBitmapDataObjectBase : public wxDataObjectSimple
+class WXDLLIMPEXP_CORE wxBitmapDataObjectBase : public wxDataObjectSimple

 {
 public:
     // ctor: you can specify the bitmap here or in SetBitmap(), or override
 {
 public:
     // ctor: you can specify the bitmap here or in SetBitmap(), or override


@@ -402,7 +420,7 @@ public:
 protected:
     wxBitmap m_bitmap;
 
 protected:
     wxBitmap m_bitmap;
 

-    DECLARE_NO_COPY_CLASS(wxBitmapDataObjectBase)
+    wxDECLARE_NO_COPY_CLASS(wxBitmapDataObjectBase);

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


@@ -412,7 +430,7 @@ protected:
 //     data from drag and drop operation.
 // ----------------------------------------------------------------------------
 
 //     data from drag and drop operation.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFileDataObjectBase : public wxDataObjectSimple
+class WXDLLIMPEXP_CORE wxFileDataObjectBase : public wxDataObjectSimple

 {
 public:
     // ctor: use AddFile() later to fill the array
 {
 public:
     // ctor: use AddFile() later to fill the array


@@ -424,7 +442,7 @@ public:
 protected:
     wxArrayString m_filenames;
 
 protected:
     wxArrayString m_filenames;
 

-    DECLARE_NO_COPY_CLASS(wxFileDataObjectBase)
+    wxDECLARE_NO_COPY_CLASS(wxFileDataObjectBase);

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


@@ -433,7 +451,7 @@ protected:
 // It is understood that this data can be copied bitwise.
 // ----------------------------------------------------------------------------
 
 // It is understood that this data can be copied bitwise.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCustomDataObject : public wxDataObjectSimple
+class WXDLLIMPEXP_CORE wxCustomDataObject : public wxDataObjectSimple

 {
 public:
     // if you don't specify the format in the ctor, you can still use
 {
 public:
     // if you don't specify the format in the ctor, you can still use


@@ -485,7 +503,7 @@ private:
     size_t m_size;
     void  *m_data;
 
     size_t m_size;
     void  *m_data;
 

-    DECLARE_NO_COPY_CLASS(wxCustomDataObject)
+    wxDECLARE_NO_COPY_CLASS(wxCustomDataObject);

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


@@ -494,19 +512,20 @@ private:
 
 #if defined(__WXMSW__)
     #include "wx/msw/ole/dataobj2.h"
 
 #if defined(__WXMSW__)
     #include "wx/msw/ole/dataobj2.h"

-

     // wxURLDataObject defined in msw/ole/dataobj2.h
     // wxURLDataObject defined in msw/ole/dataobj2.h

-#else // !__WXMSW__
-    #if defined(__WXGTK20__)
-        #include "wx/gtk/dataobj2.h"
-    #elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
+    #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/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"
+        #include "wx/osx/dataobj2.h"

     #elif defined(__WXCOCOA__)
         #include "wx/cocoa/dataobj2.h"
     #elif defined(__WXPM__)
     #elif defined(__WXCOCOA__)
         #include "wx/cocoa/dataobj2.h"
     #elif defined(__WXPM__)


@@ -514,13 +533,18 @@ private:
     #endif
 
     // wxURLDataObject is simply wxTextDataObject with a different name
     #endif
 
     // wxURLDataObject is simply wxTextDataObject with a different name

-    class WXDLLEXPORT wxURLDataObject : public wxTextDataObject
+    class WXDLLIMPEXP_CORE wxURLDataObject : public wxTextDataObject

     {
     public:
     {
     public:

+        wxURLDataObject(const wxString& url = wxEmptyString)
+            : wxTextDataObject(url)
+        {
+        }
+

         wxString GetURL() const { return GetText(); }
         void SetURL(const wxString& url) { SetText(url); }
     };
         wxString GetURL() const { return GetText(); }
         void SetURL(const wxString& url) { SetText(url); }
     };

-#endif // __WXMSW__/!__WXMSW__
+#endif

 
 #endif // wxUSE_DATAOBJ
 
 
 #endif // wxUSE_DATAOBJ