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
|
.. 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.FileDataObject:
==========================================================================================================================================
|phoenix_title| **wx.FileDataObject**
==========================================================================================================================================
:ref:`wx.FileDataObject` is a specialization of :ref:`wx.DataObject` for file names.
The program works with it just as if it were a list of absolute file names, but internally it uses the same format as Explorer and other compatible programs under Windows or GNOME/KDE file manager under Unix which makes it possible to receive files from them using this class.
.. seealso:: :ref:`wx.DataObject`, :ref:`wx.DataObjectSimple`, :ref:`wx.TextDataObject`, :ref:`wx.BitmapDataObject`, :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>FileDataObject</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.FileDataObject_inheritance.png" alt="Inheritance diagram of FileDataObject" 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.FileDataObject.html" title="wx.FileDataObject" alt="" coords="17,160,157,189"/> <area shape="rect" id="node2" href="wx.DataObjectSimple.html" title="wx.DataObjectSimple" alt="" coords="5,83,168,112"/> <area shape="rect" id="node3" href="wx.DataObject.html" title="wx.DataObject" alt="" coords="27,5,146,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileDataObject.__init__` Constructor.
:meth:`~wx.FileDataObject.AddFile` Adds a file to the file list represented by this data object (Windows only).
:meth:`~wx.FileDataObject.GetAllFormats` Returns a list of wx.DataFormat objects which this data object
:meth:`~wx.FileDataObject.GetFilenames` Returns the array of file names.
:meth:`~wx.FileDataObject.SetData`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileDataObject.AllFormats` See :meth:`~wx.FileDataObject.GetAllFormats`
:attr:`~wx.FileDataObject.Filenames` See :meth:`~wx.FileDataObject.GetFilenames`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileDataObject(DataObjectSimple)
**Possible constructors**::
FileDataObject()
FileDataObject is a specialization of DataObject for file names.
.. method:: __init__(self)
Constructor.
.. method:: AddFile(self, file)
Adds a file to the file list represented by this data object (Windows only).
:param `file`:
:type `file`: string
.. method:: GetAllFormats(self, dir=DataObject.Get)
Returns a list of wx.DataFormat objects which this data object
supports transferring in the given direction.
.. method:: GetFilenames(self)
Returns the array of file names.
:rtype: `list of strings`
.. method:: SetData(self, format, buf)
:rtype: `bool`
.. attribute:: AllFormats
See :meth:`~wx.FileDataObject.GetAllFormats`
.. attribute:: Filenames
See :meth:`~wx.FileDataObject.GetFilenames`
|
