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
|
.. 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.FileSystemWatcherEvent:
==========================================================================================================================================
|phoenix_title| **wx.FileSystemWatcherEvent**
==========================================================================================================================================
A class of events sent when a file system event occurs.
Types of events reported may vary depending on a platform, however all platforms report at least creation of new file/directory and access, modification, move (rename) or deletion of an existing one.
.. versionadded:: 2.9.1
.. seealso:: :ref:`wx.FileSystemWatcher`
.. seealso:: :ref:`Events and Event Handling <events and event handling>`
|
|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>FileSystemWatcherEvent</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.FileSystemWatcherEvent_inheritance.png" alt="Inheritance diagram of FileSystemWatcherEvent" 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.FileSystemWatcherEvent.html" title="wx.FileSystemWatcherEvent" alt="" coords="5,160,203,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="65,83,143,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="63,5,144,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FileSystemWatcherEvent.__init__`
:meth:`~wx.FileSystemWatcherEvent.Clone`
:meth:`~wx.FileSystemWatcherEvent.GetChangeType` Returns the type of file system change that occurred.
:meth:`~wx.FileSystemWatcherEvent.GetErrorDescription` Return a description of the warning or error if this is an error event.
:meth:`~wx.FileSystemWatcherEvent.GetNewPath` Returns the new path of the renamed file/directory if this is a rename event.
:meth:`~wx.FileSystemWatcherEvent.GetPath` Returns the path at which the event occurred.
:meth:`~wx.FileSystemWatcherEvent.GetWarningType` Return the type of the warning if this event is a warning one.
:meth:`~wx.FileSystemWatcherEvent.IsError` Returns ``true`` if this error is an error event.
:meth:`~wx.FileSystemWatcherEvent.ToString` Returns a :ref:`String` describing an event, useful for logging, debugging or testing.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FileSystemWatcherEvent.ChangeType` See :meth:`~wx.FileSystemWatcherEvent.GetChangeType`
:attr:`~wx.FileSystemWatcherEvent.ErrorDescription` See :meth:`~wx.FileSystemWatcherEvent.GetErrorDescription`
:attr:`~wx.FileSystemWatcherEvent.NewPath` See :meth:`~wx.FileSystemWatcherEvent.GetNewPath`
:attr:`~wx.FileSystemWatcherEvent.Path` See :meth:`~wx.FileSystemWatcherEvent.GetPath`
:attr:`~wx.FileSystemWatcherEvent.WarningType` See :meth:`~wx.FileSystemWatcherEvent.GetWarningType`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FileSystemWatcherEvent(Event)
**Possible constructors**::
FileSystemWatcherEvent(changeType=0, watchid=ID_ANY)
FileSystemWatcherEvent(changeType, warningType, errorMsg,
watchid=ID_ANY)
FileSystemWatcherEvent(changeType, path, newPath, watchid=ID_ANY)
A class of events sent when a file system event occurs.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, changeType=0, watchid=ID_ANY)`
:param `changeType`:
:type `changeType`: int
:param `watchid`:
:type `watchid`: int
**~~~**
**__init__** `(self, changeType, warningType, errorMsg, watchid=ID_ANY)`
:param `changeType`:
:type `changeType`: int
:param `warningType`:
:type `warningType`: wx.FSWWarningType
:param `errorMsg`:
:type `errorMsg`: string
:param `watchid`:
:type `watchid`: int
**~~~**
**__init__** `(self, changeType, path, newPath, watchid=ID_ANY)`
:param `changeType`:
:type `changeType`: int
:param `path`:
:type `path`: string
:param `newPath`:
:type `newPath`: string
:param `watchid`:
:type `watchid`: int
**~~~**
.. method:: Clone(self)
:rtype: :ref:`wx.Event`
.. method:: GetChangeType(self)
Returns the type of file system change that occurred.
See FSWFlags for the list of possible file system change types.
:rtype: `int`
.. method:: GetErrorDescription(self)
Return a description of the warning or error if this is an error event.
This string may be empty if the exact reason for the error or the warning is not known.
:rtype: `string`
.. method:: GetNewPath(self)
Returns the new path of the renamed file/directory if this is a rename event.
Otherwise it returns the same path as :meth:`GetPath` .
:rtype: `string`
.. method:: GetPath(self)
Returns the path at which the event occurred.
:rtype: `string`
.. method:: GetWarningType(self)
Return the type of the warning if this event is a warning one.
If this is not a warning event, i.e. if :meth:`GetChangeType` doesn't include ``FSW_EVENT_WARNING``, returns ``FSW_WARNING_NONE``.
:rtype: :ref:`wx.FSWWarningType`
.. versionadded:: 3.0
.. method:: IsError(self)
Returns ``true`` if this error is an error event.
Error event is an event generated when a warning or error condition arises.
:rtype: `bool`
.. method:: ToString(self)
Returns a :ref:`String` describing an event, useful for logging, debugging or testing.
:rtype: `string`
.. attribute:: ChangeType
See :meth:`~wx.FileSystemWatcherEvent.GetChangeType`
.. attribute:: ErrorDescription
See :meth:`~wx.FileSystemWatcherEvent.GetErrorDescription`
.. attribute:: NewPath
See :meth:`~wx.FileSystemWatcherEvent.GetNewPath`
.. attribute:: Path
See :meth:`~wx.FileSystemWatcherEvent.GetPath`
.. attribute:: WarningType
See :meth:`~wx.FileSystemWatcherEvent.GetWarningType`
|
