]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk/dnd.h
Added wxTreeCtrl::SetItemDropHighlight (wxMSW only);
[wxWidgets.git] / include / wx / gtk / dnd.h
index e10c9e7c764868d31b179d6191a95d6ccffababf..dc0a2d850dda8bd2aa7fe4624304eaffa63ac5d7 100644 (file)
 #endif
 
 #include "wx/defs.h"
+
+#if wxUSE_DRAG_AND_DROP
+
 #include "wx/object.h"
 #include "wx/string.h"
+#include "wx/dataobj.h"
 #include "wx/cursor.h"
+#include "wx/icon.h"
+#include "wx/gdicmn.h"
+
+//-------------------------------------------------------------------------
+// conditional compilation
+//-------------------------------------------------------------------------
+
+#if (GTK_MINOR_VERSION == 1)
+#if (GTK_MICRO_VERSION >= 3)
+#define NEW_GTK_DND_CODE
+#endif
+#endif
 
 //-------------------------------------------------------------------------
 // classes
 
 class wxWindow;
 
-class wxDataObject;
-class wxTextDataObject;
-class wxFileDataObject;
-
 class wxDropTarget;
 class wxTextDropTarget;
 class wxFileDropTarget;
+class wxPrivateDropTarget;
 
 class wxDropSource;
 
-//-------------------------------------------------------------------------
-// wxDataObject
-//-------------------------------------------------------------------------
-
-class wxDataObject: public wxObject
-{
-public:
-
-  wxDataObject() {};
-  ~wxDataObject() {};
-
-  virtual wxDataFormat GetPreferredFormat() const = 0;
-  virtual bool IsSupportedFormat( wxDataFormat format ) const = 0;
-  virtual size_t GetDataSize() const = 0;
-  virtual void GetDataHere( void *data ) const = 0;
-
-};
-
-// ----------------------------------------------------------------------------
-// wxTextDataObject is a specialization of wxDataObject for text data
-// ----------------------------------------------------------------------------
-
-class wxTextDataObject : public wxDataObject
-{
-public:
-
-  wxTextDataObject() { }
-  wxTextDataObject(const wxString& strText) : m_strText(strText) { }
-  void Init(const wxString& strText) { m_strText = strText; }
-
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_TEXT; }
-    
-  virtual bool IsSupportedFormat(wxDataFormat format) const
-    { return format == wxDF_TEXT; }
-
-  virtual size_t GetDataSize() const
-    { return m_strText.Len() + 1; } // +1 for trailing '\0'
-    
-  virtual void GetDataHere( void *data ) const
-    { memcpy(data, m_strText.c_str(), GetDataSize()); }
-
-private:
-  wxString  m_strText;
-  
-};
-
-// ----------------------------------------------------------------------------
-// wxFileDataObject is a specialization of wxDataObject for file names
-// ----------------------------------------------------------------------------
-
-class wxFileDataObject : public wxDataObject
-{
-public:
-
-  wxFileDataObject(void) { }
-  void AddFile( const wxString &file )
-    { m_files += file; m_files += '\0'; }
-
-  virtual wxDataFormat GetPreferredFormat() const
-    { return wxDF_FILENAME; }
-    
-  virtual bool IsSupportedFormat( wxDataFormat format ) const
-    { return format == wxDF_FILENAME; }
-    
-  virtual size_t GetDataSize() const
-    { return m_files.Len(); } // no trailing '\0'
-    
-  virtual void GetDataHere( void *data ) const
-    { memcpy(data, m_files.c_str(), GetDataSize()); }
-
-private:
-  wxString  m_files;
-  
-};
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
@@ -124,17 +62,20 @@ class wxDropTarget: public wxObject
     
     virtual void OnEnter() { }
     virtual void OnLeave() { }
+    virtual void OnMouseMove( long WXUNUSED(x), long WXUNUSED(y) ) { }
     virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0;
 
     // Override these to indicate what kind of data you support: 
   
     virtual size_t GetFormatCount() const = 0;
