| Portability | portable (depends on GHC) |
|---|---|
| Stability | alpha |
| Maintainer | gtk2hs-devel@lists.sourceforge.net |
| Safe Haskell | Safe-Infered |
System.GIO.File.FileMonitor
Description
- newtype FileMonitor = FileMonitor (ForeignPtr FileMonitor)
- class GObjectClass o => FileMonitorClass o
- data FileMonitorEvent
- fileMonitorCancel :: FileMonitorClass monitor => monitor -> IO Bool
- fileMonitorIsCancelled :: FileMonitorClass monitor => monitor -> IO Bool
- fileMonitorCancelled :: FileMonitorClass monitor => ReadAttr monitor Bool
- fileMonitorRateLimit :: FileMonitorClass monitor => Attr monitor Int
- fileMonitorChanged :: FileMonitorClass monitor => Signal monitor (Maybe File -> Maybe File -> FileMonitorEvent -> IO ())
Details
Monitors a file or directory for changes.
To obtain a FileMonitor for a file or directory, use fileMonitor, or
fileMonitorDirectory .
To get informed about changes to the file or directory you are monitoring, connect to the changed signal. The signal will be emitted in the thread-default main context of the thread that the monitor was created in (though if the global default main context is blocked, this may cause notifications to be blocked even if the thread-default context is still running).
Types
newtype FileMonitor Source
Constructors
| FileMonitor (ForeignPtr FileMonitor) |
class GObjectClass o => FileMonitorClass o Source
Instances
Enums
data FileMonitorEvent Source
Specifies what type of event a monitor event is.
Methods
Arguments
| :: FileMonitorClass monitor | |
| => monitor | |
| -> IO Bool | returns |
Cancels a file monitor.
Arguments
| :: FileMonitorClass monitor | |
| => monitor | |
| -> IO Bool |
Returns whether the monitor is canceled.
Attributes
fileMonitorCancelled :: FileMonitorClass monitor => ReadAttr monitor BoolSource
Whether the monitor has been cancelled.
Default value: False
fileMonitorRateLimit :: FileMonitorClass monitor => Attr monitor IntSource
The limit of the monitor to watch for changes, in milliseconds.
Allowed values: >= 0
Default value: 800
Signals
fileMonitorChanged :: FileMonitorClass monitor => Signal monitor (Maybe File -> Maybe File -> FileMonitorEvent -> IO ())Source