1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.DropSource:
==========================================================================================================================================
|phoenix_title| **wx.DropSource**
==========================================================================================================================================
This class represents a source for a drag and drop operation.
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`DataObject Overview <dataobject overview>`, :ref:`wx.DropTarget`, :ref:`wx.TextDropTarget`, :ref:`wx.FileDropTarget`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>DropSource</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.DropSource_inheritance.png" alt="Inheritance diagram of DropSource" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.DropSource.html" title="wx.DropSource" alt="" coords="5,5,123,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DropSource.__init__` This constructor requires that you must call :meth:`~DropSource.SetData` later.
:meth:`~wx.DropSource.DoDragDrop` Starts the drag-and-drop operation which will terminate when the user releases the mouse.
:meth:`~wx.DropSource.GetDataObject` Returns the :ref:`wx.DataObject` object that has been assigned previously.
:meth:`~wx.DropSource.GiveFeedback` You may give some custom UI feedback during the drag and drop operation by overriding this function.
:meth:`~wx.DropSource.SetCursor` Set the icon to use for a certain drag result.
:meth:`~wx.DropSource.SetData` Sets the data :ref:`wx.DataObject` associated with the drop source.
:meth:`~wx.DropSource.SetIcon` Set the icon to use for a certain drag result.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DropSource.DataObject` See :meth:`~wx.DropSource.GetDataObject`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DropSource(object)
**Possible constructors**::
DropSource(win=None)
DropSource(data, win=None)
This class represents a source for a drag and drop operation.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, win=None)`
This constructor requires that you must call :meth:`SetData` later.
Note that the type of `iconCopy` and subsequent parameters differs between different ports: these are cursors under Windows and OS X but icons for GTK. You should use the macro ``DROP_ICON`` in portable programs instead of directly using either of these types.
:param `win`: The window which initiates the drag and drop operation.
:type `win`: wx.Window
.. availability:: Only available for MSW, OSX.
**~~~**
**__init__** `(self, data, win=None)`
The constructor taking a :ref:`wx.DataObject`.
Note that the type of `iconCopy` and subsequent parameters differs between different ports: these are cursors under Windows and OS X but icons for GTK. You should use the macro ``DROP_ICON`` in portable programs instead of directly using either of these types.
:param `data`: The data associated with the drop source.
:type `data`: wx.DataObject
:param `win`: The window which initiates the drag and drop operation.
:type `win`: wx.Window
.. availability:: Only available for MSW, OSX.
**~~~**
.. method:: DoDragDrop(self, flags=Drag_CopyOnly)
Starts the drag-and-drop operation which will terminate when the user releases the mouse.
Call this in response to a mouse button press, for example.
:param `flags`: If :ref:`wx.Drag_AllowMove` is included in the flags, data may be moved and not only copied as is the case for the default :ref:`wx.Drag_CopyOnly`. If :ref:`wx.Drag_DefaultMove` is specified (which includes the previous flag), moving is not only possible but becomes the default operation.
:type `flags`: int
:rtype: :ref:`wx.DragResult`
:returns:
The operation requested by the user, may be :ref:`wx.DragCopy`, :ref:`wx.DragMove`, :ref:`wx.DragLink`, :ref:`wx.DragCancel` or :ref:`wx.DragNone` if an error occurred.
.. method:: GetDataObject(self)
Returns the :ref:`wx.DataObject` object that has been assigned previously.
:rtype: :ref:`wx.DataObject`
.. method:: GiveFeedback(self, effect)
You may give some custom UI feedback during the drag and drop operation by overriding this function.
It is called on each mouse move, so your implementation must not be too slow.
:param `effect`: The effect to implement. One of :ref:`wx.DragCopy`, :ref:`wx.DragMove`, :ref:`wx.DragLink` and :ref:`wx.DragNone`.
:type `effect`: wx.DragResult
:rtype: `bool`
:returns:
``False`` if you want default feedback, or ``True`` if you implement your own feedback. The return value is ignored under GTK.
.. method:: SetCursor(self, res, cursor)
Set the icon to use for a certain drag result.
:param `res`: The drag result to set the icon for.
:type `res`: wx.DragResult
:param `cursor`: The icon to show when this drag result occurs.
:type `cursor`: wx.Cursor
MSW, OSX ports.
.. availability:: Only available for MSW, OSX.
.. method:: SetData(self, data)
Sets the data :ref:`wx.DataObject` associated with the drop source.
This will not delete any previously associated data.
:param `data`:
:type `data`: wx.DataObject
.. method:: SetIcon(self, res, icon)
Set the icon to use for a certain drag result.
:param `res`: The drag result to set the icon for.
:type `res`: wx.DragResult
:param `icon`: The icon to show when this drag result occurs.
:type `icon`: wx.Icon
GTK port.
.. availability:: Only available for GTK.
.. attribute:: DataObject
See :meth:`~wx.DropSource.GetDataObject`
|
