// 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"
+
+//-------------------------------------------------------------------------
+// conditional compilation
+//-------------------------------------------------------------------------
+
+#if (GTK_MINOR_VERSION == 1)
+#if (GTK_MICRO_VERSION >= 3)
+#define NEW_GTK_DND_CODE
+#endif
+#endif
//-------------------------------------------------------------------------
// classes
class wxDropTarget;
class wxTextDropTarget;
-class wxDragSource;
-class wxTextDragSource;
+class wxFileDropTarget;
+class wxPrivateDropTarget;
+
+class wxDropSource;
//-------------------------------------------------------------------------
// wxDropTarget
//-------------------------------------------------------------------------
-class wxDropTarget: wxObject
+class wxDropTarget: public wxObject
{
public:
wxDropTarget();
~wxDropTarget();
+
virtual void OnEnter() { }
virtual void OnLeave() { }
- virtual bool OnDrop( long x, long y, const void *pData ) = 0;
+ virtual void OnMouseMove( long WXUNUSED(x), long WXUNUSED(y) ) { }
+ virtual bool OnDrop( long x, long y, const void *data, size_t size ) = 0;
- public:
-
- void Drop( GdkEvent *event, int x, int y );
- virtual void RegisterWidget( GtkWidget *widget ) = 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;
};
//-------------------------------------------------------------------------
{
public:
- wxTextDropTarget() {};
- virtual bool OnDrop( long x, long y, const void *pData );
+ wxTextDropTarget();
+ virtual bool OnDrop( long x, long y, const void *data, size_t size );
virtual bool OnDropText( long x, long y, const char *psz );
- virtual void RegisterWidget( GtkWidget *widget );
+
+ protected:
+
+ virtual size_t GetFormatCount() const;
};
//-------------------------------------------------------------------------
-// wxDragSource
+// wxPrivateDropTarget
//-------------------------------------------------------------------------
-class wxDragSource: public wxObject
+class wxPrivateDropTarget: public wxDropTarget
{
- 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; }
+
+private:
- wxDragSource( wxWindow *win );
- ~wxDragSource(void);
- void SetData( char *data, long size );
- void Start( int x, int y );
+ 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[] );
- void ConnectWindow(void);
- void UnconnectWindow(void);
- virtual void RegisterWindow(void) = 0;
- void UnregisterWindow(void);
+ protected:
- GtkWidget *m_widget;
- wxWindow *m_window;
- char *m_data;
- long m_size;
- wxCursor m_defaultCursor;
- wxCursor m_goaheadCursor;
+ virtual size_t GetFormatCount() const;
};
//-------------------------------------------------------------------------
-// wxTextDragSource
+// wxDropSource
//-------------------------------------------------------------------------
-class wxTextDragSource: public wxDragSource
+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:
- wxTextDragSource( wxWindow *win ) : wxDragSource(win) {};
- void SetTextData( const wxString &text );
- void RegisterWindow(void);
+ /* 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 );
- private:
+ ~wxDropSource(void);
+
+ /* set one dataobject */
+ void SetData( wxDataBroker *data );
+
+ /* set severa dataobjects via wxDataBroker */
+ 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);
+ void UnregisterWindow(void);
- wxString m_tmp;
+ GtkWidget *m_widget;
+ wxWindow *m_window;
+ wxDragResult m_retValue;
+ wxDataBroker *m_data;
+
+ wxCursor m_defaultCursor;
+ wxCursor m_goaheadCursor;
+
+ wxIcon m_goIcon;
+ wxIcon m_stopIcon;
};
+#endif
+
+ // wxUSE_DRAG_AND_DROP
+
#endif
//__GTKDNDH__
projects / wxWidgets.git / blobdiff