utils/wxPython/src/clip_dnd.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        clip_dnd.i
   3 // Purpose:     SWIG definitions for the Clipboard and Drag-n-drop classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     31-October-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1999 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 %module clip_dnd
  15
  16 %{
  17 #include "helpers.h"
  18 #include <wx/dataobj.h>
  19 #include <wx/clipbrd.h>
  20 #include <wx/dnd.h>
  21 %}
  22
  23 //----------------------------------------------------------------------
  24
  25 %include typemaps.i
  26 %include my_typemaps.i
  27
  28 // Import some definitions of other classes, etc.
  29 %import _defs.i
  30 %import misc.i
  31 %import gdi.i
  32
  33
  34 %pragma(python) code = "import wx"
  35
  36 //----------------------------------------------------------------------
  37
  38
  39 enum wxDataFormatId
  40 {
  41     wxDF_INVALID =          0,
  42     wxDF_TEXT =             1,  /* CF_TEXT */
  43     wxDF_BITMAP =           2,  /* CF_BITMAP */
  44     wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
  45     wxDF_SYLK =             4,
  46     wxDF_DIF =              5,
  47     wxDF_TIFF =             6,
  48     wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
  49     wxDF_DIB =              8,  /* CF_DIB */
  50     wxDF_PALETTE =          9,
  51     wxDF_PENDATA =          10,
  52     wxDF_RIFF =             11,
  53     wxDF_WAVE =             12,
  54     wxDF_UNICODETEXT =      13,
  55     wxDF_ENHMETAFILE =      14,
  56     wxDF_FILENAME =         15, /* CF_HDROP */
  57     wxDF_LOCALE =           16,
  58     wxDF_PRIVATE =          20,
  59     wxDF_MAX
  60 };
  61
  62 //----------------------------------------------------------------------
  63
  64 class wxDataFormat {
  65 public:
  66     wxDataFormat( wxDataFormatId type );
  67     ~wxDataFormat();
  68
  69     void SetType(wxDataFormatId format);
  70     wxDataFormatId GetType() const;
  71
  72     wxString GetId() const;
  73     void SetId(const char *format);
  74 };
  75
  76 %new wxDataFormat* wxCustomDataFormat(const wxString &id);
  77 %{  // An alternate constructor...
  78     wxDataFormat* wxCustomDataFormat(const wxString &id) {
  79         return new wxDataFormat(id);
  80     }
  81 %}
  82
  83
  84 %{
  85 wxDataFormat wxPyFormatInvalid;
  86 %}
  87 %readonly
  88 %name(wxFormatInvalid) wxDataFormat wxPyFormatInvalid;
  89 %readwrite
  90
  91
  92 //----------------------------------------------------------------------
  93
  94
  95
  96 class wxDataObject {      //  An abstract base class
  97 public:
  98     enum Direction {
  99         Get  = 0x01,    // format is supported by GetDataHere()
 100         Set  = 0x02,    // format is supported by SetData()
 101         Both = 0x03     // format is supported by both (unused currently)
 102     };
 103
 104     ~wxDataObject();
 105
 106     wxDataFormat GetPreferredFormat(Direction dir = wxDataObject::Get);
 107     size_t GetFormatCount(Direction dir = wxDataObject::Get);
 108     void GetAllFormats(wxDataFormat *formats,
 109                        Direction dir = wxDataObject::Get);
 110     size_t GetDataSize(const wxDataFormat& format);
 111     bool GetDataHere(const wxDataFormat& format, void *buf);
 112     bool SetData(const wxDataFormat& format,
 113                  size_t len, const void * buf);
 114     bool IsSupportedFormat(const wxDataFormat& format);
 115 };
 116
 117 //----------------------------------------------------------------------
 118
 119 class wxDataObjectSimple : public wxDataObject {
 120 public:
 121     wxDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
 122
 123     const wxDataFormat& GetFormat();
 124     void SetFormat(const wxDataFormat& format);
 125
 126 };
 127
 128
 129 %{  // Create a new class for wxPython to use
 130 class wxPyDataObjectSimple : public wxDataObjectSimple {
 131 public:
 132     wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid)
 133         : wxDataObjectSimple(format) {}
 134
 135     DEC_PYCALLBACK_SIZET_(GetDataSize);
 136     bool GetDataHere(void *buf);
 137     bool SetData(size_t len, const void *buf);
 138     PYPRIVATE;
 139 };
 140
 141 IMP_PYCALLBACK_SIZET_(wxPyDataObjectSimple, wxDataObjectSimple, GetDataSize);
 142
 143 bool wxPyDataObjectSimple::GetDataHere(void *buf) {
 144     // We need to get the data for this object and write it to buf.  I think
 145     // the best way to do this for wxPython is to have the Python method
 146     // return either a string or None and then act appropriately with the
 147     // C++ version.
 148
 149     bool rval = FALSE;
 150     bool doSave = wxPyRestoreThread();
 151     if (m_myInst.findCallback("GetDataHere")) {
 152         PyObject* ro;
 153         ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 154         rval = (ro != Py_None && PyString_Check(ro));
 155         if (rval)
 156             memcpy(buf, PyString_AsString(ro), PyString_Size(ro));
 157     }
 158     wxPySaveThread(doSave);
 159     return rval;
 160 }
 161
 162 bool wxPyDataObjectSimple::SetData(size_t len, const void *buf) {
 163     // For this one we simply need to make a string from buf and len
 164     // and send it to the Python method.
 165     bool rval = FALSE;
 166     bool doSave = wxPyRestoreThread();
 167     if (m_myInst.findCallback("SetData")) {
 168         PyObject* data = PyString_FromStringAndSize((char*)buf, len);
 169         rval = m_myInst.callCallback(Py_BuildValue("(O)", data));
 170         Py_DECREF(data);
 171     }
 172     wxPySaveThread(doSave);
 173     return rval;
 174 }
 175 %}
 176
 177
 178
 179 // Now define it for SWIG
 180 class wxPyDataObjectSimple : public wxDataObjectSimple {
 181 public:
 182     wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
 183     void _setSelf(PyObject* self);
 184     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 185 };
 186
 187 //----------------------------------------------------------------------
 188
 189 class wxDataObjectComposite : public wxDataObject {
 190 public:
 191     wxDataObjectComposite();
 192
 193     void Add(wxDataObjectSimple *dataObject, int preferred = FALSE);
 194     %pragma(python) addtomethod = "Add:_args[0].thisown = 0"
 195
 196 };
 197
 198
 199 //----------------------------------------------------------------------
 200
 201 class wxTextDataObject : public wxDataObjectSimple {
 202 public:
 203     wxTextDataObject(const wxString& text = wxEmptyString);
 204
 205     size_t GetTextLength();
 206     wxString GetText();
 207     void SetText(const wxString& text);
 208 };
 209
 210
 211
 212 %{  // Create a new class for wxPython to use
 213 class wxPyTextDataObject : public wxTextDataObject {
 214 public:
 215     wxPyTextDataObject(const wxString& text = wxEmptyString)
 216         : wxTextDataObject(text) {}
 217
 218     DEC_PYCALLBACK_SIZET_(GetTextLength);
 219     DEC_PYCALLBACK_STRING_(GetText);
 220     DEC_PYCALLBACK__STRING(SetText);
 221     PYPRIVATE;
 222 };
 223
 224 IMP_PYCALLBACK_SIZET_(wxPyTextDataObject, wxTextDataObject, GetTextLength);
 225 IMP_PYCALLBACK_STRING_(wxPyTextDataObject, wxTextDataObject, GetText);
 226 IMP_PYCALLBACK__STRING(wxPyTextDataObject, wxTextDataObject, SetText);
 227
 228 %}
 229
 230
 231 // Now define it for SWIG
 232 class wxPyTextDataObject : public wxTextDataObject {
 233 public:
 234     wxPyTextDataObject(const wxString& text = wxEmptyString);
 235     void _setSelf(PyObject* self);
 236     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 237 };
 238
 239 //----------------------------------------------------------------------
 240
 241 class wxBitmapDataObject : public wxDataObjectSimple {
 242 public:
 243     wxBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
 244
 245     wxBitmap GetBitmap();
 246     void SetBitmap(const wxBitmap& bitmap);
 247 };
 248
 249
 250
 251 %{  // Create a new class for wxPython to use
 252 class wxPyBitmapDataObject : public wxBitmapDataObject {
 253 public:
 254     wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap)
 255         : wxBitmapDataObject(bitmap) {}
 256
 257     wxBitmap GetBitmap();
 258     void SetBitmap(const wxBitmap& bitmap);
 259     PYPRIVATE;
 260 };
 261
 262 wxBitmap wxPyBitmapDataObject::GetBitmap() {
 263     wxBitmap* rval = &wxNullBitmap;
 264     bool doSave = wxPyRestoreThread();
 265     if (m_myInst.findCallback("GetBitmap")) {
 266         PyObject* ro;
 267         wxBitmap* ptr;
 268         ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
 269         if (! SWIG_GetPtrObj(ro, (void **)&ptr, "_wxBitmap_p"))
 270             rval = ptr;
 271     }
 272     wxPySaveThread(doSave);
 273     return *rval;
 274 }
 275
 276 void wxPyBitmapDataObject::SetBitmap(const wxBitmap& bitmap) {
 277     bool doSave = wxPyRestoreThread();
 278     if (m_myInst.findCallback("SetBitmap")) {
 279         m_myInst.callCallback(Py_BuildValue("(O)",
 280                               wxPyConstructObject((void*)&bitmap, "wxBitmap")));
 281     }
 282     wxPySaveThread(doSave);
 283 }
 284 %}
 285
 286
 287
 288 // Now define it for SWIG
 289 class wxPyBitmapDataObject : public wxBitmapDataObject {
 290 public:
 291     wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
 292     void _setSelf(PyObject* self);
 293     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 294 };
 295
 296
 297 //----------------------------------------------------------------------
 298
 299 class wxFileDataObject : public wxDataObjectSimple
 300 {
 301 public:
 302     wxFileDataObject();
 303
 304     //const wxArrayString& GetFilenames();
 305     %addmethods {
 306         PyObject* GetFilenames() {
 307             const wxArrayString& strings = self->GetFilenames();
 308             PyObject* list = PyList_New(0);
 309             for (size_t x=0; x<strings.GetCount(); x++)
 310                 PyList_Append(list, PyString_FromString(strings[x]));
 311             return list;
 312         }
 313     }
 314
 315     //void AddFile(const wxString &filename);
 316 };
 317
 318
 319 //----------------------------------------------------------------------
 320
 321 class wxCustomDataObject : public wxDataObjectSimple {
 322 public:
 323     wxCustomDataObject(const wxDataFormat& format = wxPyFormatInvalid);
 324
 325     //void TakeData(size_t size, void *data);
 326     //bool SetData(size_t size, const void *buf);
 327     %addmethods {
 328         void TakeData(PyObject* data) {
 329             if (PyString_Check(data)) {
 330                 self->SetData(PyString_Size(data), PyString_AsString(data));
 331             }
 332         }
 333         bool SetData(PyObject* data) {
 334             if (PyString_Check(data)) {
 335                 return self->SetData(PyString_Size(data), PyString_AsString(data));
 336             }
 337             return FALSE;
 338         }
 339     }
 340
 341     size_t GetSize();
 342     //void *GetData();
 343     %addmethods {
 344         PyObject* GetData() {
 345             return PyString_FromStringAndSize((char*)self->GetData(), self->GetSize());
 346         }
 347     }
 348
 349
 350 };
 351
 352
 353
 354 //----------------------------------------------------------------------
 355 //----------------------------------------------------------------------
 356 //----------------------------------------------------------------------
 357
 358 class wxClipboard {
 359 public:
 360     wxClipboard();
 361
 362     bool Open();
 363     void Close();
 364     bool IsOpened() const;
 365
 366     bool AddData( wxDataObject *data );
 367     %pragma(python) addtomethod = "AddData:_args[0].thisown = 0"
 368     bool SetData( wxDataObject *data );
 369     %pragma(python) addtomethod = "SetData:_args[0].thisown = 0"
 370
 371     bool IsSupported( const wxDataFormat& format );
 372     bool GetData( wxDataObject& data );
 373     void Clear();
 374     bool Flush();
 375     void UsePrimarySelection( int primary = FALSE );
 376 };
 377
 378 %{
 379     wxClipboard* wxPyTheClipboard;
 380 %}
 381 %readonly
 382 %name(wxTheClipboard) wxClipboard* wxPyTheClipboard;
 383 %readwrite
 384
 385 //----------------------------------------------------------------------
 386 //----------------------------------------------------------------------
 387
 388 enum wxDragResult
 389 {
 390     wxDragError,    // error prevented the d&d operation from completing
 391     wxDragNone,     // drag target didn't accept the data
 392     wxDragCopy,     // the data was successfully copied
 393     wxDragMove,     // the data was successfully moved (MSW only)
 394     wxDragCancel    // the operation was cancelled by user (not an error)
 395 };
 396
 397 bool wxIsDragResultOk(wxDragResult res);
 398
 399 //----------------------------------------------------------------------
 400 %{
 401 class wxPyDropSource : public wxDropSource {
 402 public:
 403     wxPyDropSource(wxWindow *win = NULL,
 404                    const wxCursor &cursorCopy = wxNullCursor,
 405                    const wxCursor &cursorMove = wxNullCursor,
 406                    const wxCursor &cursorStop = wxNullCursor)
 407         : wxDropSource(win, cursorCopy, cursorMove, cursorStop) {}
 408
 409     DEC_PYCALLBACK_BOOL_DR(GiveFeedback);
 410     PYPRIVATE;
 411 };
 412
 413 IMP_PYCALLBACK_BOOL_DR(wxPyDropSource, wxDropSource, GiveFeedback);
 414
 415 %}
 416
 417
 418 %name(wxDropSource) class wxPyDropSource {
 419 public:
 420     wxPyDropSource(wxWindow *win = NULL,
 421                  const wxCursor &cursorCopy = wxNullCursor,
 422                  const wxCursor &cursorMove = wxNullCursor,
 423                  const wxCursor &cursorStop = wxNullCursor);
 424     void _setSelf(PyObject* self);
 425     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 426     ~wxPyDropSource();
 427
 428     void SetData(wxDataObject& data);
 429     wxDataObject *GetDataObject();
 430     void SetCursor(wxDragResult res, const wxCursor& cursor);
 431     wxDragResult DoDragDrop(int bAllowMove = FALSE);
 432
 433     bool base_GiveFeedback(wxDragResult effect);
 434 };
 435
 436 //----------------------------------------------------------------------
 437
 438 // Just a place holder for the type system.  The real base class for
 439 // wxPython is wxPyDropTarget
 440 class wxDropTarget {
 441 public:
 442 };
 443
 444
 445 %{
 446 class wxPyDropTarget : public wxDropTarget {
 447 public:
 448     wxPyDropTarget(wxDataObject *dataObject = NULL)
 449         : wxDropTarget(dataObject) {}
 450
 451 //      DEC_PYCALLBACK_SIZET_(GetFormatCount);
 452 //      DEC_PYCALLBACK_DATAFMT_SIZET(GetFormat);
 453
 454     DEC_PYCALLBACK__(OnLeave);
 455     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 456     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 457     DEC_PYCALLBACK_DR_2WXCDR_pure(OnData);
 458     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 459
 460     PYPRIVATE;
 461 };
 462
 463 //  IMP_PYCALLBACK_SIZET_(wxPyDropTarget, wxDropTarget, GetFormatCount);
 464 //  IMP__PYCALLBACK_DATAFMT_SIZET(wxPyDropTarget, wxDropTarget, GetFormat);
 465
 466 IMP_PYCALLBACK__(wxPyDropTarget, wxDropTarget, OnLeave);
 467 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnEnter);
 468 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnDragOver);
 469 IMP_PYCALLBACK_DR_2WXCDR_pure(wxPyDropTarget, wxDropTarget, OnData);
 470 IMP_PYCALLBACK_BOOL_INTINT(wxPyDropTarget, wxDropTarget, OnDrop);
 471
 472 %}
 473
 474
 475 class wxPyDropTarget : public wxDropTarget {
 476 public:
 477     wxPyDropTarget(wxDataObject *dataObject = NULL);
 478     %pragma(python) addtomethod = "__init__:if _args:_args[0].thisown = 0"
 479     void _setSelf(PyObject* self);
 480     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 481
 482     ~wxPyDropTarget();
 483
 484     wxDataObject *GetDataObject();
 485     void SetDataObject(wxDataObject *dataObject);
 486     %pragma(python) addtomethod = "SetDataObject:if _args:_args[0].thisown = 0"
 487
 488 //      size_t base_GetFormatCount();
 489 //      wxDataFormat base_GetFormat(size_t n);
 490
 491     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 492     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 493     void base_OnLeave();
 494     bool base_OnDrop(wxCoord x, wxCoord y);
 495     //wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
 496
 497     // **** not sure about this one
 498     bool GetData();
 499
 500 };
 501
 502
 503 //----------------------------------------------------------------------
 504
 505 %{
 506 class wxPyTextDropTarget : public wxTextDropTarget {
 507 public:
 508     wxPyTextDropTarget() {}
 509
 510     DEC_PYCALLBACK_BOOL_INTINTSTR_pure(OnDropText);
 511
 512     DEC_PYCALLBACK__(OnLeave);
 513     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 514     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 515     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 516     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 517
 518     PYPRIVATE;
 519 };
 520
 521 IMP_PYCALLBACK_BOOL_INTINTSTR_pure(wxPyTextDropTarget, wxTextDropTarget, OnDropText);
 522 IMP_PYCALLBACK__(wxPyTextDropTarget, wxTextDropTarget, OnLeave);
 523 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnEnter);
 524 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnDragOver);
 525 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnData);
 526 IMP_PYCALLBACK_BOOL_INTINT(wxPyTextDropTarget, wxTextDropTarget, OnDrop);
 527
 528 %}
 529
 530 %name(wxTextDropTarget) class wxPyTextDropTarget : public wxPyDropTarget {
 531 public:
 532     wxPyTextDropTarget();
 533     void _setSelf(PyObject* self);
 534     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 535
 536     //bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
 537     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 538     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 539     void base_OnLeave();
 540     bool base_OnDrop(wxCoord x, wxCoord y);
 541     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 542 };
 543
 544 //----------------------------------------------------------------------
 545 %{
 546 class wxPyFileDropTarget : public wxFileDropTarget {
 547 public:
 548     wxPyFileDropTarget() {}
 549
 550     virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames);
 551
 552     DEC_PYCALLBACK__(OnLeave);
 553     DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
 554     DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
 555     DEC_PYCALLBACK_DR_2WXCDR(OnData);
 556     DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
 557
 558     PYPRIVATE;
 559 };
 560
 561 bool wxPyFileDropTarget::OnDropFiles(wxCoord x, wxCoord y,
 562                                      const wxArrayString& filenames) {
 563     bool rval = FALSE;
 564     bool doSave = wxPyRestoreThread();
 565     PyObject* list = PyList_New(0);
 566     for (size_t i=0; i<filenames.GetCount(); i++) {
 567         PyObject* str = PyString_FromString(filenames[i].c_str());
 568         PyList_Append(list, str);
 569     }
 570     if (m_myInst.findCallback("OnDropFiles"))
 571         rval = m_myInst.callCallback(Py_BuildValue("(iiO)",x,y,list));
 572     Py_DECREF(list);
 573     wxPySaveThread(doSave);
 574     return rval;
 575 }
 576
 577
 578
 579 IMP_PYCALLBACK__(wxPyFileDropTarget, wxFileDropTarget, OnLeave);
 580 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnEnter);
 581 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnDragOver);
 582 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnData);
 583 IMP_PYCALLBACK_BOOL_INTINT(wxPyFileDropTarget, wxFileDropTarget, OnDrop);
 584
 585 %}
 586
 587
 588 %name(wxFileDropTarget) class wxPyFileDropTarget : public wxPyDropTarget
 589 {
 590 public:
 591     wxPyFileDropTarget();
 592     void _setSelf(PyObject* self);
 593     %pragma(python) addtomethod = "__init__:self._setSelf(self)"
 594
 595 //    bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) = 0;
 596     wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
 597     wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
 598     void base_OnLeave();
 599     bool base_OnDrop(wxCoord x, wxCoord y);
 600     wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
 601 };
 602
 603 //----------------------------------------------------------------------
 604 //----------------------------------------------------------------------
 605 //----------------------------------------------------------------------
 606
 607 %init %{
 608
 609     wxPyTheClipboard = wxTheClipboard;
 610
 611 %}
 612
 613 //----------------------------------------------------------------------
 614