don't try to build shared library on platforms not supporting it

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

diff --git a/include/wx/gtk1/dnd.h b/include/wx/gtk1/dnd.h
index fa97fdc5cd9fcdcdd6d176b73249fcf2ce79bf94..0804af75c817af8ea57a98d49537ac8c8fa355bc 100644 (file)
--- a/include/wx/gtk1/dnd.h
+++ b/include/wx/gtk1/dnd.h
@@ -2,7 +2,7 @@
 // Name:        dnd.h
 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling
 // Name:        dnd.h
 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling

-// RCS-ID:      
+// RCS-ID:      $Id$

 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////


@@ -16,9 +16,15 @@
 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"

+
+#if wxUSE_DRAG_AND_DROP
+

 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/object.h"
 #include "wx/string.h"

+#include "wx/dataobj.h"

 #include "wx/cursor.h"
 #include "wx/cursor.h"

+#include "wx/icon.h"
+#include "wx/gdicmn.h"

 
 //-------------------------------------------------------------------------
 // classes
 
 //-------------------------------------------------------------------------
 // classes


@@ -26,229 +32,207 @@
 
 class wxWindow;
 
 
 class wxWindow;
 

-class wxDataObject;
-class wxTextDataObject;
-class wxFileDataObject;
-

 class wxDropTarget;
 class wxTextDropTarget;
 class wxFileDropTarget;
 class wxDropTarget;
 class wxTextDropTarget;
 class wxFileDropTarget;

+class wxPrivateDropTarget;

 
 class wxDropSource;
 
 //-------------------------------------------------------------------------
 
 class wxDropSource;
 
 //-------------------------------------------------------------------------

-// wxDataObject
+// wxDropTarget

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxDataObject: public wxObject
+class wxDropTarget: public wxObject

 {
 public:
 {
 public:

-  // all data formats (values are the same as in windows.h, do not change!)
-  enum StdFormat
-  {
-    Invalid,
-    Text,
-    Bitmap,
-    MetafilePict,
-    Sylk,
-    Dif,
-    Tiff,
-    OemText,
-    Dib,
-    Palette,
-    Pendata,
-    Riff,
-    Wave,
-    UnicodeText,
-    EnhMetafile,
-    Hdrop,
-    Locale,
-    Max
-  };
-
-  // function to return symbolic name of clipboard format (debug messages)
-  static const char *GetFormatName(wxDataFormat format);
-
-  // ctor & dtor
-  wxDataObject() {};
-  ~wxDataObject() {};
-
-  // pure virtuals to override
-    // get the best suited format for our data
-  virtual wxDataFormat GetPreferredFormat() const = 0;
-    // decide if we support this format (should be one of values of
-    // StdFormat enumerations or a user-defined format)
-  virtual bool IsSupportedFormat(wxDataFormat format) const = 0;
-    // get the (total) size of data
-  virtual size_t GetDataSize() const = 0;
-    // copy raw data to provided pointer
-  virtual void GetDataHere(void *pBuf) const = 0;

 
 

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

 
 

-// ----------------------------------------------------------------------------
-// wxTextDataObject is a specialization of wxDataObject for text data
-// ----------------------------------------------------------------------------
+  /* may be overridden to react to events */
+  virtual void OnEnter();
+  virtual void OnLeave();

 
 

-class wxTextDataObject : public wxDataObject
-{
-public:
-  // ctors
-  wxTextDataObject() { }
-  wxTextDataObject(const wxString& strText) : m_strText(strText) { }
-  void Init(const wxString& strText) { m_strText = strText; }
-
-  // implement base class pure virtuals
-  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'of course
-  virtual void GetDataHere(void *pBuf) const
-    { memcpy(pBuf, m_strText.c_str(), GetDataSize()); }
+  /* 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 );

 
 

-private:
-  wxString  m_strText;
-  
-};
+  /* 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 );

 
 

-// ----------------------------------------------------------------------------
-// wxFileDataObject is a specialization of wxDataObject for file names
-// ----------------------------------------------------------------------------
+  /* 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 );

 
 

-class wxFileDataObject : public wxDataObject
-{
-public:
+  /* called from within OnDrop() to request a certain format
+     from the drop event. */
+  bool RequestData( wxDataFormat format );

 
 

-  wxFileDataObject(void) { }
-  void AddFile( const wxString &file )
-    { m_files += file; m_files += ";"; }
+  /* called to query what formats are available */
+  bool IsSupported( wxDataFormat format );

 
 

-  // implement base class pure virtuals
-  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() + 1; } // +1 for trailing '\0'of course
-  virtual void GetDataHere(void *pBuf) const
-    { memcpy(pBuf, m_files.c_str(), GetDataSize()); }
+  /* fill data with data from the dragging source */
+  bool GetData( wxDataObject *data );

 
 

-private:
-  wxString  m_files;
-  
+// 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; }

 };
 };

