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 //----------------------------------------------------------------------
42 wxDF_TEXT = 1, /* CF_TEXT */
43 wxDF_BITMAP = 2, /* CF_BITMAP */
44 wxDF_METAFILE = 3, /* CF_METAFILEPICT */
48 wxDF_OEMTEXT = 7, /* CF_OEMTEXT */
49 wxDF_DIB = 8, /* CF_DIB */
54 wxDF_UNICODETEXT = 13,
55 wxDF_ENHMETAFILE = 14,
56 wxDF_FILENAME = 15, /* CF_HDROP */
62 //----------------------------------------------------------------------
66 wxDataFormat( wxDataFormatId type );
69 void SetType(wxDataFormatId format);
70 wxDataFormatId GetType() const;
72 wxString GetId() const;
73 void SetId(const char *format);
76 %new wxDataFormat* wxCustomDataFormat(const wxString &id);
77 %{ // An alternate constructor...
78 wxDataFormat* wxCustomDataFormat(const wxString &id) {
79 return new wxDataFormat(id);
85 wxDataFormat wxPyFormatInvalid;
88 %name(wxFormatInvalid) wxDataFormat wxPyFormatInvalid;
92 //----------------------------------------------------------------------
96 class wxDataObject { // An abstract base class
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)
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);
117 //----------------------------------------------------------------------
119 class wxDataObjectSimple : public wxDataObject {
121 wxDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
123 const wxDataFormat& GetFormat();
124 void SetFormat(const wxDataFormat& format);
129 %{ // Create a new class for wxPython to use
130 class wxPyDataObjectSimple : public wxDataObjectSimple {
132 wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid)
133 : wxDataObjectSimple(format) {}
135 DEC_PYCALLBACK_SIZET_(GetDataSize);
136 bool GetDataHere(void *buf);
137 bool SetData(size_t len, const void *buf);
141 IMP_PYCALLBACK_SIZET_(wxPyDataObjectSimple, wxDataObjectSimple, GetDataSize);
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
150 wxPyTState* state = wxPyBeginBlockThreads();
151 if (m_myInst.findCallback("GetDataHere")) {
153 ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
155 rval = (ro != Py_None && PyString_Check(ro));
157 memcpy(buf, PyString_AsString(ro), PyString_Size(ro));
161 wxPyEndBlockThreads(state);
165 bool wxPyDataObjectSimple::SetData(size_t len, const void *buf) {
166 // For this one we simply need to make a string from buf and len
167 // and send it to the Python method.
169 wxPyTState* state = wxPyBeginBlockThreads();
170 if (m_myInst.findCallback("SetData")) {
171 PyObject* data = PyString_FromStringAndSize((char*)buf, len);
172 rval = m_myInst.callCallback(Py_BuildValue("(O)", data));
175 wxPyEndBlockThreads(state);
182 // Now define it for SWIG
183 class wxPyDataObjectSimple : public wxDataObjectSimple {
185 wxPyDataObjectSimple(const wxDataFormat& format = wxPyFormatInvalid);
186 void _setCallbackInfo(PyObject* self, PyObject* _class);
187 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDataObjectSimple)"
190 //----------------------------------------------------------------------
192 class wxDataObjectComposite : public wxDataObject {
194 wxDataObjectComposite();
196 void Add(wxDataObjectSimple *dataObject, int preferred = FALSE);
197 %pragma(python) addtomethod = "Add:_args[0].thisown = 0"
202 //----------------------------------------------------------------------
204 class wxTextDataObject : public wxDataObjectSimple {
206 wxTextDataObject(const wxString& text = wxEmptyString);
208 size_t GetTextLength();
210 void SetText(const wxString& text);
215 %{ // Create a new class for wxPython to use
216 class wxPyTextDataObject : public wxTextDataObject {
218 wxPyTextDataObject(const wxString& text = wxEmptyString)
219 : wxTextDataObject(text) {}
221 DEC_PYCALLBACK_SIZET_(GetTextLength);
222 DEC_PYCALLBACK_STRING_(GetText);
223 DEC_PYCALLBACK__STRING(SetText);
227 IMP_PYCALLBACK_SIZET_(wxPyTextDataObject, wxTextDataObject, GetTextLength);
228 IMP_PYCALLBACK_STRING_(wxPyTextDataObject, wxTextDataObject, GetText);
229 IMP_PYCALLBACK__STRING(wxPyTextDataObject, wxTextDataObject, SetText);
234 // Now define it for SWIG
235 class wxPyTextDataObject : public wxTextDataObject {
237 wxPyTextDataObject(const wxString& text = wxEmptyString);
238 void _setCallbackInfo(PyObject* self, PyObject* _class);
239 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTextDataObject)"
242 //----------------------------------------------------------------------
244 class wxBitmapDataObject : public wxDataObjectSimple {
246 wxBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
248 wxBitmap GetBitmap();
249 void SetBitmap(const wxBitmap& bitmap);
254 %{ // Create a new class for wxPython to use
255 class wxPyBitmapDataObject : public wxBitmapDataObject {
257 wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap)
258 : wxBitmapDataObject(bitmap) {}
260 wxBitmap GetBitmap();
261 void SetBitmap(const wxBitmap& bitmap);
265 wxBitmap wxPyBitmapDataObject::GetBitmap() {
266 wxBitmap* rval = &wxNullBitmap;
267 wxPyTState* state = wxPyBeginBlockThreads();
268 if (m_myInst.findCallback("GetBitmap")) {
271 ro = m_myInst.callCallbackObj(Py_BuildValue("()"));
273 if (!SWIG_GetPtrObj(ro, (void **)&ptr, "_wxBitmap_p"))
278 wxPyEndBlockThreads(state);
282 void wxPyBitmapDataObject::SetBitmap(const wxBitmap& bitmap) {
283 wxPyTState* state = wxPyBeginBlockThreads();
284 if (m_myInst.findCallback("SetBitmap")) {
285 m_myInst.callCallback(Py_BuildValue("(O)",
286 wxPyConstructObject((void*)&bitmap, "wxBitmap")));
288 wxPyEndBlockThreads(state);
294 // Now define it for SWIG
295 class wxPyBitmapDataObject : public wxBitmapDataObject {
297 wxPyBitmapDataObject(const wxBitmap& bitmap = wxNullBitmap);
298 void _setCallbackInfo(PyObject* self, PyObject* _class);
299 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyBitmapDataObject)"
303 //----------------------------------------------------------------------
305 class wxFileDataObject : public wxDataObjectSimple
310 //const wxArrayString& GetFilenames();
312 PyObject* GetFilenames() {
313 const wxArrayString& strings = self->GetFilenames();
314 PyObject* list = PyList_New(0);
315 for (size_t x=0; x<strings.GetCount(); x++)
316 PyList_Append(list, PyString_FromString(strings[x]));
321 void AddFile(const wxString &filename);
326 //----------------------------------------------------------------------
328 class wxCustomDataObject : public wxDataObjectSimple {
330 wxCustomDataObject(const wxDataFormat& format = wxPyFormatInvalid);
332 //void TakeData(size_t size, void *data);
333 //bool SetData(size_t size, const void *buf);
335 void TakeData(PyObject* data) {
336 if (PyString_Check(data)) {
337 self->SetData(PyString_Size(data), PyString_AsString(data));
340 bool SetData(PyObject* data) {
341 if (PyString_Check(data)) {
342 return self->SetData(PyString_Size(data), PyString_AsString(data));
352 PyObject* GetData() {
353 return PyString_FromStringAndSize((char*)self->GetData(), self->GetSize());
361 //----------------------------------------------------------------------
363 class wxURLDataObject : public wxDataObjectComposite {
368 void SetURL(const wxString& url);
371 //----------------------------------------------------------------------
372 //----------------------------------------------------------------------
373 //----------------------------------------------------------------------
375 class wxClipboard : public wxObject {
381 bool IsOpened() const;
383 bool AddData( wxDataObject *data );
384 %pragma(python) addtomethod = "AddData:_args[0].thisown = 0"
385 bool SetData( wxDataObject *data );
386 %pragma(python) addtomethod = "SetData:_args[0].thisown = 0"
388 bool IsSupported( const wxDataFormat& format );
389 bool GetData( wxDataObject& data );
392 void UsePrimarySelection( int primary = FALSE );
396 // See below in the init function...
397 wxClipboard* wxPyTheClipboard;
400 %name(wxTheClipboard) wxClipboard* wxPyTheClipboard;
403 //----------------------------------------------------------------------
404 //----------------------------------------------------------------------
408 wxDragError, // error prevented the d&d operation from completing
409 wxDragNone, // drag target didn't accept the data
410 wxDragCopy, // the data was successfully copied
411 wxDragMove, // the data was successfully moved (MSW only)
412 wxDragLink, // operation is a drag-link
413 wxDragCancel // the operation was cancelled by user (not an error)
416 bool wxIsDragResultOk(wxDragResult res);
418 //----------------------------------------------------------------------
420 class wxPyDropSource : public wxDropSource {
423 wxPyDropSource(wxWindow *win = NULL,
424 const wxCursor &cursorCopy = wxNullCursor,
425 const wxCursor &cursorMove = wxNullCursor,
426 const wxCursor &cursorStop = wxNullCursor)
427 : wxDropSource(win, cursorCopy, cursorMove, cursorStop) {}
429 wxPyDropSource(wxWindow *win = NULL,
430 const wxIcon &go = wxNullIcon)
431 : wxDropSource(win, go) {}
433 ~wxPyDropSource() { }
435 DEC_PYCALLBACK_BOOL_DR(GiveFeedback);
439 IMP_PYCALLBACK_BOOL_DR(wxPyDropSource, wxDropSource, GiveFeedback);
444 %name(wxDropSource) class wxPyDropSource {
447 wxPyDropSource(wxWindow *win = NULL,
448 const wxCursor &cursorCopy = wxNullCursor,
449 const wxCursor &cursorMove = wxNullCursor,
450 const wxCursor &cursorStop = wxNullCursor);
452 wxPyDropSource(wxWindow *win = NULL,
453 const wxIcon &go = wxNullIcon);
456 void _setCallbackInfo(PyObject* self, PyObject* _class, int incref);
457 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxDropSource, 0)"
460 void SetData(wxDataObject& data);
461 wxDataObject *GetDataObject();
462 void SetCursor(wxDragResult res, const wxCursor& cursor);
463 wxDragResult DoDragDrop(int bAllowMove = FALSE);
465 bool base_GiveFeedback(wxDragResult effect);
468 //----------------------------------------------------------------------
470 // Just a place holder for the type system. The real base class for
471 // wxPython is wxPyDropTarget
478 class wxPyDropTarget : public wxDropTarget {
480 wxPyDropTarget(wxDataObject *dataObject = NULL)
481 : wxDropTarget(dataObject) {}
483 // DEC_PYCALLBACK_SIZET_(GetFormatCount);
484 // DEC_PYCALLBACK_DATAFMT_SIZET(GetFormat);
486 DEC_PYCALLBACK__(OnLeave);
487 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
488 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
489 DEC_PYCALLBACK_DR_2WXCDR_pure(OnData);
490 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
495 // IMP_PYCALLBACK_SIZET_(wxPyDropTarget, wxDropTarget, GetFormatCount);
496 // IMP__PYCALLBACK_DATAFMT_SIZET(wxPyDropTarget, wxDropTarget, GetFormat);
498 IMP_PYCALLBACK__(wxPyDropTarget, wxDropTarget, OnLeave);
499 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnEnter);
500 IMP_PYCALLBACK_DR_2WXCDR(wxPyDropTarget, wxDropTarget, OnDragOver);
501 IMP_PYCALLBACK_DR_2WXCDR_pure(wxPyDropTarget, wxDropTarget, OnData);
502 IMP_PYCALLBACK_BOOL_INTINT(wxPyDropTarget, wxDropTarget, OnDrop);
507 class wxPyDropTarget : public wxDropTarget {
509 wxPyDropTarget(wxDataObject *dataObject = NULL);
510 %pragma(python) addtomethod = "__init__:if _args:_args[0].thisown = 0"
511 void _setCallbackInfo(PyObject* self, PyObject* _class);
512 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyDropTarget)"
516 wxDataObject *GetDataObject();
517 void SetDataObject(wxDataObject *dataObject);
518 %pragma(python) addtomethod = "SetDataObject:if _args:_args[0].thisown = 0"
520 // size_t base_GetFormatCount();
521 // wxDataFormat base_GetFormat(size_t n);
523 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
524 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
526 bool base_OnDrop(wxCoord x, wxCoord y);
527 //wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def) = 0;
529 // **** not sure about this one
535 //----------------------------------------------------------------------
538 class wxPyTextDropTarget : public wxTextDropTarget {
540 wxPyTextDropTarget() {}
542 DEC_PYCALLBACK_BOOL_INTINTSTR_pure(OnDropText);
544 DEC_PYCALLBACK__(OnLeave);
545 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
546 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
547 DEC_PYCALLBACK_DR_2WXCDR(OnData);
548 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
553 IMP_PYCALLBACK_BOOL_INTINTSTR_pure(wxPyTextDropTarget, wxTextDropTarget, OnDropText);
554 IMP_PYCALLBACK__(wxPyTextDropTarget, wxTextDropTarget, OnLeave);
555 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnEnter);
556 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnDragOver);
557 IMP_PYCALLBACK_DR_2WXCDR(wxPyTextDropTarget, wxTextDropTarget, OnData);
558 IMP_PYCALLBACK_BOOL_INTINT(wxPyTextDropTarget, wxTextDropTarget, OnDrop);
562 %name(wxTextDropTarget) class wxPyTextDropTarget : public wxPyDropTarget {
564 wxPyTextDropTarget();
565 void _setCallbackInfo(PyObject* self, PyObject* _class);
566 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTextDropTarget)"
568 //bool OnDropText(wxCoord x, wxCoord y, const wxString& text) = 0;
569 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
570 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
572 bool base_OnDrop(wxCoord x, wxCoord y);
573 wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
576 //----------------------------------------------------------------------
578 class wxPyFileDropTarget : public wxFileDropTarget {
580 wxPyFileDropTarget() {}
582 virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames);
584 DEC_PYCALLBACK__(OnLeave);
585 DEC_PYCALLBACK_DR_2WXCDR(OnEnter);
586 DEC_PYCALLBACK_DR_2WXCDR(OnDragOver);
587 DEC_PYCALLBACK_DR_2WXCDR(OnData);
588 DEC_PYCALLBACK_BOOL_INTINT(OnDrop);
593 bool wxPyFileDropTarget::OnDropFiles(wxCoord x, wxCoord y,
594 const wxArrayString& filenames) {
596 wxPyTState* state = wxPyBeginBlockThreads();
597 PyObject* list = PyList_New(0);
598 for (size_t i=0; i<filenames.GetCount(); i++) {
599 PyObject* str = PyString_FromString(filenames[i].c_str());
600 PyList_Append(list, str);
602 if (m_myInst.findCallback("OnDropFiles"))
603 rval = m_myInst.callCallback(Py_BuildValue("(iiO)",x,y,list));
605 wxPyEndBlockThreads(state);
611 IMP_PYCALLBACK__(wxPyFileDropTarget, wxFileDropTarget, OnLeave);
612 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnEnter);
613 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnDragOver);
614 IMP_PYCALLBACK_DR_2WXCDR(wxPyFileDropTarget, wxFileDropTarget, OnData);
615 IMP_PYCALLBACK_BOOL_INTINT(wxPyFileDropTarget, wxFileDropTarget, OnDrop);
620 %name(wxFileDropTarget) class wxPyFileDropTarget : public wxPyDropTarget
623 wxPyFileDropTarget();
624 void _setCallbackInfo(PyObject* self, PyObject* _class);
625 %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxFileDropTarget)"
627 // bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& filenames) = 0;
628 wxDragResult base_OnEnter(wxCoord x, wxCoord y, wxDragResult def);
629 wxDragResult base_OnDragOver(wxCoord x, wxCoord y, wxDragResult def);
631 bool base_OnDrop(wxCoord x, wxCoord y);
632 wxDragResult base_OnData(wxCoord x, wxCoord y, wxDragResult def);
635 //----------------------------------------------------------------------
636 //----------------------------------------------------------------------
637 //----------------------------------------------------------------------
641 wxPyTheClipboard = wxTheClipboard;
642 wxPyPtrTypeMap_Add("wxDropSource", "wxPyDropSource");
643 wxPyPtrTypeMap_Add("wxTextDropTarget", "wxPyTextDropTarget");
644 wxPyPtrTypeMap_Add("wxFileDropTarget", "wxPyFileDropTarget");
647 //----------------------------------------------------------------------