// 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/gdicmn.h"
-//-------------------------------------------------------------------------
-// classes
-//-------------------------------------------------------------------------
-
-class wxWindow;
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
-class wxDropTarget;
-class wxTextDropTarget;
-class wxFileDropTarget;
-class wxPrivateDropTarget;
-
-class wxDropSource;
+// 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
//-------------------------------------------------------------------------
-class wxDropTarget: public wxObject
+class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase
{
public:
- wxDropTarget( wxDataObject *data );
- ~wxDropTarget();
-
- /* may be overridden to react to events */
- virtual bool OnEnter( int x, int y );
-
- virtual void OnLeave();
+ wxDropTarget(wxDataObject *dataObject = NULL );
- /* 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 );
+ 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();
- /* 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 );
+ // Can only be called during OnXXX methods.
+ wxDataFormat GetMatchingPair();
- /* this gets called once the data has actually arrived.
- it will call GetData() to fill up its wxDataObject */
- virtual bool OnData( int x, int y );
+ // implementation
- /* fill data with data from the dragging source */
- bool GetData();
+ GdkAtom GtkGetMatchingPair(bool quiet = false);
-// implementation
+ void GtkRegisterWidget( GtkWidget *widget );
+ void GtkUnregisterWidget( GtkWidget *widget );
- GdkAtom GetMatchingPair();
-
- void RegisterWidget( GtkWidget *widget );
- void UnregisterWidget( GtkWidget *widget );
-
- wxDataObject *m_data;
GdkDragContext *m_dragContext;
GtkWidget *m_dragWidget;
GtkSelectionData *m_dragData;
guint m_dragTime;
- bool m_firstMotion; /* gdk has no "gdk_drag_enter" event */
+ 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; }
+ void GtkSetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
+ void GtkSetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
+ void GtkSetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
+ void GtkSetDragTime( guint time ) { m_dragTime = time; }
};
//-------------------------------------------------------------------------
// 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 WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase
{
public:
+ // constructor. set data later with SetData()
+ wxDropSource( wxWindow *win = NULL,
+ const wxIcon © = wxNullIcon,
+ const wxIcon &move = wxNullIcon,
+ const wxIcon &none = wxNullIcon);
- /* constructor. set data later with SetData() */
- wxDropSource( wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
-
- wxDropSource( wxDataObject& data, wxWindow *win, const wxIcon &go = wxNullIcon, const wxIcon &stop = wxNullIcon );
- ~wxDropSource();
+ // constructor for setting one data object
+ wxDropSource( wxDataObject& data,
+ wxWindow *win,
+ const wxIcon © = wxNullIcon,
+ const wxIcon &move = wxNullIcon,
+ const wxIcon &none = wxNullIcon);
- void SetData( wxDataObject& data );
+ virtual ~wxDropSource();
- /* start drag action */
- wxDragResult DoDragDrop( bool bAllowMove = FALSE );
+ // start drag action
+ virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
- /* override to give feedback */
- virtual bool GiveFeedback( wxDragResult WXUNUSED(effect), bool WXUNUSED(bScrolling) ) { return TRUE; }
+ void PrepareIcon( int action, GdkDragContext *context );
- /* GTK implementation */
+ GtkWidget *m_widget;
+ GtkWidget *m_iconWindow;
+ GdkDragContext *m_dragContext;
+ wxWindow *m_window;
- void RegisterWindow();
- void UnregisterWindow();
+ wxDragResult m_retValue;
+ wxIcon m_iconCopy,
+ m_iconMove,
+ m_iconNone;
- GtkWidget *m_widget;
- wxWindow *m_window;
- wxDragResult m_retValue;
- wxDataObject *m_data;
+ bool m_waiting;
- wxCursor m_defaultCursor;
- wxCursor m_goaheadCursor;
+private:
+ // common part of both ctors
+ void SetIcons(const wxIcon& copy,
+ const wxIcon& move,
+ const wxIcon& none);
- wxIcon m_goIcon;
- wxIcon m_stopIcon;
+ // GTK implementation
+ void GTKConnectDragSignals();
+ void GTKDisconnectDragSignals();
- bool m_waiting;
};
-#endif
-
- // wxUSE_DRAG_AND_DROP
-
-#endif
- //__GTKDNDH__
+#endif // _WX_GTK_DND_H_