Document that wxFileSystemWatcher requires a running event loop

On Gtk and OS X, but unfortunately not MSW, an assert fails if a
wxFileSystemWatcher is created too early. Therefore give a hint about
where and when one should be created.

Closes https://github.com/wxWidgets/wxWidgets/pull/287
This commit is contained in:
Lauri Nurmi
2016-05-18 09:39:41 +03:00
committed by Vadim Zeitlin
parent 5b597cd0e8
commit d51ce354c1

View File

@@ -21,6 +21,13 @@
version doesn't currently collapse pairs of create/delete events in a version doesn't currently collapse pairs of create/delete events in a
rename event, unlike the other ones. rename event, unlike the other ones.
@note The application's event loop needs to be running before a
wxFileSystemWatcher can be properly created, and that is why one
should not be created too early during application startup.
If you intend to create a wxFileSystemWatcher at startup, you can
override wxAppConsole::OnEventLoopEnter() to ensure it is not done
too early.
For the full list of change types that are reported see wxFSWFlags. For the full list of change types that are reported see wxFSWFlags.
This class notifies the application about the file system changes by This class notifies the application about the file system changes by