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 /////////////////////////////////////////////////////////////////////////////
18 #include <wx/dataobj.h>
19 #include <wx/clipbrd.h>
23 //----------------------------------------------------------------------
26 %include my_typemaps.i
28 // Import some definitions of other classes, etc.
34 %pragma(python) code = "import wx"
36 //---------------------------------------------------------------------------
38 // Put some wx default wxChar* values into wxStrings.
39 static const wxString wxPyEmptyString(wxT(""));
41 //----------------------------------------------------------------------
68 //----------------------------------------------------------------------
72 wxDataFormat( wxDataFormatId type );
75 void SetType(wxDataFormatId format);
76 wxDataFormatId GetType() const;
78 wxString GetId() const;
79 void SetId(const wxString& format);
82 %new wxDataFormat* wxCustomDataFormat(const wxString &id);
83 %{ // An alternate constructor...
84 wxDataFormat* wxCustomDataFormat(const wxString &id) {
85 return new wxDataFormat(id);
91 wxDataFormat wxPyFormatInvalid;
94 %name(wxFormatInvalid) wxDataFormat wxPyFormatInvalid;
98 //----------------------------------------------------------------------
102 class wxDataObject { // An abstract base class
105 Get = 0x01, // format is supported by GetDataHere()
106 Set = 0x02, // format is supported by SetData()
107 Both = 0x03 // format is supported by both (unused currently)
112 wxDataFormat GetPreferredFormat(Direction dir = wxDataObject::Get);
113 size_t GetFormatCount(Direction dir = wxDataObject::Get);
115 // TODO: Fix these two to be usable from wxPython.
116 void GetAllFormats(wxDataFormat *formats,
117 Direction dir = wxDataObject::Get);
118 bool GetDataHere(const wxDataFormat& format, void *buf);
120 size_t GetDataSize(const wxDataFormat& format);
121 bool SetData(const wxDataFormat& format,
122 size_t len, const void * buf);
123 bool IsSupportedFormat(const wxDataFormat& format);
126 //----------------------------------------------------------------------
128 class wxDataObjectSimple : public wxDataObject {
130 wxDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
132 const wxDataFormat& GetFormat();
133 void SetFormat(const wxDataFormat& format);
138 %{ // Create a new class for wxPython to use
139 class wxPyDataObjectSimple : public wxDataObjectSimple {
141 wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid)
142 : wxDataObjectSimple(format) {}
144 DEC_PYCALLBACK_SIZET_(GetDataSize);
145 bool GetDataHere(void *buf);
146 bool SetData(size_t len, const void *buf);
150 IMP_PYCALLBACK_SIZET_(wxPyDataObjectSimple, wxDataObjectSimple, GetDataSize);
152 bool wxPyDataObjectSimple::GetDataHere(void *buf) {
153 // We need to get the data for this object and write it to buf. I think
154 // the best way to do this for wxPython is to have the Python method
155 // return either a string or None and then act appropriately with the
159 wxPyBeginBlockThreads();
160 if (m_myInst.findCallback("GetDataHere")) {
162 ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
164 rval = (ro != Py_None && PyString_Check(ro));
166 memcpy(buf, PyString_AsString(ro), PyString_Size(ro));
170 wxPyEndBlockThreads();
174 bool wxPyDataObjectSimple::SetData(size_t len, const void *buf) {
175 // For this one we simply need to make a string from buf and len
176 // and send it to the Python method.
178 wxPyBeginBlockThreads();
179 if (m_myInst.findCallback("SetData")) {
180 PyObject* data = PyString_FromStringAndSize((char*)buf, len);
181 rval = m_myInst.callCallback(Py_BuildValue("(O)", data));
184 wxPyEndBlockThreads();
191 // Now define it for SWIG
192 class wxPyDataObjectSimple : public wxDataObjectSimple {
194 wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
195 void _setCallbackInfo(PyObject* self, PyObject* _class);
196 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDataObjectSimple)"
199 //----------------------------------------------------------------------
201 class wxDataObjectComposite : public wxDataObject {
203 wxDataObjectComposite();
205 void Add(wxDataObjectSimple *dataObject, int preferred = FALSE);
206 %pragma(python) addtomethod = "Add:_args[0].thisown = 0"
211 //----------------------------------------------------------------------
213 class wxTextDataObject : public wxDataObjectSimple {
215 wxTextDataObject(const wxString& text = wxPyEmptyString);
217 size_t GetTextLength();
219 void SetText(const wxString& text);
224 %{ // Create a new class for wxPython to use
225 class wxPyTextDataObject : public wxTextDataObject {
227 wxPyTextDataObject(const wxString& text = wxPyEmptyString)
228 : wxTextDataObject(text) {}
230 DEC_PYCALLBACK_SIZET_(GetTextLength);
231 DEC_PYCALLBACK_STRING_(GetText);
232 DEC_PYCALLBACK__STRING(SetText);
236 IMP_PYCALLBACK_SIZET_(wxPyTextDataObject, wxTextDataObject, GetTextLength);
237 IMP_PYCALLBACK_STRING_(wxPyTextDataObject, wxTextDataObject, GetText);
238 IMP_PYCALLBACK__STRING(wxPyTextDataObject, wxTextDataObject, SetText);
243 // Now define it for SWIG
244 class wxPyTextDataObject : public wxTextDataObject {
246 wxPyTextDataObject(const wxString& text = wxPyEmptyString);
247 void _setCallbackInfo(PyObject* self, PyObject* _class);
248 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTextDataObject)"
251 //----------------------------------------------------------------------
253 class wxBitmapDataObject : public wxDataObjectSimple {
255 wxBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
257 wxBitmap GetBitmap();
258 void SetBitmap(const wxBitmap& bitmap);
263 %{ // Create a new class for wxPython to use
264 class wxPyBitmapDataObject : public wxBitmapDataObject {
266 wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap)
267 : wxBitmapDataObject(bitmap) {}
269 wxBitmap GetBitmap();
270 void SetBitmap(const wxBitmap& bitmap);
274 wxBitmap wxPyBitmapDataObject::GetBitmap() {
275 wxBitmap* rval = &wxNullBitmap;
276 wxPyBeginBlockThreads();
277 if (m_myInst.findCallback("GetBitmap")) {
280 ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
282 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxBitmap_p"))
287 wxPyEndBlockThreads();
291 void wxPyBitmapDataObject::SetBitmap(const wxBitmap& bitmap) {
292 wxPyBeginBlockThreads();
293 if (m_myInst.findCallback("SetBitmap")) {
294 PyObject* bo = wxPyConstructObject((void*)&bitmap, wxT("wxBitmap"));
295 m_myInst.callCallback(Py_BuildValue("(O)", bo));
298 wxPyEndBlockThreads();
304 // Now define it for SWIG
305 class wxPyBitmapDataObject : public wxBitmapDataObject {
307 wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
308 void _setCallbackInfo(PyObject* self, PyObject* _class);
309 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyBitmapDataObject)"
313 //----------------------------------------------------------------------
315 class wxFileDataObject : public wxDataObjectSimple
320 //const wxArrayString& GetFilenames();
322 PyObject* GetFilenames() {
323 const wxArrayString& strings = self->GetFilenames();
324 return wxArrayString2PyList_helper(strings);
328 void AddFile(const wxString &filename);
333 //----------------------------------------------------------------------
335 class wxCustomDataObject : public wxDataObjectSimple {
337 wxCustomDataObject(const wxDataFormat& format = wxPyFormatInvalid);
339 //void TakeData(size_t size, void *data);
340 //bool SetData(size_t size, const void *buf);
342 void TakeData(PyObject* data) {
343 if (PyString_Check(data)) {
344 self->SetData(PyString_Size(data), PyString_AsString(data));
347 bool SetData(PyObject* data) {
348 if (PyString_Check(data)) {
349 return self->SetData(PyString_Size(data), PyString_AsString(data));
359 PyObject* GetData() {
360 return PyString_FromStringAndSize((char*)self->GetData(), self->GetSize());
368 //----------------------------------------------------------------------
370 class wxURLDataObject : public wxDataObjectComposite {
375 void SetURL(const wxString& url);
378 //----------------------------------------------------------------------
383 #include <wx/metafile.h>
386 class wxMetafileDataObject : public wxDataObjectSimple
389 wxMetafileDataObject();
391 void SetMetafile(const wxMetafile& metafile);
392 wxMetafile GetMetafile() const;
397 //----------------------------------------------------------------------
398 //----------------------------------------------------------------------
399 //----------------------------------------------------------------------
401 class wxClipboard : public wxObject {
407 bool IsOpened() const;
409 bool AddData( wxDataObject *data );
410 %pragma(python) addtomethod = "AddData:_args[0].thisown = 0"
411 bool SetData( wxDataObject *data );
412 %pragma(python) addtomethod = "SetData:_args[0].thisown = 0"
414 bool IsSupported( const wxDataFormat& format );
415 bool GetData( wxDataObject& data );
418 void UsePrimarySelection( int primary = FALSE );
423 // See also wxPy_ReinitStockObjects in helpers.cpp
424 extern wxClipboard* wxTheClipboard;
427 //----------------------------------------------------------------------
428 //----------------------------------------------------------------------
430 // flags for wxDropSource::DoDragDrop()
434 wxDrag_CopyOnly = 0, // allow only copying
435 wxDrag_AllowMove = 1, // allow moving (copying is always allowed)
436 wxDrag_DefaultMove = 3 // the default operation is move, not copy
441 wxDragError, // error prevented the d&d operation from completing
442 wxDragNone, // drag target didn't accept the data
443 wxDragCopy, // the data was successfully copied
444 wxDragMove, // the data was successfully moved (MSW only)
445 wxDragLink, // operation is a drag-link
446 wxDragCancel // the operation was cancelled by user (not an error)
449 bool wxIsDragResultOk(wxDragResult res);
451 //----------------------------------------------------------------------
453 class wxPyDropSource : public wxDropSource {
456 wxPyDropSource(wxWindow *win = NULL,
457 const wxCursor © = wxNullCursor,
458 const wxCursor &move = wxNullCursor,
459 const wxCursor &none = wxNullCursor)
460 : wxDropSource(win, copy, move, none) {}
462 wxPyDropSource(wxWindow *win = NULL,
463 const wxIcon& copy = wxNullIcon,
464 const wxIcon& move = wxNullIcon,
465 const wxIcon& none = wxNullIcon)
466 : wxDropSource(win, copy, move, none) {}
468 ~wxPyDropSource() { }
470 DEC_PYCALLBACK_BOOL_DR(GiveFeedback);
474 IMP_PYCALLBACK_BOOL_DR(wxPyDropSource, wxDropSource, GiveFeedback);
479 %name(wxDropSource) class wxPyDropSource {
482 wxPyDropSource(wxWindow *win = NULL,
483 const wxCursor © = wxNullCursor,
484 const wxCursor &move = wxNullCursor,
485 const wxCursor &none = wxNullCursor);
487 wxPyDropSource(wxWindow *win = NULL,
488 const wxIcon& copy = wxNullIcon,
489 const wxIcon& move = wxNullIcon,
490 const wxIcon& none = wxNullIcon);
493 void _setCallbackInfo(PyObject* self, PyObject* _class, int incref);
494 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxDropSource, 0)"
497 void SetData(wxDataObject& data);
498 wxDataObject *GetDataObject();
499 void SetCursor(wxDragResult res, const wxCursor& cursor);
500 wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly);
502 bool base_GiveFeedback(wxDragResult effect);
505 //----------------------------------------------------------------------
507 // Just a place holder for the type system. The real base class for
508 // wxPython is wxPyDropTarget
515 class wxPyDropTarget : public wxDropTarget {
517 wxPyDropTarget(wxDataObject *dataObject = NULL)
518 : wxDropTarget(dataObject) {}
520 // DEC_PYCALLBACK_SIZET_(GetFormatCount);
521 // DEC_PYCALLBACK_DATAFMT_SIZET(GetFormat);
523 DEC_PYCALLBACK__(OnLeave);
524 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
525 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
526 DEC_PYCALLBACK_DR_2WXCDR_pure(OnData);
527 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
532 // IMP_PYCALLBACK_SIZET_(wxPyDropTarget, wxDropTarget, GetFormatCount);
533 // IMP__PYCALLBACK_DATAFMT_SIZET(wxPyDropTarget, wxDropTarget, GetFormat);
535 IMP_PYCALLBACK__(wxPyDropTarget, wxDropTarget, OnLeave);
536 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnEnter);
537 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnDragOver);
538 IMP_PYCALLBACK_DR_2WXCDR_pure(wxPyDropTarget, wxDropTarget, OnData);
539 IMP_PYCALLBACK_BOOL_INTINT(wxPyDropTarget, wxDropTarget, OnDrop);
544 class wxPyDropTarget : public wxDropTarget {
546 wxPyDropTarget(wxDataObject *dataObject = NULL);
547 %pragma(python) addtomethod = "__init__:if _args:_args[0].thisown = 0"
548 void _setCallbackInfo(PyObject* self, PyObject* _class);
549 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDropTarget)"
553 wxDataObject *GetDataObject();
554 void SetDataObject(wxDataObject *dataObject);
555 %pragma(python) addtomethod = "SetDataObject:if _args:_args[0].thisown = 0"
557 // size_t base_GetFormatCount();
558 // wxDataFormat base_GetFormat(size_t n);
560 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
561 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
563 bool base_OnDrop(wxCoord x, wxCoord y);
564 //wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
566 // **** not sure about this one
572 //----------------------------------------------------------------------
575 class wxPyTextDropTarget : public wxTextDropTarget {
577 wxPyTextDropTarget() {}
579 DEC_PYCALLBACK_BOOL_INTINTSTR_pure(OnDropText);
581 DEC_PYCALLBACK__(OnLeave);
582 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
583 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
584 DEC_PYCALLBACK_DR_2WXCDR(OnData);
585 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
590 IMP_PYCALLBACK_BOOL_INTINTSTR_pure(wxPyTextDropTarget, wxTextDropTarget, OnDropText);
591 IMP_PYCALLBACK__(wxPyTextDropTarget, wxTextDropTarget, OnLeave);
592 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnEnter);
593 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnDragOver);
594 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnData);
595 IMP_PYCALLBACK_BOOL_INTINT(wxPyTextDropTarget, wxTextDropTarget, OnDrop);
599 %name(wxTextDropTarget) class wxPyTextDropTarget : public wxPyDropTarget {
601 wxPyTextDropTarget();
602 void _setCallbackInfo(PyObject* self, PyObject* _class);
603 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTextDropTarget)"
605 //bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
606 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
607 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
609 bool base_OnDrop(wxCoord x, wxCoord y);
610 wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
613 //----------------------------------------------------------------------
615 class wxPyFileDropTarget : public wxFileDropTarget {
617 wxPyFileDropTarget() {}
619 virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames);
621 DEC_PYCALLBACK__(OnLeave);
622 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
623 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
624 DEC_PYCALLBACK_DR_2WXCDR(OnData);
625 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
630 bool wxPyFileDropTarget::OnDropFiles(wxCoord x, wxCoord y,
631 const wxArrayString& filenames) {
633 wxPyBeginBlockThreads();
634 if (m_myInst.findCallback("OnDropFiles")) {
635 PyObject* list = wxArrayString2PyList_helper(filenames);
636 rval = m_myInst.callCallback(Py_BuildValue("(iiO)",x,y,list));
639 wxPyEndBlockThreads();
645 IMP_PYCALLBACK__(wxPyFileDropTarget, wxFileDropTarget, OnLeave);
646 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnEnter);
647 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnDragOver);
648 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnData);
649 IMP_PYCALLBACK_BOOL_INTINT(wxPyFileDropTarget, wxFileDropTarget, OnDrop);
654 %name(wxFileDropTarget) class wxPyFileDropTarget : public wxPyDropTarget
657 wxPyFileDropTarget();
658 void _setCallbackInfo(PyObject* self, PyObject* _class);
659 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxFileDropTarget)"
661 // bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) = 0;
662 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
663 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
665 bool base_OnDrop(wxCoord x, wxCoord y);
666 wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
669 //----------------------------------------------------------------------
670 //----------------------------------------------------------------------
671 //----------------------------------------------------------------------
675 wxPyPtrTypeMap_Add("wxDropSource", "wxPyDropSource");
676 wxPyPtrTypeMap_Add("wxTextDropTarget", "wxPyTextDropTarget");
677 wxPyPtrTypeMap_Add("wxFileDropTarget", "wxPyFileDropTarget");
680 //----------------------------------------------------------------------