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