// 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
///////////////////////////////////////////////////////////////////////////////
#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"
//-------------------------------------------------------------------------
// classes
class wxDropTarget;
class wxTextDropTarget;
-class wxDragSource;
-class wxTextDragSource;
+class wxFileDropTarget;
+class wxPrivateDropTarget;
+
+class wxDropSource;
//-------------------------------------------------------------------------
// wxDropTarget
//-------------------------------------------------------------------------
-class wxDropTarget: wxObject
+class wxDropTarget: public wxObject
{
- public:
+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( 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 );
- wxDropTarget();
- ~wxDropTarget();
- virtual void OnEnter() { }
- virtual void OnLeave() { }
- virtual bool OnDrop( long x, long y, const void *pData ) = 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 );
- public:
+ /* called from within OnDrop() to request a certain format
+ from the drop event. */
+ bool RequestData( wxDataFormat format );
- void Drop( GdkEvent *event, int x, int y );
- virtual void RegisterWidget( GtkWidget *widget ) = 0;
- void UnregisterWidget( GtkWidget *widget );
+ /* 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; }
};
//-------------------------------------------------------------------------
class wxTextDropTarget: public wxDropTarget
{
- public:
+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() {};
- virtual bool OnDrop( long x, long y, const void *pData );
- virtual bool OnDropText( long x, long y, const char *psz );
- virtual void RegisterWidget( GtkWidget *widget );
};
//-------------------------------------------------------------------------
-// wxDragSource
+// wxPrivateDropTarget
//-------------------------------------------------------------------------
-class wxDragSource: public wxObject
+class wxPrivateDropTarget: public wxDropTarget
{
- public:
-
- wxDragSource( wxWindow *win );
- ~wxDragSource(void);
- void SetData( char *data, long size );
- void Start( int x, int y );
-
- public:
-
- void ConnectWindow(void);
- void UnconnectWindow(void);
- virtual void RegisterWindow(void) = 0;
- void UnregisterWindow(void);
-
- GtkWidget *m_widget;
- wxWindow *m_window;
- char *m_data;
- long m_size;
- wxCursor m_defaultCursor;
- wxCursor m_goaheadCursor;
+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)
+//----------------------------------------------------------------------------
+
+class wxFileDropTarget: public wxDropTarget
+{
+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;
+
};
//-------------------------------------------------------------------------
-// wxTextDragSource
+// wxDropSource
//-------------------------------------------------------------------------
-class wxTextDragSource: public wxDragSource
+enum wxDragResult
{
- public:
-
- wxTextDragSource( wxWindow *win ) : wxDragSource(win) {};
- void SetTextData( const wxString &text );
- void RegisterWindow(void);
-
- private:
-
- wxString m_tmp;
+ 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)
};
-#endif
+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 );
+
+ // 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;
+ wxDragResult m_retValue;
+ wxDataBroker *m_data;
+
+ wxCursor m_defaultCursor;
+ wxCursor m_goaheadCursor;
+
+ wxIcon m_goIcon;
+ wxIcon m_stopIcon;
+
+ bool m_waiting;
+};
+
+#endif
+
+ // wxUSE_DRAG_AND_DROP
+
+#endif
//__GTKDNDH__
projects / wxWidgets.git / blobdiff