]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk/dnd.h
Implemented wxArrayString::Shrink() and stuff.
[wxWidgets.git] / include / wx / gtk / dnd.h
index ba56769328e0b20203e48f87839888bc479c4395..f57083b7db72c448d0bd2523b957f89423550beb 100644 (file)
 
 #include "wx/defs.h"
 
-#ifdef wxUSE_DRAG_AND_DROP
+#if wxUSE_DRAG_AND_DROP
 
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/dataobj.h"
 #include "wx/cursor.h"
-
-//-------------------------------------------------------------------------
-// conditional compilation
-//-------------------------------------------------------------------------
-
-#if (GTK_MINOR_VERSION == 1)
-#if (GTK_MICRO_VERSION >= 3)
-#define NEW_GTK_DND_CODE
-#endif
-#endif
+#include "wx/icon.h"
+#include "wx/gdicmn.h"
 
 //-------------------------------------------------------------------------
 // classes
@@ -43,9 +35,202 @@ class wxWindow;
 class wxDropTarget;
 class wxTextDropTarget;
 class wxFileDropTarget;
+class wxPrivateDropTarget;
 
 class wxDropSource;
 
+//-------------------------------------------------------------------------
+// wxDropSource
+//-------------------------------------------------------------------------
+
+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 (MSW only)
+  wxDragCancel    // the operation was cancelled by user (not an error)
+};
+
+class wxDropSource: public wxObject
+{
+public:
+
+  /* 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();
+    
+  /* set several dataobjects via wxDataBroker */
+  void SetData( wxDataBroker *data );
+
+  /* set one dataobject */
+  void SetData( wxDataObject *data );
+
+  /* start drag action */
+  wxDragResult DoDragDrop( bool bAllowMove = FALSE );
+    
+  /* override to give feedback */
+  virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }
+  
+  /* GTK implementation */
+      
+  void RegisterWindow();
+  void UnregisterWindow();
+  
+    GtkWidget     *m_widget;
+    wxWindow      *m_window;
+    wxDragResult   m_retValue;
+    wxDataBroker  *m_data;
+    
+    wxCursor      m_defaultCursor;
+    wxCursor      m_goaheadCursor;
+    
+    wxIcon        m_goIcon;
+    wxIcon        m_stopIcon;
+    
+    bool          m_waiting;
+};
+
+#include "gtk/gtk.h"
+#if (GTK_MINOR_VERSION > 0)
+
+//-------------------------------------------------------------------------
+// wxDropTarget
+//-------------------------------------------------------------------------
+
+class wxDropTarget: public wxObject
+{
+public:
+
+  wxDropTarget();
+  ~wxDropTarget();
+    
+  /* may be overridden to react to events */
+  virtual void OnEnter();
+  virtual void OnLeave();
+  
+  /* may be overridden to reject certain formats or drops
+     on certain areas. always returns TRUE by default
+     indicating that you'd accept the data from the drag. */
+  virtual bool OnMove( int x, int y );
+    
+  /* has to be overridden to accept a drop event. call 
+     IsSupported() to ask which formats are available
+     and then call RequestData() to indicate the format 
+     you request. */
+  virtual bool OnDrop( int x, int y );
+  
+  /* this gets called once the data has actually arrived. get
+     it with GetData(). this has to be overridden. */
+  virtual bool OnData( int x, int y );
+
+  /* called from within OnDrop() to request a certain format
+     from the drop event. */
+  bool RequestData( wxDataFormat format );
+
+  /* called to query what formats are available */
+  bool IsSupported( wxDataFormat format );
+  
+  /* fill data with data from the dragging source */
+  bool GetData( wxDataObject *data );
+
+// implementation
+  
+  void RegisterWidget( GtkWidget *widget );
+  void UnregisterWidget( GtkWidget *widget );
+    
+  GdkDragContext     *m_dragContext;
+  GtkWidget          *m_dragWidget;
+  GtkSelectionData   *m_dragData;
+  guint               m_dragTime;
+  bool                m_firstMotion;     /* gdk has no "gdk_drag_enter" event */
+    
+  void SetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
+  void SetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
+  void SetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
+  void SetDragTime( guint time ) { m_dragTime = time; }
+};
+
+//-------------------------------------------------------------------------
+// wxTextDropTarget
+//-------------------------------------------------------------------------
+
+class wxTextDropTarget: public wxDropTarget
+{
+public:
+
+  wxTextDropTarget() {}
+
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
+  virtual bool OnData( int x, int y );
+    
+  /* you have to override OnDropData to get at the text */
+  virtual bool OnDropText( int x, int y, const char *text ) = 0;
+    
+};
+
+//-------------------------------------------------------------------------
+// wxPrivateDropTarget
+//-------------------------------------------------------------------------
+
+class wxPrivateDropTarget: public wxDropTarget
+{
+public:
+
+  /* sets id to "application/myprogram" where "myprogram" is the
+     same as wxApp->GetAppName() */
+  wxPrivateDropTarget();
+  /* see SetId() below for explanation */
+  wxPrivateDropTarget( const wxString &id );
+  
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
+  virtual bool OnData( int x, int y );
+  
+  /* you have to override OnDropData to get at the data */
+  virtual bool OnDropData( int x, int y, void *data, size_t size ) = 0;
+    
+  /* 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 ) { m_id = id; }
+  wxString GetId() { return m_id; }
+      
+private:
+
+    wxString   m_id;
+};
+
+//----------------------------------------------------------------------------
+// A drop target which accepts files (dragged from File Manager or Explorer)
+//----------------------------------------------------------------------------
+
+class wxFileDropTarget: public wxDropTarget
+{
+public:
+    
+  wxFileDropTarget() {}
+    
+  virtual bool OnMove( int x, int y );
+  virtual bool OnDrop( int x, int y );
+  virtual bool OnData( int x, int y );
+  
+  /* you have to override OnDropFiles to get at the file names */
+  virtual bool OnDropFiles( int x, int y, size_t nFiles, const wxChar * const aszFiles[] ) = 0;
+
+};
+
+#else
+
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
@@ -59,17 +244,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;
 };
 
 //-------------------------------------------------------------------------
@@ -80,25 +268,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, 
@@ -107,49 +323,10 @@ class wxFileDropTarget: public wxDropTarget
   protected:
   
     virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
-};
-
-//-------------------------------------------------------------------------
-// wxDropSource
-//-------------------------------------------------------------------------
-
-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
-  wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
-class wxDropSource: public wxObject
-{
-  public:
+#endif
 
-    wxDropSource( wxWindow *win );
-    wxDropSource( wxDataObject &data, wxWindow *win );
-    
-    ~wxDropSource(void);
-    
-    void SetData( wxDataObject &data  );
-    wxDragResult DoDragDrop( bool bAllowMove = FALSE );
-    
-    virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; };
-  
-  // implementation
-      
-    void RegisterWindow(void);
-    void UnregisterWindow(void);
-  
-    GtkWidget     *m_widget;
-    wxWindow      *m_window;
-    wxDragResult   m_retValue;
-    wxDataObject  *m_data;
-    
-    wxCursor      m_defaultCursor;
-    wxCursor      m_goaheadCursor;
-};
 
 #endif