-    virtual wxDataFormat GetFormat(size_t n) const = 0;
+    virtual wxDataFormat &GetFormat(size_t n) const;
   
   // implementation
   
     void RegisterWidget( GtkWidget *widget );
     void UnregisterWidget( GtkWidget *widget );
+    
+    wxDataFormat  *m_format;
 };
 
 //-------------------------------------------------------------------------
@@ -145,25 +86,53 @@ class wxTextDropTarget: public wxDropTarget
 {
   public:
 
-    wxTextDropTarget() {};
+    wxTextDropTarget();
     virtual bool OnDrop( long x, long y, const void *data, size_t size );
     virtual bool OnDropText( long x, long y, const char *psz );
     
   protected:
   
     virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
 };
 
-// ----------------------------------------------------------------------------
+//-------------------------------------------------------------------------
+// wxPrivateDropTarget
+//-------------------------------------------------------------------------
+
+class wxPrivateDropTarget: public wxDropTarget
+{
+public:
+
+  wxPrivateDropTarget();
+  
+  // you have to override OnDrop to get at the data
+    
+  // the string ID identifies the format of clipboard or DnD data. a word
+  // processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+  // to the clipboard - the latter with the Id "application/wxword" or
+  // "image/png".
+    
+  void SetId( const wxString& id );
+    
+  wxString GetId()
+      { return m_id; }
+
+private:
+
+  virtual size_t GetFormatCount() const;
+    
+  wxString   m_id;
+};
+
+//----------------------------------------------------------------------------
 // A drop target which accepts files (dragged from File Manager or Explorer)
-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------
 
 class wxFileDropTarget: public wxDropTarget
 {
   public:
     
-    wxFileDropTarget() {};
+    wxFileDropTarget();
     
     virtual bool OnDrop( long x, long y, const void *data, size_t size );
     virtual bool OnDropFiles( long x, long y, 
@@ -172,7 +141,6 @@ class wxFileDropTarget: public wxDropTarget
   protected:
   
     virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
 };
 
 //-------------------------------------------------------------------------
@@ -184,7 +152,7 @@ enum wxDragResult
   wxDragError,    // error prevented the d&d operation from completing
   wxDragNone,     // drag target didn't accept the data
   wxDragCopy,     // the data was successfully copied
-  wxDragMove,     // the data was successfully moved
+  wxDragMove,     // the data was successfully moved (MSW only)
   wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
@@ -192,17 +160,30 @@ class wxDropSource: public wxObject
 {
   public:
 
-    wxDropSource( wxWindow *win );
-    wxDropSource( wxDataObject &data, wxWindow *win );
+    /* constructor. set data later with SetData() */
+    wxDropSource( wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
+    
+    /* constructor for setting one data object */
+    wxDropSource( wxDataObject *data, wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
+    
+    /* constructor for setting several data objects via wxDataBroker */
+    wxDropSource( wxDataBroker *data, wxWindow *win );
     
     ~wxDropSource(void);
     
-    void SetData( wxDataObject &data  );
+    /* set one dataobject */
+    void SetData( wxDataBroker *data );
+    
+    /* set severa dataobjects via wxDataBroker */
+    void SetData( wxDataObject *data );
+    
+    /* start drag action */
     wxDragResult DoDragDrop( bool bAllowMove = FALSE );
     
-    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; };
+    /* override to give feedback */
+    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }
   
-  // implementation
+  /* GTK implementation */
       
     void RegisterWindow(void);
     void UnregisterWindow(void);
@@ -210,12 +191,19 @@ class wxDropSource: public wxObject
     GtkWidget     *m_widget;
     wxWindow      *m_window;
     wxDragResult   m_retValue;
-    wxDataObject  *m_data;
+    wxDataBroker  *m_data;
     
     wxCursor      m_defaultCursor;
     wxCursor      m_goaheadCursor;
+    
+    wxIcon        m_goIcon;
+    wxIcon        m_stopIcon;
 };
 
+#endif
+
+   // wxUSE_DRAG_AND_DROP
+
 #endif  
        //__GTKDNDH__