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.

New in version 2.9.1.


class_hierarchy Class Hierarchy

Inheritance diagram for class FileSystemWatcherEvent:

method_summary Methods Summary

__init__

Clone

GetChangeType

Returns the type of file system change that occurred.

GetErrorDescription

Return a description of the warning or error if this is an error event.

GetNewPath

Returns the new path of the renamed file/directory if this is a rename event.

GetPath

Returns the path at which the event occurred.

GetWarningType

Return the type of the warning if this event is a warning one.

IsError

Returns true if this error is an error event.

ToString

Returns a String describing an event, useful for logging, debugging or testing.


property_summary Properties Summary

ChangeType

See GetChangeType

ErrorDescription

See GetErrorDescription

NewPath

See GetNewPath

Path

See GetPath

WarningType

See 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.

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, changeType=0, watchid=ID_ANY)

Parameters
  • changeType (int) –

  • watchid (int) –



__init__ (self, changeType, warningType, errorMsg, watchid=ID_ANY)

Parameters
  • changeType (int) –

  • warningType (FSWWarningType) –

  • errorMsg (string) –

  • watchid (int) –



__init__ (self, changeType, path, newPath, watchid=ID_ANY)

Parameters
  • changeType (int) –

  • path (string) –

  • newPath (string) –

  • watchid (int) –



Clone(self)
Return type

wx.Event

GetChangeType(self)

Returns the type of file system change that occurred.

See FSWFlags for the list of possible file system change types.

Return type

int

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.

Return type

string

GetNewPath(self)

Returns the new path of the renamed file/directory if this is a rename event.

Otherwise it returns the same path as GetPath .

Return type

string

GetPath(self)

Returns the path at which the event occurred.

Return type

string

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 GetChangeType doesn’t include FSW_EVENT_WARNING, returns FSW_WARNING_NONE.

Return type

wx.FSWWarningType

New in version 3.0.

IsError(self)

Returns true if this error is an error event.

Error event is an event generated when a warning or error condition arises.

Return type

bool

ToString(self)

Returns a String describing an event, useful for logging, debugging or testing.

Return type

string

ChangeType

See GetChangeType

ErrorDescription

See GetErrorDescription

NewPath

See GetNewPath

Path

See GetPath

WarningType

See GetWarningType