wxHTML classes description is now in alphabetical order

[wxWidgets.git] / include / wx / gtk1 / dnd.h

diff --git a/include/wx/gtk1/dnd.h b/include/wx/gtk1/dnd.h
index f980749d13c40e7bb8d939e0a90c6ee6f78f8734..2dba9cef4928a0c45912398bf4bf913eb1d04323 100644 (file)
--- a/include/wx/gtk1/dnd.h
+++ b/include/wx/gtk1/dnd.h
@@ -23,16 +23,8 @@
 #include "wx/string.h"
 #include "wx/dataobj.h"
 #include "wx/cursor.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
 
 //-------------------------------------------------------------------------
 // classes


@@ -53,24 +45,55 @@ class wxDropSource;
 
 class wxDropTarget: public wxObject
 {
 
 class wxDropTarget: public wxObject
 {

-  public:
+public:

 
 

-    wxDropTarget();
-    ~wxDropTarget();
+  wxDropTarget();
+  ~wxDropTarget();

     
     

-    virtual void OnEnter() { }
-    virtual void OnLeave() { }
-    virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0;
-
-    // Override these to indicate what kind of data you support: 
+  /* 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( long x, long 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( long x, long y );

   
   

-    virtual size_t GetFormatCount() const = 0;
-    virtual wxDataFormat GetFormat(size_t n) const = 0;
+  /* this gets called once the data has actually arrived. get
+     it with GetData(). this has to be overridden. */
+  virtual bool OnData( long x, long 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 );

   
   

-  // implementation
+  /* fill data with data from the dragging source */
+  bool GetData( wxDataObject *data );
+
+// implementation

   
   

-    void RegisterWidget( GtkWidget *widget );
-    void UnregisterWidget( GtkWidget *widget );
+  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; }

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


@@ -79,16 +102,17 @@ class wxDropTarget: public wxObject
 
 class wxTextDropTarget: public wxDropTarget
 {
 
 class wxTextDropTarget: public wxDropTarget
 {

-  public:
+public:

 
 

-    wxTextDropTarget() {};
-    virtual bool OnDrop( long x, long y, const void *data, size_t size );
-    virtual bool OnDropText( long x, long y, const char *psz );
+  wxTextDropTarget() {}
+
+  virtual bool OnMove( long x, long y );
+  virtual bool OnDrop( long x, long y );
+  virtual bool OnData( long x, long y );
+    
+  /* you have to override OnDropData to get at the text */
+  virtual bool OnDropText( long x, long y, const wxChar *text ) = 0;

     
     

-  protected:
-  
-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;

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


@@ -99,46 +123,48 @@ class wxPrivateDropTarget: public wxDropTarget
 {
 public:
 
 {
 public:
 

+  /* sets id to "application/myprogram" where "myprogram" is the
+     same as wxApp->GetAppName() */

   wxPrivateDropTarget();
   wxPrivateDropTarget();

+  /* see SetId() below for explanation */
+  wxPrivateDropTarget( const wxString &id );

   
   

-  // 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 "WXWORD_FORMAT".
-    
-  void SetId( const wxString& id )
-      { m_id = id; }
+  virtual bool OnMove( long x, long y );
+  virtual bool OnDrop( long x, long y );
+  virtual bool OnData( long x, long y );
+  
+  /* you have to override OnDropData to get at the data */
+  virtual bool OnDropData( long x, long y, void *data, size_t size ) = 0;

     
     

-  wxString GetId()
-      { return m_id; }
-
+  /* 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:
 
 private:
 

-  virtual size_t GetFormatCount() const;
-  virtual wxDataFormat GetFormat(size_t n) const;
-    
-  wxString   m_id;
+    wxString   m_id;

 };
 
 };
 

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 // A drop target which accepts files (dragged from File Manager or Explorer)
 // A drop target which accepts files (dragged from File Manager or Explorer)

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 class wxFileDropTarget: public wxDropTarget
 {
 
 class wxFileDropTarget: public wxDropTarget
 {

-  public:
+public:

     
     

-    wxFileDropTarget() {};
+  wxFileDropTarget() {}

     
     

-    virtual bool OnDrop( long x, long y, const void *data, size_t size );
-    virtual bool OnDropFiles( long x, long y, 
-                              size_t nFiles, const char * const aszFiles[] );
-
-  protected:
+  virtual bool OnMove( long x, long y );
+  virtual bool OnDrop( long x, long y );
+  virtual bool OnData( long x, long y );

   
   

-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
+  /* you have to override OnDropFiles to get at the file names */
+  virtual bool OnDropFiles( long x, long y, size_t nFiles, const wxChar * const aszFiles[] ) = 0;
+

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


@@ -150,36 +176,54 @@ 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
   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)
 };
 
 class wxDropSource: public wxObject
 {
   wxDragCancel    // the operation was cancelled by user (not an error)
 };
 
 class wxDropSource: public wxObject
 {

-  public:
+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 );

     
     

-    ~wxDropSource(void);
+  /* 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 SetData( wxDataObject &data  );
-    wxDragResult DoDragDrop( bool bAllowMove = FALSE );
+  /* set several dataobjects via wxDataBroker */
+  void SetData( wxDataBroker *data );
+
+  /* set one dataobject */
+  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);
+  void RegisterWindow();
+  void UnregisterWindow();

   
     GtkWidget     *m_widget;
     wxWindow      *m_window;
     wxDragResult   m_retValue;
   
     GtkWidget     *m_widget;
     wxWindow      *m_window;
     wxDragResult   m_retValue;

-    wxDataObject  *m_data;
+    wxDataBroker  *m_data;

     
     wxCursor      m_defaultCursor;
     wxCursor      m_goaheadCursor;
     
     wxCursor      m_defaultCursor;
     wxCursor      m_goaheadCursor;

+    
+    wxIcon        m_goIcon;
+    wxIcon        m_stopIcon;
+    
+    bool          m_waiting;

 };
 
 #endif
 };
 
 #endif