+

 //-------------------------------------------------------------------------
 //-------------------------------------------------------------------------

-// wxDropTarget
+// wxTextDropTarget

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxDropTarget: public wxObject
+class wxTextDropTarget: public wxDropTarget

 {
 {

-  public:
-
-    wxDropTarget();
-    ~wxDropTarget();
-    
-    virtual void OnEnter() { }
-    virtual void OnLeave() { }
-    virtual bool OnDrop( long x, long y, const void *pData ) = 0;
-
-//  protected:
-      
-    friend wxWindow;
-    
-    // Override these to indicate what kind of data you support: 
-  
-    virtual size_t GetFormatCount() const = 0;
-    virtual wxDataFormat GetFormat(size_t n) const = 0;
-  
-    void Drop( GdkEvent *event, int x, int y );
-    void RegisterWidget( GtkWidget *widget );
-    void UnregisterWidget( GtkWidget *widget );
+public:
+
+  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;
+

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

-// wxTextDropTarget
+// wxPrivateDropTarget

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxTextDropTarget: public wxDropTarget
+class wxPrivateDropTarget: public wxDropTarget

 {
 {

-  public:
-
-    wxTextDropTarget() {};
-    virtual bool OnDrop( long x, long y, const void *pData );
-    virtual bool OnDropText( long x, long y, const char *psz );
-    
-  protected:
-  
-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
+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( 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;
+
+  /* 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)
 // A drop target which accepts files (dragged from File Manager or Explorer)

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

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

-  public:
-    
-    wxFileDropTarget() {};
-    
-    virtual bool OnDrop(long x, long y, const void *pData);
-    virtual bool OnDropFiles( long x, long y, 
-                              size_t nFiles, const char * const aszFiles[]);
-
-  protected:
-  
-    virtual size_t GetFormatCount() const;
-    virtual wxDataFormat GetFormat(size_t n) const;
+public:
+
+  wxFileDropTarget() {}
+
+  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 OnDropFiles to get at the file names */
+  virtual bool OnDropFiles( long x, long y, size_t nFiles, const wxChar * const aszFiles[] ) = 0;
+

 };
 
 //-------------------------------------------------------------------------
 // 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
 {
 class wxDropSource: public wxObject
 {

-  public:
-
-  enum DragResult
-  {
-    Error,    // error prevented the d&d operation from completing
-    None,     // drag target didn't accept the data
-    Copy,     // the data was successfully copied
-    Move,     // the data was successfully moved
-    Cancel    // the operation was cancelled by user (not an error)
-  };
-
-    wxDropSource( wxWindow *win );
-    wxDropSource( wxDataObject &data, wxWindow *win );
-    
-    ~wxDropSource(void);
-    
-    void SetData( wxDataObject &data  );
-    DragResult DoDragDrop( bool bAllowMove = FALSE );
-    
-    virtual bool GiveFeedback( DragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; };
-
-  protected:
-  
-    friend void gtk_drag_callback( GtkWidget *widget, GdkEvent *event, wxDropSource *source );
-  
-    void RegisterWindow(void);
-    void UnregisterWindow(void);
-  
+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 );
+
+  // this one isn't portable to wxMSW -- deprecated
+  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;
     GtkWidget     *m_widget;
     wxWindow      *m_window;

-    DragResult     m_retValue;
-    wxDataObject  *m_data;
-    
+    wxDragResult   m_retValue;
+    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
+
+   // wxUSE_DRAG_AND_DROP
+
+#endif

        //__GTKDNDH__
 
        //__GTKDNDH__