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
|
.. 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.FileCtrlEvent:
==========================================================================================================================================
|phoenix_title| **wx.FileCtrlEvent**
==========================================================================================================================================
A file control event holds information about events associated with :ref:`wx.FileCtrl` objects.
.. _FileCtrlEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.FileCtrlEvent` parameter.
Event macros:
- EVT_FILECTRL_FILEACTIVATED: The user activated a file(by double-clicking or pressing Enter)
- EVT_FILECTRL_SELECTIONCHANGED: The user changed the current selection(by selecting or deselecting a file)
- EVT_FILECTRL_FOLDERCHANGED: The current folder of the file control has been changed
- EVT_FILECTRL_FILTERCHANGED: The current file filter of the file control has been changed
|
|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>FileCtrlEvent</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.FileCtrlEvent_inheritance.png" alt="Inheritance diagram of FileCtrlEvent" 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.Event.html" title="wx.Event" alt="" coords="38,83,116,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="5,160,149,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> <area shape="rect" id="node4" href="wx.FileCtrlEvent.html" title="wx.FileCtrlEvent" alt="" coords="17,237,137,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileCtrlEvent.__init__` Constructor.
:meth:`~wx.FileCtrlEvent.GetDirectory` Returns the current directory.
:meth:`~wx.FileCtrlEvent.GetFile` Returns the file selected (assuming it is only one file).
:meth:`~wx.FileCtrlEvent.GetFiles` Returns the files selected.
:meth:`~wx.FileCtrlEvent.GetFilterIndex` Returns the current file filter index.
:meth:`~wx.FileCtrlEvent.SetDirectory` Sets the directory of this event.
:meth:`~wx.FileCtrlEvent.SetFiles` Sets the files changed by this event.
:meth:`~wx.FileCtrlEvent.SetFilterIndex` Sets the filter index changed by this event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileCtrlEvent.Directory` See :meth:`~wx.FileCtrlEvent.GetDirectory` and :meth:`~wx.FileCtrlEvent.SetDirectory`
:attr:`~wx.FileCtrlEvent.File` See :meth:`~wx.FileCtrlEvent.GetFile`
:attr:`~wx.FileCtrlEvent.Files` See :meth:`~wx.FileCtrlEvent.GetFiles` and :meth:`~wx.FileCtrlEvent.SetFiles`
:attr:`~wx.FileCtrlEvent.FilterIndex` See :meth:`~wx.FileCtrlEvent.GetFilterIndex` and :meth:`~wx.FileCtrlEvent.SetFilterIndex`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileCtrlEvent(CommandEvent)
**Possible constructors**::
FileCtrlEvent(type, evtObject, id)
A file control event holds information about events associated with
FileCtrl objects.
.. method:: __init__(self, type, evtObject, id)
Constructor.
:param `type`:
:type `type`: wx.EventType
:param `evtObject`:
:type `evtObject`: wx.Object
:param `id`:
:type `id`: int
.. method:: GetDirectory(self)
Returns the current directory.
In case of a ``EVT_FILECTRL_FOLDERCHANGED``, this method returns the new directory.
:rtype: `string`
.. method:: GetFile(self)
Returns the file selected (assuming it is only one file).
:rtype: `string`
.. method:: GetFiles(self)
Returns the files selected.
In case of a ``EVT_FILECTRL_SELECTIONCHANGED``, this method returns the files selected after the event.
:rtype: `list of strings`
.. method:: GetFilterIndex(self)
Returns the current file filter index.
For a ``EVT_FILECTRL_FILTERCHANGED`` event, this method returns the new file filter index.
:rtype: `int`
.. versionadded:: 2.9.1
.. method:: SetDirectory(self, directory)
Sets the directory of this event.
:param `directory`:
:type `directory`: string
.. method:: SetFiles(self, files)
Sets the files changed by this event.
:param `files`:
:type `files`: list of strings
.. method:: SetFilterIndex(self, index)
Sets the filter index changed by this event.
:param `index`:
:type `index`: int
.. versionadded:: 2.9.1
.. attribute:: Directory
See :meth:`~wx.FileCtrlEvent.GetDirectory` and :meth:`~wx.FileCtrlEvent.SetDirectory`
.. attribute:: File
See :meth:`~wx.FileCtrlEvent.GetFile`
.. attribute:: Files
See :meth:`~wx.FileCtrlEvent.GetFiles` and :meth:`~wx.FileCtrlEvent.SetFiles`
.. attribute:: FilterIndex
See :meth:`~wx.FileCtrlEvent.GetFilterIndex` and :meth:`~wx.FileCtrlEvent.SetFilterIndex`
|
