wxPython/src/_dnd.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _dnd.i
   3 // Purpose:     SWIG definitions for the Drag-n-drop classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     31-October-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 #ifndef __WXX11__
  18
  19 %newgroup
  20
  21 // flags for wxDropSource::DoDragDrop()
  22 //
  23 // NB: wxDrag_CopyOnly must be 0 (== False) and wxDrag_AllowMove must be 1
  24 //     (== True) for compatibility with the old DoDragDrop(bool) method!
  25 enum
  26 {
  27     wxDrag_CopyOnly    = 0, // allow only copying
  28     wxDrag_AllowMove   = 1, // allow moving (copying is always allowed)
  29     wxDrag_DefaultMove = 3  // the default operation is move, not copy
  30 };
  31
  32 // result of wxDropSource::DoDragDrop() call
  33 enum wxDragResult
  34 {
  35     wxDragError,    // error prevented the d&d operation from completing
  36     wxDragNone,     // drag target didn't accept the data
  37     wxDragCopy,     // the data was successfully copied
  38     wxDragMove,     // the data was successfully moved (MSW only)
  39     wxDragLink,     // operation is a drag-link
  40     wxDragCancel    // the operation was cancelled by user (not an error)
  41 };
  42
  43 bool wxIsDragResultOk(wxDragResult res);
  44
  45 //---------------------------------------------------------------------------
  46
  47
  48 // wxDropSource is the object you need to create (and call DoDragDrop on it)
  49 // to initiate a drag-and-drop operation
  50
  51
  52
  53 %{
  54 IMP_PYCALLBACK_BOOL_DR(wxPyDropSource, wxDropSource, GiveFeedback);
  55 %}
  56
  57
  58 %rename(DropSource) wxPyDropSource;
  59 class wxPyDropSource {
  60 public:
  61     %pythonAppend wxPyDropSource "self._setCallbackInfo(self, DropSource, 0)"
  62 #ifndef __WXGTK__
  63      wxPyDropSource(wxWindow *win,
  64                     const wxCursor &copy = wxNullCursor,
  65                     const wxCursor &move = wxNullCursor,
  66                     const wxCursor &none = wxNullCursor);
  67 #else
  68     wxPyDropSource(wxWindow *win,
  69                    const wxIcon& copy = wxNullIcon,
  70                    const wxIcon& move = wxNullIcon,
  71                    const wxIcon& none = wxNullIcon);
  72 #endif
  73
  74     void _setCallbackInfo(PyObject* self, PyObject* _class, int incref);
  75     ~wxPyDropSource();
  76
  77     // set the data which is transfered by drag and drop
  78     void SetData(wxDataObject& data);
  79
  80     wxDataObject *GetDataObject();
  81
  82     // set the icon corresponding to given drag result
  83     void SetCursor(wxDragResult res, const wxCursor& cursor);
  84
  85     wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
  86
  87     bool base_GiveFeedback(wxDragResult effect);
  88 };
  89
  90
  91 //---------------------------------------------------------------------------
  92
  93 // wxDropTarget should be associated with a window if it wants to be able to
  94 // receive data via drag and drop.
  95 //
  96 // To use this class, you should derive from wxDropTarget and implement
  97 // OnData() pure virtual method. You may also wish to override OnDrop() if you
  98 // want to accept the data only inside some region of the window (this may
  99 // avoid having to copy the data to this application which happens only when
 100 // OnData() is called)
 101
 102
 103 // Just a place holder for the type system.  The real base class for
 104 // wxPython is wxPyDropTarget
 105 // class wxDropTarget {
 106 // public:
 107 // };
 108
 109
 110 %{
 111 IMP_PYCALLBACK__(wxPyDropTarget, wxDropTarget, OnLeave);
 112 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnEnter);
 113 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnDragOver);
 114 IMP_PYCALLBACK_DR_2WXCDR_pure(wxPyDropTarget, wxDropTarget, OnData);
 115 IMP_PYCALLBACK_BOOL_INTINT(wxPyDropTarget, wxDropTarget, OnDrop);
 116 %}
 117
 118
 119 %rename(DropTarget) wxPyDropTarget;
 120 class wxPyDropTarget // : public wxDropTarget
 121 {
 122 public:
 123     %pythonAppend wxPyDropTarget
 124        "self._setCallbackInfo(self, DropTarget)"
 125     %apply SWIGTYPE *DISOWN { wxDataObject *dataObject };
 126
 127     wxPyDropTarget(wxDataObject *dataObject = NULL);
 128     void _setCallbackInfo(PyObject* self, PyObject* _class);
 129
 130     ~wxPyDropTarget();
 131
 132     // get/set the associated wxDataObject
 133     wxDataObject *GetDataObject();
 134     void SetDataObject(wxDataObject *dataObject);
 135
 136     %clear wxDataObject *dataObject;
 137
 138     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 139     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 140     void base_OnLeave();
 141     bool base_OnDrop(wxCoord x, wxCoord y);
 142
 143     // may be called *only* from inside OnData() and will fill m_dataObject
 144     // with the data from the drop source if it returns True
 145     bool GetData();
 146
 147     // sets the default action for drag and drop:
 148     // use wxDragMove or wxDragCopy to set deafult action to move or copy
 149     // and use wxDragNone (default) to set default action specified by
 150     // initialization of draging (see wxDropSourceBase::DoDragDrop())
 151     void SetDefaultAction(wxDragResult action);
 152
 153     // returns default action for drag and drop or
 154     // wxDragNone if this not specified
 155     wxDragResult GetDefaultAction();
 156 };
 157
 158
 159 %pythoncode { PyDropTarget = DropTarget }
 160
 161 //---------------------------------------------------------------------------
 162
 163 // A simple wxDropTarget derived class for text data: you only need to
 164 // override OnDropText() to get something working
 165
 166
 167 %{
 168 class wxPyTextDropTarget : public wxTextDropTarget {
 169 public:
 170     wxPyTextDropTarget() {}
 171
 172     DEC_PYCALLBACK_BOOL_INTINTSTR_pure(OnDropText);
 173
 174     DEC_PYCALLBACK__(OnLeave);
 175     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 176     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 177     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 178     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 179
 180     PYPRIVATE;
 181 };
 182
 183 IMP_PYCALLBACK_BOOL_INTINTSTR_pure(wxPyTextDropTarget, wxTextDropTarget, OnDropText);
 184 IMP_PYCALLBACK__(wxPyTextDropTarget, wxTextDropTarget, OnLeave);
 185 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnEnter);
 186 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnDragOver);
 187 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnData);
 188 IMP_PYCALLBACK_BOOL_INTINT(wxPyTextDropTarget, wxTextDropTarget, OnDrop);
 189
 190 %}
 191
 192 %rename(TextDropTarget) wxPyTextDropTarget;
 193 class wxPyTextDropTarget : public wxPyDropTarget {
 194 public:
 195     %pythonAppend wxPyTextDropTarget   "self._setCallbackInfo(self, TextDropTarget)"
 196
 197     wxPyTextDropTarget();
 198     void _setCallbackInfo(PyObject* self, PyObject* _class);
 199
 200     //bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
 201     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 202     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 203     void base_OnLeave();
 204     bool base_OnDrop(wxCoord x, wxCoord y);
 205     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 206 };
 207
 208 //---------------------------------------------------------------------------
 209
 210 // A drop target which accepts files (dragged from File Manager or Explorer)
 211
 212
 213 %{
 214 class wxPyFileDropTarget : public wxFileDropTarget {
 215 public:
 216     wxPyFileDropTarget() {}
 217
 218     virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames);
 219
 220     DEC_PYCALLBACK__(OnLeave);
 221     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 222     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 223     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 224     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 225
 226     PYPRIVATE;
 227 };
 228
 229 bool wxPyFileDropTarget::OnDropFiles(wxCoord x, wxCoord y,
 230                                      const wxArrayString& filenames) {
 231     bool rval = false;
 232     wxPyBlock_t blocked = wxPyBeginBlockThreads();
 233     if (wxPyCBH_findCallback(m_myInst, "OnDropFiles")) {
 234         PyObject* list = wxArrayString2PyList_helper(filenames);
 235         rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(iiO)",x,y,list));
 236         Py_DECREF(list);
 237     }
 238     wxPyEndBlockThreads(blocked);
 239     return rval;
 240 }
 241
 242
 243
 244 IMP_PYCALLBACK__(wxPyFileDropTarget, wxFileDropTarget, OnLeave);
 245 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnEnter);
 246 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnDragOver);
 247 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnData);
 248 IMP_PYCALLBACK_BOOL_INTINT(wxPyFileDropTarget, wxFileDropTarget, OnDrop);
 249
 250 %}
 251
 252
 253 %rename(FileDropTarget) wxPyFileDropTarget;
 254 class wxPyFileDropTarget : public wxPyDropTarget
 255 {
 256 public:
 257     %pythonAppend wxPyFileDropTarget   "self._setCallbackInfo(self, FileDropTarget)"
 258
 259     wxPyFileDropTarget();
 260     void _setCallbackInfo(PyObject* self, PyObject* _class);
 261
 262 //    bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) = 0;
 263     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 264     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 265     void base_OnLeave();
 266     bool base_OnDrop(wxCoord x, wxCoord y);
 267     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 268 };
 269
 270
 271 //---------------------------------------------------------------------------
 272 %init %{
 273     wxPyPtrTypeMap_Add("wxDropSource",     "wxPyDropSource");
 274     wxPyPtrTypeMap_Add("wxDropTarget",     "wxPyDropTarget");
 275     wxPyPtrTypeMap_Add("wxTextDropTarget", "wxPyTextDropTarget");
 276     wxPyPtrTypeMap_Add("wxFileDropTarget", "wxPyFileDropTarget");
 277 %}
 278 //---------------------------------------------------------------------------
 279
 280 #endif