include/wx/gtk/dnd.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        dnd.h
   3 // Purpose:     declaration of the wxDropTarget class
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1998 Vadim Zeitlin, Robert Roebling
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_DND_H_
  11 #define _WX_GTK_DND_H_
  12
  13 #include "wx/icon.h"
  14
  15 // ----------------------------------------------------------------------------
  16 // macros
  17 // ----------------------------------------------------------------------------
  18
  19 // this macro may be used instead for wxDropSource ctor arguments: it will use
  20 // the icon 'name' from an XPM file under GTK, but will expand to something
  21 // else under MSW. If you don't use it, you will have to use #ifdef in the
  22 // application code.
  23 #define wxDROP_ICON(name)   wxICON(name)
  24
  25 //-------------------------------------------------------------------------
  26 // wxDropTarget
  27 //-------------------------------------------------------------------------
  28
  29 class WXDLLIMPEXP_CORE wxDropTarget: public wxDropTargetBase
  30 {
  31 public:
  32     wxDropTarget(wxDataObject *dataObject = NULL );
  33
  34     virtual wxDragResult OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
  35     virtual bool OnDrop(wxCoord x, wxCoord y);
  36     virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def);
  37     virtual bool GetData();
  38
  39     // Can only be called during OnXXX methods.
  40     wxDataFormat GetMatchingPair();
  41
  42     // implementation
  43
  44     GdkAtom GtkGetMatchingPair(bool quiet = false);
  45
  46     void GtkRegisterWidget( GtkWidget *widget );
  47     void GtkUnregisterWidget( GtkWidget *widget );
  48
  49     GdkDragContext     *m_dragContext;
  50     GtkWidget          *m_dragWidget;
  51     GtkSelectionData   *m_dragData;
  52     guint               m_dragTime;
  53     bool                m_firstMotion;     // gdk has no "gdk_drag_enter" event
  54
  55     void GtkSetDragContext( GdkDragContext *dc ) { m_dragContext = dc; }
  56     void GtkSetDragWidget( GtkWidget *w ) { m_dragWidget = w; }
  57     void GtkSetDragData( GtkSelectionData *sd ) { m_dragData = sd; }
  58     void GtkSetDragTime( guint time ) { m_dragTime = time; }
  59 };
  60
  61 //-------------------------------------------------------------------------
  62 // wxDropSource
  63 //-------------------------------------------------------------------------
  64
  65 class WXDLLIMPEXP_CORE wxDropSource: public wxDropSourceBase
  66 {
  67 public:
  68     // constructor. set data later with SetData()
  69     wxDropSource( wxWindow *win = NULL,
  70                   const wxIcon &copy = wxNullIcon,
  71                   const wxIcon &move = wxNullIcon,
  72                   const wxIcon &none = wxNullIcon);
  73
  74     // constructor for setting one data object
  75     wxDropSource( wxDataObject& data,
  76                   wxWindow *win,
  77                   const wxIcon &copy = wxNullIcon,
  78                   const wxIcon &move = wxNullIcon,
  79                   const wxIcon &none = wxNullIcon);
  80
  81     virtual ~wxDropSource();
  82
  83     // start drag action
  84     virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
  85
  86     void PrepareIcon( int action, GdkDragContext *context );
  87
  88     GtkWidget       *m_widget;
  89     GtkWidget       *m_iconWindow;
  90     GdkDragContext  *m_dragContext;
  91     wxWindow        *m_window;
  92
  93     wxDragResult     m_retValue;
  94     wxIcon           m_iconCopy,
  95                      m_iconMove,
  96                      m_iconNone;
  97
  98     bool             m_waiting;
  99
 100 private:
 101     // common part of both ctors
 102     void SetIcons(const wxIcon& copy,
 103                   const wxIcon& move,
 104                   const wxIcon& none);
 105
 106     // GTK implementation
 107     void GTKConnectDragSignals();
 108     void GTKDisconnectDragSignals();
 109
 110 };
 111
 112 #endif // _WX_GTK_DND_H_
 113