1 /////////////////////////////////////////////////////////////////////////////
 
   3 // Purpose:     SWIG definitions for the Clipboard and Drag-n-drop classes
 
   7 // Created:     31-October-1999
 
   9 // Copyright:   (c) 1999 by Total Control Software
 
  10 // Licence:     wxWindows license
 
  11 /////////////////////////////////////////////////////////////////////////////
 
  20 #include <wx/dataobj.h>
 
  21 #include <wx/clipbrd.h>
 
  25 //----------------------------------------------------------------------
 
  28 %include my_typemaps.i
 
  30 // Import some definitions of other classes, etc.
 
  36 %pragma(python) code = "import wx"
 
  38 //----------------------------------------------------------------------
 
  44     wxDF_TEXT =             1,  /* CF_TEXT */
 
  45     wxDF_BITMAP =           2,  /* CF_BITMAP */
 
  46     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
 
  50     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
 
  51     wxDF_DIB =              8,  /* CF_DIB */
 
  56     wxDF_UNICODETEXT =      13,
 
  57     wxDF_ENHMETAFILE =      14,
 
  58     wxDF_FILENAME =         15, /* CF_HDROP */
 
  64 //----------------------------------------------------------------------
 
  68     wxDataFormat( wxDataFormatId type );
 
  71     void SetType(wxDataFormatId format);
 
  72     wxDataFormatId GetType() const;
 
  74     wxString GetId() const;
 
  75     void SetId(const char *format);
 
  78 %new wxDataFormat* wxCustomDataFormat(const wxString &id);
 
  79 %{  // An alternate constructor...
 
  80     wxDataFormat* wxCustomDataFormat(const wxString &id) {
 
  81         return new wxDataFormat(id);
 
  87 wxDataFormat wxPyFormatInvalid;
 
  90 %name(wxFormatInvalid) wxDataFormat wxPyFormatInvalid;
 
  94 //----------------------------------------------------------------------
 
  98 class wxDataObject {      //  An abstract base class
 
 101         Get  = 0x01,    // format is supported by GetDataHere()
 
 102         Set  = 0x02,    // format is supported by SetData()
 
 103         Both = 0x03     // format is supported by both (unused currently)
 
 108     wxDataFormat GetPreferredFormat(Direction dir = wxDataObject::Get);
 
 109     size_t GetFormatCount(Direction dir = wxDataObject::Get);
 
 110     void GetAllFormats(wxDataFormat *formats,
 
 111                        Direction dir = wxDataObject::Get);
 
 112     size_t GetDataSize(const wxDataFormat& format);
 
 113     bool GetDataHere(const wxDataFormat& format, void *buf);
 
 114     bool SetData(const wxDataFormat& format,
 
 115                  size_t len, const void * buf);
 
 116     bool IsSupportedFormat(const wxDataFormat& format);
 
 119 //----------------------------------------------------------------------
 
 121 class wxDataObjectSimple : public wxDataObject {
 
 123     wxDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
 
 125     const wxDataFormat& GetFormat();
 
 126     void SetFormat(const wxDataFormat& format);
 
 131 %{  // Create a new class for wxPython to use
 
 132 class wxPyDataObjectSimple : public wxDataObjectSimple {
 
 134     wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid)
 
 135         : wxDataObjectSimple(format) {}
 
 137     DEC_PYCALLBACK_SIZET_(GetDataSize);
 
 138     bool GetDataHere(void *buf);
 
 139     bool SetData(size_t len, const void *buf);
 
 143 IMP_PYCALLBACK_SIZET_(wxPyDataObjectSimple, wxDataObjectSimple, GetDataSize);
 
 145 bool wxPyDataObjectSimple::GetDataHere(void *buf) {
 
 146     // We need to get the data for this object and write it to buf.  I think
 
 147     // the best way to do this for wxPython is to have the Python method
 
 148     // return either a string or None and then act appropriately with the
 
 152     wxPyTState* state = wxPyBeginBlockThreads();
 
 153     if (m_myInst.findCallback("GetDataHere")) {
 
 155         ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 
 157             rval = (ro != Py_None && PyString_Check(ro));
 
 159                 memcpy(buf, PyString_AsString(ro), PyString_Size(ro));
 
 163     wxPyEndBlockThreads(state);
 
 167 bool wxPyDataObjectSimple::SetData(size_t len, const void *buf) {
 
 168     // For this one we simply need to make a string from buf and len
 
 169     // and send it to the Python method.
 
 171     wxPyTState* state = wxPyBeginBlockThreads();
 
 172     if (m_myInst.findCallback("SetData")) {
 
 173         PyObject* data = PyString_FromStringAndSize((char*)buf, len);
 
 174         rval = m_myInst.callCallback(Py_BuildValue("(O)", data));
 
 177     wxPyEndBlockThreads(state);
 
 184 // Now define it for SWIG
 
 185 class wxPyDataObjectSimple : public wxDataObjectSimple {
 
 187     wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
 
 188     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 189     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDataObjectSimple)"
 
 192 //----------------------------------------------------------------------
 
 194 class wxDataObjectComposite : public wxDataObject {
 
 196     wxDataObjectComposite();
 
 198     void Add(wxDataObjectSimple *dataObject, int preferred = FALSE);
 
 199     %pragma(python) addtomethod = "Add:_args[0].thisown = 0"
 
 204 //----------------------------------------------------------------------
 
 206 class wxTextDataObject : public wxDataObjectSimple {
 
 208     wxTextDataObject(const wxString& text = wxEmptyString);
 
 210     size_t GetTextLength();
 
 212     void SetText(const wxString& text);
 
 217 %{  // Create a new class for wxPython to use
 
 218 class wxPyTextDataObject : public wxTextDataObject {
 
 220     wxPyTextDataObject(const wxString& text = wxEmptyString)
 
 221         : wxTextDataObject(text) {}
 
 223     DEC_PYCALLBACK_SIZET_(GetTextLength);
 
 224     DEC_PYCALLBACK_STRING_(GetText);
 
 225     DEC_PYCALLBACK__STRING(SetText);
 
 229 IMP_PYCALLBACK_SIZET_(wxPyTextDataObject, wxTextDataObject, GetTextLength);
 
 230 IMP_PYCALLBACK_STRING_(wxPyTextDataObject, wxTextDataObject, GetText);
 
 231 IMP_PYCALLBACK__STRING(wxPyTextDataObject, wxTextDataObject, SetText);
 
 236 // Now define it for SWIG
 
 237 class wxPyTextDataObject : public wxTextDataObject {
 
 239     wxPyTextDataObject(const wxString& text = wxEmptyString);
 
 240     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 241     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTextDataObject)"
 
 244 //----------------------------------------------------------------------
 
 246 class wxBitmapDataObject : public wxDataObjectSimple {
 
 248     wxBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
 
 250     wxBitmap GetBitmap();
 
 251     void SetBitmap(const wxBitmap& bitmap);
 
 256 %{  // Create a new class for wxPython to use
 
 257 class wxPyBitmapDataObject : public wxBitmapDataObject {
 
 259     wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap)
 
 260         : wxBitmapDataObject(bitmap) {}
 
 262     wxBitmap GetBitmap();
 
 263     void SetBitmap(const wxBitmap& bitmap);
 
 267 wxBitmap wxPyBitmapDataObject::GetBitmap() {
 
 268     wxBitmap* rval = &wxNullBitmap;
 
 269     wxPyTState* state = wxPyBeginBlockThreads();
 
 270     if (m_myInst.findCallback("GetBitmap")) {
 
 273         ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 
 275             if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxBitmap_p"))
 
 280     wxPyEndBlockThreads(state);
 
 284 void wxPyBitmapDataObject::SetBitmap(const wxBitmap& bitmap) {
 
 285     wxPyTState* state = wxPyBeginBlockThreads();
 
 286     if (m_myInst.findCallback("SetBitmap")) {
 
 287         m_myInst.callCallback(Py_BuildValue("(O)",
 
 288                               wxPyConstructObject((void*)&bitmap, "wxBitmap")));
 
 290     wxPyEndBlockThreads(state);
 
 296 // Now define it for SWIG
 
 297 class wxPyBitmapDataObject : public wxBitmapDataObject {
 
 299     wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
 
 300     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 301     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyBitmapDataObject)"
 
 305 //----------------------------------------------------------------------
 
 307 class wxFileDataObject : public wxDataObjectSimple
 
 312     //const wxArrayString& GetFilenames();
 
 314         PyObject* GetFilenames() {
 
 315             const wxArrayString& strings = self->GetFilenames();
 
 316             return wxArrayString2PyList_helper(strings);
 
 320     void AddFile(const wxString &filename);
 
 325 //----------------------------------------------------------------------
 
 327 class wxCustomDataObject : public wxDataObjectSimple {
 
 329     wxCustomDataObject(const wxDataFormat& format = wxPyFormatInvalid);
 
 331     //void TakeData(size_t size, void *data);
 
 332     //bool SetData(size_t size, const void *buf);
 
 334         void TakeData(PyObject* data) {
 
 335             if (PyString_Check(data)) {
 
 336                 self->SetData(PyString_Size(data), PyString_AsString(data));
 
 339         bool SetData(PyObject* data) {
 
 340             if (PyString_Check(data)) {
 
 341                 return self->SetData(PyString_Size(data), PyString_AsString(data));
 
 351         PyObject* GetData() {
 
 352             return PyString_FromStringAndSize((char*)self->GetData(), self->GetSize());
 
 360 //----------------------------------------------------------------------
 
 362 class wxURLDataObject : public wxDataObjectComposite {
 
 367     void SetURL(const wxString& url);
 
 370 //----------------------------------------------------------------------
 
 371 //----------------------------------------------------------------------
 
 372 //----------------------------------------------------------------------
 
 374 class wxClipboard : public wxObject {
 
 380     bool IsOpened() const;
 
 382     bool AddData( wxDataObject *data );
 
 383     %pragma(python) addtomethod = "AddData:_args[0].thisown = 0"
 
 384     bool SetData( wxDataObject *data );
 
 385     %pragma(python) addtomethod = "SetData:_args[0].thisown = 0"
 
 387     bool IsSupported( const wxDataFormat& format );
 
 388     bool GetData( wxDataObject& data );
 
 391     void UsePrimarySelection( int primary = FALSE );
 
 395     // See below in the init function...
 
 396     wxClipboard* wxPyTheClipboard;
 
 399 %name(wxTheClipboard) wxClipboard* wxPyTheClipboard;
 
 402 //----------------------------------------------------------------------
 
 403 //----------------------------------------------------------------------
 
 407     wxDragError,    // error prevented the d&d operation from completing
 
 408     wxDragNone,     // drag target didn't accept the data
 
 409     wxDragCopy,     // the data was successfully copied
 
 410     wxDragMove,     // the data was successfully moved (MSW only)
 
 411     wxDragLink,     // operation is a drag-link
 
 412     wxDragCancel    // the operation was cancelled by user (not an error)
 
 415 bool wxIsDragResultOk(wxDragResult res);
 
 417 //----------------------------------------------------------------------
 
 419 class wxPyDropSource : public wxDropSource {
 
 422     wxPyDropSource(wxWindow *win = NULL,
 
 423                    const wxCursor &cursorCopy = wxNullCursor,
 
 424                    const wxCursor &cursorMove = wxNullCursor,
 
 425                    const wxCursor &cursorStop = wxNullCursor)
 
 426         : wxDropSource(win, cursorCopy, cursorMove, cursorStop) {}
 
 428     wxPyDropSource(wxWindow *win = NULL,
 
 429                    const wxIcon &go = wxNullIcon)
 
 430         : wxDropSource(win, go) {}
 
 432     ~wxPyDropSource() { }
 
 434     DEC_PYCALLBACK_BOOL_DR(GiveFeedback);
 
 438 IMP_PYCALLBACK_BOOL_DR(wxPyDropSource, wxDropSource, GiveFeedback);
 
 443 %name(wxDropSource) class wxPyDropSource {
 
 446     wxPyDropSource(wxWindow *win = NULL,
 
 447                  const wxCursor &cursorCopy = wxNullCursor,
 
 448                  const wxCursor &cursorMove = wxNullCursor,
 
 449                  const wxCursor &cursorStop = wxNullCursor);
 
 451     wxPyDropSource(wxWindow *win = NULL,
 
 452                    const wxIcon &go = wxNullIcon);
 
 455     void _setCallbackInfo(PyObject* self, PyObject* _class, int incref);
 
 456     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxDropSource, 0)"
 
 459     void SetData(wxDataObject& data);
 
 460     wxDataObject *GetDataObject();
 
 461     void SetCursor(wxDragResult res, const wxCursor& cursor);
 
 462     wxDragResult DoDragDrop(int bAllowMove = FALSE);
 
 464     bool base_GiveFeedback(wxDragResult effect);
 
 467 //----------------------------------------------------------------------
 
 469 // Just a place holder for the type system.  The real base class for
 
 470 // wxPython is wxPyDropTarget
 
 477 class wxPyDropTarget : public wxDropTarget {
 
 479     wxPyDropTarget(wxDataObject *dataObject = NULL)
 
 480         : wxDropTarget(dataObject) {}
 
 482 //      DEC_PYCALLBACK_SIZET_(GetFormatCount);
 
 483 //      DEC_PYCALLBACK_DATAFMT_SIZET(GetFormat);
 
 485     DEC_PYCALLBACK__(OnLeave);
 
 486     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 
 487     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 
 488     DEC_PYCALLBACK_DR_2WXCDR_pure(OnData);
 
 489     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 
 494 //  IMP_PYCALLBACK_SIZET_(wxPyDropTarget, wxDropTarget, GetFormatCount);
 
 495 //  IMP__PYCALLBACK_DATAFMT_SIZET(wxPyDropTarget, wxDropTarget, GetFormat);
 
 497 IMP_PYCALLBACK__(wxPyDropTarget, wxDropTarget, OnLeave);
 
 498 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnEnter);
 
 499 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnDragOver);
 
 500 IMP_PYCALLBACK_DR_2WXCDR_pure(wxPyDropTarget, wxDropTarget, OnData);
 
 501 IMP_PYCALLBACK_BOOL_INTINT(wxPyDropTarget, wxDropTarget, OnDrop);
 
 506 class wxPyDropTarget : public wxDropTarget {
 
 508     wxPyDropTarget(wxDataObject *dataObject = NULL);
 
 509     %pragma(python) addtomethod = "__init__:if _args:_args[0].thisown = 0"
 
 510     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 511     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDropTarget)"
 
 515     wxDataObject *GetDataObject();
 
 516     void SetDataObject(wxDataObject *dataObject);
 
 517     %pragma(python) addtomethod = "SetDataObject:if _args:_args[0].thisown = 0"
 
 519 //      size_t base_GetFormatCount();
 
 520 //      wxDataFormat base_GetFormat(size_t n);
 
 522     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 
 523     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 
 525     bool base_OnDrop(wxCoord x, wxCoord y);
 
 526     //wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
 
 528     // **** not sure about this one
 
 534 //----------------------------------------------------------------------
 
 537 class wxPyTextDropTarget : public wxTextDropTarget {
 
 539     wxPyTextDropTarget() {}
 
 541     DEC_PYCALLBACK_BOOL_INTINTSTR_pure(OnDropText);
 
 543     DEC_PYCALLBACK__(OnLeave);
 
 544     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 
 545     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 
 546     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 
 547     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 
 552 IMP_PYCALLBACK_BOOL_INTINTSTR_pure(wxPyTextDropTarget, wxTextDropTarget, OnDropText);
 
 553 IMP_PYCALLBACK__(wxPyTextDropTarget, wxTextDropTarget, OnLeave);
 
 554 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnEnter);
 
 555 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnDragOver);
 
 556 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnData);
 
 557 IMP_PYCALLBACK_BOOL_INTINT(wxPyTextDropTarget, wxTextDropTarget, OnDrop);
 
 561 %name(wxTextDropTarget) class wxPyTextDropTarget : public wxPyDropTarget {
 
 563     wxPyTextDropTarget();
 
 564     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 565     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTextDropTarget)"
 
 567     //bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
 
 568     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 
 569     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 
 571     bool base_OnDrop(wxCoord x, wxCoord y);
 
 572     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 575 //----------------------------------------------------------------------
 
 577 class wxPyFileDropTarget : public wxFileDropTarget {
 
 579     wxPyFileDropTarget() {}
 
 581     virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames);
 
 583     DEC_PYCALLBACK__(OnLeave);
 
 584     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 
 585     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 
 586     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 
 587     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 
 592 bool wxPyFileDropTarget::OnDropFiles(wxCoord x, wxCoord y,
 
 593                                      const wxArrayString& filenames) {
 
 595     wxPyTState* state = wxPyBeginBlockThreads();
 
 596     PyObject* list = wxArrayString2PyList_helper(filenames);
 
 597     if (m_myInst.findCallback("OnDropFiles"))
 
 598         rval = m_myInst.callCallback(Py_BuildValue("(iiO)",x,y,list));
 
 600     wxPyEndBlockThreads(state);
 
 606 IMP_PYCALLBACK__(wxPyFileDropTarget, wxFileDropTarget, OnLeave);
 
 607 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnEnter);
 
 608 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnDragOver);
 
 609 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnData);
 
 610 IMP_PYCALLBACK_BOOL_INTINT(wxPyFileDropTarget, wxFileDropTarget, OnDrop);
 
 615 %name(wxFileDropTarget) class wxPyFileDropTarget : public wxPyDropTarget
 
 618     wxPyFileDropTarget();
 
 619     void _setCallbackInfo(PyObject* self, PyObject* _class);
 
 620     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxFileDropTarget)"
 
 622 //    bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) = 0;
 
 623     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 
 624     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 
 626     bool base_OnDrop(wxCoord x, wxCoord y);
 
 627     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 
 630 //----------------------------------------------------------------------
 
 631 //----------------------------------------------------------------------
 
 632 //----------------------------------------------------------------------
 
 636     wxPyTheClipboard = wxTheClipboard;
 
 637     wxPyPtrTypeMap_Add("wxDropSource", "wxPyDropSource");
 
 638     wxPyPtrTypeMap_Add("wxTextDropTarget", "wxPyTextDropTarget");
 
 639     wxPyPtrTypeMap_Add("wxFileDropTarget", "wxPyFileDropTarget");
 
 642 //----------------------------------------------------------------------