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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.DropTarget:
==========================================================================================================================================
|phoenix_title| **wx.DropTarget**
==========================================================================================================================================
This class represents a target for a drag and drop operation.
A :ref:`wx.DataObject` can be associated with it and by default, this object will be filled with the data from the drag source, if the data formats supported by the data object match the drag source data format.
There are various virtual handler functions defined in this class which may be overridden to give visual feedback or react in a more fine-tuned way, e.g. by not accepting data on the whole window area, but only a small portion of it. The normal sequence of calls is :meth:`~wx.DropTarget.OnEnter`, :meth:`~wx.DropTarget.OnDragOver` possibly many times, :meth:`~wx.DropTarget.OnDrop` and finally :meth:`~wx.DropTarget.OnData`.
.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`DataObject Overview <dataobject overview>`, :ref:`wx.DropSource`, :ref:`wx.TextDropTarget`, :ref:`wx.FileDropTarget`, :ref:`wx.DataFormat`, :ref:`wx.DataObject`
|
|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>DropTarget</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.DropTarget_inheritance.png" alt="Inheritance diagram of DropTarget" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.DropTarget.html" title="wx.DropTarget" alt="" coords="5,5,121,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.FileDropTarget`, :ref:`wx.TextDropTarget`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.DropTarget.__init__` Constructor.
:meth:`~wx.DropTarget.GetData` This method may only be called from within :meth:`~DropTarget.OnData` .
:meth:`~wx.DropTarget.GetDataObject` Returns the data :ref:`wx.DataObject` associated with the drop target.
:meth:`~wx.DropTarget.GetDefaultAction` Returns default action for drag and drop or DragNone if this not specified.
:meth:`~wx.DropTarget.OnData` Called after :meth:`~DropTarget.OnDrop` returns ``True``.
:meth:`~wx.DropTarget.OnDragOver` Called when the mouse is being dragged over the drop target.
:meth:`~wx.DropTarget.OnDrop` Called when the user drops a data object on the target.
:meth:`~wx.DropTarget.OnEnter` Called when the mouse enters the drop target.
:meth:`~wx.DropTarget.OnLeave` Called when the mouse leaves the drop target.
:meth:`~wx.DropTarget.SetDataObject` Sets the data :ref:`wx.DataObject` associated with the drop target and deletes any previously associated data object.
:meth:`~wx.DropTarget.SetDefaultAction` Sets the default action for drag and drop.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.DropTarget.Data` See :meth:`~wx.DropTarget.GetData`
:attr:`~wx.DropTarget.DataObject` See :meth:`~wx.DropTarget.GetDataObject` and :meth:`~wx.DropTarget.SetDataObject`
:attr:`~wx.DropTarget.DefaultAction` See :meth:`~wx.DropTarget.GetDefaultAction` and :meth:`~wx.DropTarget.SetDefaultAction`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.DropTarget(object)
**Possible constructors**::
DropTarget(data=None)
This class represents a target for a drag and drop operation.
.. method:: __init__(self, data=None)
Constructor.
`data` is the data to be associated with the drop target.
:param `data`:
:type `data`: wx.DataObject
.. method:: GetData(self)
This method may only be called from within :meth:`OnData` .
By default, this method copies the data from the drop source to the :ref:`wx.DataObject` associated with this drop target, calling its :meth:`wx.DataObject.SetData` method.
:rtype: `bool`
.. method:: GetDataObject(self)
Returns the data :ref:`wx.DataObject` associated with the drop target.
:rtype: :ref:`wx.DataObject`
.. method:: GetDefaultAction(self)
Returns default action for drag and drop or DragNone if this not specified.
:rtype: :ref:`wx.DragResult`
.. method:: OnData(self, x, y, defResult)
Called after :meth:`OnDrop` returns ``True``.
By default this will usually :meth:`GetData` and will return the suggested default value `defResult`.
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:param `defResult`:
:type `defResult`: wx.DragResult
:rtype: :ref:`wx.DragResult`
.. method:: OnDragOver(self, x, y, defResult)
Called when the mouse is being dragged over the drop target.
By default, this calls functions return the suggested return value `defResult`.
:param `x`: The x coordinate of the mouse.
:type `x`: int
:param `y`: The y coordinate of the mouse.
:type `y`: int
:param `defResult`: Suggested value for return value. Determined by ``SHIFT`` or ``CONTROL`` key states.
:type `defResult`: wx.DragResult
:rtype: :ref:`wx.DragResult`
:returns:
The desired operation or DragNone. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
.. method:: OnDrop(self, x, y)
Called when the user drops a data object on the target.
Return ``False`` to veto the operation.
:param `x`: The x coordinate of the mouse.
:type `x`: int
:param `y`: The y coordinate of the mouse.
:type `y`: int
:rtype: `bool`
:returns:
``True`` to accept the data, or ``False`` to veto the operation.
.. method:: OnEnter(self, x, y, defResult)
Called when the mouse enters the drop target.
By default, this calls :meth:`OnDragOver` .
:param `x`: The x coordinate of the mouse.
:type `x`: int
:param `y`: The y coordinate of the mouse.
:type `y`: int
:param `defResult`: Suggested default for return value. Determined by ``SHIFT`` or ``CONTROL`` key states.
:type `defResult`: wx.DragResult
:rtype: :ref:`wx.DragResult`
:returns:
The desired operation or DragNone. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
.. method:: OnLeave(self)
Called when the mouse leaves the drop target.
.. method:: SetDataObject(self, data)
Sets the data :ref:`wx.DataObject` associated with the drop target and deletes any previously associated data object.
:param `data`:
:type `data`: wx.DataObject
.. method:: SetDefaultAction(self, action)
Sets the default action for drag and drop.
Use DragMove or DragCopy to set default action to move or copy and use DragNone (default) to set default action specified by initialization of dragging (see :meth:`wx.DropSource.DoDragDrop` )
:param `action`:
:type `action`: wx.DragResult
.. attribute:: Data
See :meth:`~wx.DropTarget.GetData`
.. attribute:: DataObject
See :meth:`~wx.DropTarget.GetDataObject` and :meth:`~wx.DropTarget.SetDataObject`
.. attribute:: DefaultAction
See :meth:`~wx.DropTarget.GetDefaultAction` and :meth:`~wx.DropTarget.SetDefaultAction`
|
