Forward events to active child at MSW, not wx, level in wxMDIParentFrame.

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

diff --git a/include/wx/gtk/dnd.h b/include/wx/gtk/dnd.h
index f57083b7db72c448d0bd2523b957f89423550beb..c9f677d3c7488e0cea2075185793c262d3d45f24 100644 (file)
--- a/include/wx/gtk/dnd.h
+++ b/include/wx/gtk/dnd.h
@@ -1,337 +1,125 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        dnd.h
+// Name:        wx/gtk/dnd.h

 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
 // Purpose:     declaration of the wxDropTarget class
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_DND_H_
+#define _WX_GTK_DND_H_

 
 

-#ifndef __GTKDNDH__
-#define __GTKDNDH__
-
-#ifdef __GNUG__
-#pragma interface
-#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/icon.h"

-#include "wx/gdicmn.h"
-
-//-------------------------------------------------------------------------
-// classes
-//-------------------------------------------------------------------------
-
-class wxWindow;

 
 

-class wxDropTarget;
-class wxTextDropTarget;
-class wxFileDropTarget;
-class wxPrivateDropTarget;
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------

 
 

-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)
+// this macro may be used instead for wxDropSource ctor arguments: it will use
+// the icon 'name' from an XPM file under GTK, but will expand to something
+// else under MSW. If you don't use it, you will have to use #ifdef in the
+// application code.
+#define wxDROP_ICON(name)   wxICON(name)

 
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
 
 
 //-------------------------------------------------------------------------
 // wxDropTarget
 //-------------------------------------------------------------------------
 

-class wxDropTarget: public wxObject
+class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase

 {
 public:
 {
 public:

+    wxDropTarget(wxDataObject *dataObject = NULL );

 
 

-  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 );
+    virtual wxDragResult OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
+    virtual bool OnDrop(wxCoord x, wxCoord y);
+    virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
+    virtual bool GetData();

 
 

-  /* called from within OnDrop() to request a certain format
-     from the drop event. */
-  bool RequestData( wxDataFormat format );
+    // Can only be called during OnXXX methods.
+    wxDataFormat GetMatchingPair();

 
 

-  /* called to query what formats are available */
-  bool IsSupported( wxDataFormat format );
-  
-  /* fill data with data from the dragging source */
-  bool GetData( wxDataObject *data );
+    // implementation

 
 

-// 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
-//-------------------------------------------------------------------------
+    GdkAtom GTKGetMatchingPair(bool quiet = false);
+    wxDragResult GTKFigureOutSuggestedAction();

 
 

-class wxTextDropTarget: public wxDropTarget
-{
-public:
+    void GtkRegisterWidget( GtkWidget *widget );
+    void GtkUnregisterWidget( GtkWidget *widget );

 
 

-  wxTextDropTarget() {}
+    GdkDragContext     *m_dragContext;
+    GtkWidget          *m_dragWidget;
+    GtkSelectionData   *m_dragData;
+    unsigned            m_dragTime;
+    bool                m_firstMotion;     // gdk has no "gdk_drag_enter" event

 
 

-  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;
-    
+    void GTKSetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
+    void GTKSetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
+    void GTKSetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
+    void GTKSetDragTime(unsigned time) { m_dragTime = time; }

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

-// 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
-//-------------------------------------------------------------------------
-
-class wxDropTarget: public wxObject
-{
-  public:
-
-    wxDropTarget();
-    ~wxDropTarget();
-    
-    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;
-  
-  // implementation
-  
-    void RegisterWidget( GtkWidget *widget );
-    void UnregisterWidget( GtkWidget *widget );
-    
-    wxDataFormat  *m_format;
-};
-
-//-------------------------------------------------------------------------
-// wxTextDropTarget
-//-------------------------------------------------------------------------
-
-class wxTextDropTarget: public wxDropTarget
-{
-  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 );
-    
-  protected:
-  
-    virtual size_t GetFormatCount() const;
-};
-
-//-------------------------------------------------------------------------
-// wxPrivateDropTarget
+// wxDropSource

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

-class wxPrivateDropTarget: public wxDropTarget
+class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase

 {
 public:
 {
 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; }
+    // constructor. set data later with SetData()
+    wxDropSource( wxWindow *win = NULL,
+                  const wxIcon &copy = wxNullIcon,
+                  const wxIcon &move = wxNullIcon,
+                  const wxIcon &none = wxNullIcon);
+
+    // constructor for setting one data object
+    wxDropSource( wxDataObject& data,
+                  wxWindow *win,
+                  const wxIcon &copy = wxNullIcon,
+                  const wxIcon &move = wxNullIcon,
+                  const wxIcon &none = wxNullIcon);
+
+    virtual ~wxDropSource();
+
+    // set the icon corresponding to given drag result
+    void SetIcon(wxDragResult res, const wxIcon& icon)
+    {
+        if ( res == wxDragCopy )
+            m_iconCopy = icon;
+        else if ( res == wxDragMove )
+            m_iconMove = icon;
+        else
+            m_iconNone = icon;
+    }
+
+    // start drag action
+    virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
+
+    void PrepareIcon( int action, GdkDragContext *context );
+
+    GtkWidget       *m_widget;
+    GtkWidget       *m_iconWindow;
+    GdkDragContext  *m_dragContext;
+    wxWindow        *m_window;
+
+    wxDragResult     m_retValue;
+    wxIcon           m_iconCopy,
+                     m_iconMove,
+                     m_iconNone;
+
+    bool             m_waiting;

 
 private:
 
 private:

+    // common part of both ctors
+    void SetIcons(const wxIcon& copy,
+                  const wxIcon& move,
+                  const wxIcon& none);

 
 

-  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();
-    
-    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[] );
+    // GTK implementation
+    void GTKConnectDragSignals();
+    void GTKDisconnectDragSignals();

 
 

-  protected:
-  
-    virtual size_t GetFormatCount() const;

 };
 
 };
 

-#endif
-
-
-#endif
-
-   // wxUSE_DRAG_AND_DROP
-
-#endif  
-       //__GTKDNDH__
+#endif // _WX_GTK_DND_H_