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