File: wx.FileDropTarget.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (154 lines) | stat: -rw-r--r-- 3,696 bytes parent folder | download
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
.. 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.FileDropTarget:

==========================================================================================================================================
|phoenix_title|  **wx.FileDropTarget**
==========================================================================================================================================

This is a drop target which accepts files (dragged from File Manager or Explorer).          







         



.. seealso:: :ref:`Drag and Drop Overview <drag and drop overview>`, :ref:`wx.DropSource`, :ref:`wx.DropTarget`, :ref:`wx.TextDropTarget`    







|

|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>FileDropTarget</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.FileDropTarget_inheritance.png" alt="Inheritance diagram of FileDropTarget" 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.DropTarget.html" title="wx.DropTarget" alt="" coords="15,5,125,35"/> <area shape="rect" id="node2" href="wx.FileDropTarget.html" title="wx.FileDropTarget" alt="" coords="5,83,136,112"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.FileDropTarget.__init__`                                              Constructor.
:meth:`~wx.FileDropTarget.OnDrop`                                                See :meth:`wx.DropTarget.OnDrop` .
:meth:`~wx.FileDropTarget.OnDropFiles`                                           Override this function to receive dropped files.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.FileDropTarget(DropTarget)

   **Possible constructors**::

       FileDropTarget()
       
   
   This is a drop target which accepts files (dragged from File Manager
   or Explorer).



   .. method:: __init__(self)

      Constructor.                   





   .. method:: OnDrop(self, x, y)

      See :meth:`wx.DropTarget.OnDrop` .                  

      This function is implemented appropriately for files, and calls :meth:`OnDropFiles` .                  


      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int




      :rtype: `bool`








   .. method:: OnDropFiles(self, x, y, filenames)

      Override this function to receive dropped files.                  




      :param `x`: The x coordinate of the mouse.   
      :type `x`: int
      :param `y`: The y coordinate of the mouse.   
      :type `y`: int
      :param `filenames`: An array of filenames.  
      :type `filenames`: list of strings










      :rtype: `bool`