GI.Gio.Objects.FileMonitor

Monitors a file or directory for changes.

To obtain a FileMonitor for a file or directory, use fileMonitor, fileMonitorFile, or fileMonitorDirectory.

To get informed about changes to the file or directory you are monitoring, connect to the FileMonitor::changed signal. The signal will be emitted in the [thread-default main context][g-main-context-push-thread-default] 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).

Exported types

newtype FileMonitor

Constructors

FileMonitor (ManagedPtr FileMonitor)

Instances

GObject FileMonitor

Methods

gobjectType :: FileMonitor -> IO GType

IsObject FileMonitor

IsFileMonitor FileMonitor

((~) * info (ResolveFileMonitorMethod t FileMonitor), MethodInfo * info FileMonitor p) => IsLabel t (FileMonitor -> p)

Methods

fromLabel :: Proxy# Symbol t -> FileMonitor -> p

((~) * info (ResolveFileMonitorMethod t FileMonitor), MethodInfo * info FileMonitor p) => IsLabelProxy t (FileMonitor -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> FileMonitor -> p

HasAttributeList * FileMonitor

type AttributeList FileMonitor

type AttributeList FileMonitor

type SignalList FileMonitor

type SignalList FileMonitor

class GObject o => IsFileMonitor o

Instances

(GObject a, UnknownAncestorError Constraint FileMonitor a) => IsFileMonitor a

IsFileMonitor FileMonitor

toFileMonitor :: IsFileMonitor o => o -> IO FileMonitor

noFileMonitor :: Maybe FileMonitor

Methods

cancel

data FileMonitorCancelMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileMonitor a) => MethodInfo * FileMonitorCancelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileMonitorCancelMethodInfo a -> signature -> s

fileMonitorCancel

Arguments

:: (HasCallStack, MonadIO m, IsFileMonitor a)

=> a

monitor: a FileMonitor.

-> m Bool

Returns: always True

Cancels a file monitor.

emitEvent

data FileMonitorEmitEventMethodInfo

Instances

((~) * signature (b -> c -> FileMonitorEvent -> m ()), MonadIO m, IsFileMonitor a, IsFile b, IsFile c) => MethodInfo * FileMonitorEmitEventMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileMonitorEmitEventMethodInfo a -> signature -> s

fileMonitorEmitEvent

Arguments

:: (HasCallStack, MonadIO m, IsFileMonitor a, IsFile b, IsFile c)

=> a

monitor: a FileMonitor.

-> b

child: a File.

-> c

otherFile: a File.

-> FileMonitorEvent

eventType: a set of FileMonitorEvent flags.

-> m ()

Emits the FileMonitor::changed signal if a change has taken place. Should be called from file monitor implementations only.

Implementations are responsible to call this method from the [thread-default main context][g-main-context-push-thread-default] of the thread that the monitor was created in.

isCancelled

data FileMonitorIsCancelledMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileMonitor a) => MethodInfo * FileMonitorIsCancelledMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileMonitorIsCancelledMethodInfo a -> signature -> s

fileMonitorIsCancelled

Arguments

:: (HasCallStack, MonadIO m, IsFileMonitor a)

=> a

monitor: a FileMonitor

-> m Bool

Returns: True if monitor is canceled. False otherwise.

Returns whether the monitor is canceled.

setRateLimit

data FileMonitorSetRateLimitMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsFileMonitor a) => MethodInfo * FileMonitorSetRateLimitMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileMonitorSetRateLimitMethodInfo a -> signature -> s

fileMonitorSetRateLimit

Arguments

:: (HasCallStack, MonadIO m, IsFileMonitor a)

=> a

monitor: a FileMonitor.

-> Int32

limitMsecs: a non-negative integer with the limit in milliseconds to poll for changes

-> m ()

Sets the rate limit to which the monitor will report consecutive change events to the same file.

Properties

cancelled

data FileMonitorCancelledPropertyInfo

Instances

AttrInfo FileMonitorCancelledPropertyInfo

Associated Types

type AttrAllowedOps FileMonitorCancelledPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileMonitorCancelledPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo :: * -> Constraint

type AttrGetType FileMonitorCancelledPropertyInfo :: *

type AttrLabel FileMonitorCancelledPropertyInfo :: Symbol

type AttrOrigin FileMonitorCancelledPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo o => Proxy * FileMonitorCancelledPropertyInfo -> o -> IO (AttrGetType FileMonitorCancelledPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo o, AttrSetTypeConstraint FileMonitorCancelledPropertyInfo b) => Proxy * FileMonitorCancelledPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo o => Proxy * FileMonitorCancelledPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo o, AttrSetTypeConstraint FileMonitorCancelledPropertyInfo b) => Proxy * FileMonitorCancelledPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileMonitorCancelledPropertyInfo

type AttrOrigin FileMonitorCancelledPropertyInfo = FileMonitor

type AttrLabel FileMonitorCancelledPropertyInfo

type AttrLabel FileMonitorCancelledPropertyInfo = "cancelled"

type AttrGetType FileMonitorCancelledPropertyInfo

type AttrGetType FileMonitorCancelledPropertyInfo = Bool

type AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo

type AttrBaseTypeConstraint FileMonitorCancelledPropertyInfo = IsFileMonitor

type AttrSetTypeConstraint FileMonitorCancelledPropertyInfo

type AttrSetTypeConstraint FileMonitorCancelledPropertyInfo = * ~ ()

type AttrAllowedOps FileMonitorCancelledPropertyInfo

type AttrAllowedOps FileMonitorCancelledPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

fileMonitorCancelled :: AttrLabelProxy "cancelled"

getFileMonitorCancelled :: (MonadIO m, IsFileMonitor o) => o -> m Bool

rateLimit

data FileMonitorRateLimitPropertyInfo

Instances

AttrInfo FileMonitorRateLimitPropertyInfo

Associated Types

type AttrAllowedOps FileMonitorRateLimitPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileMonitorRateLimitPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo :: * -> Constraint

type AttrGetType FileMonitorRateLimitPropertyInfo :: *

type AttrLabel FileMonitorRateLimitPropertyInfo :: Symbol

type AttrOrigin FileMonitorRateLimitPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo o => Proxy * FileMonitorRateLimitPropertyInfo -> o -> IO (AttrGetType FileMonitorRateLimitPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo o, AttrSetTypeConstraint FileMonitorRateLimitPropertyInfo b) => Proxy * FileMonitorRateLimitPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo o => Proxy * FileMonitorRateLimitPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo o, AttrSetTypeConstraint FileMonitorRateLimitPropertyInfo b) => Proxy * FileMonitorRateLimitPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileMonitorRateLimitPropertyInfo

type AttrOrigin FileMonitorRateLimitPropertyInfo = FileMonitor

type AttrLabel FileMonitorRateLimitPropertyInfo

type AttrLabel FileMonitorRateLimitPropertyInfo = "rate-limit"

type AttrGetType FileMonitorRateLimitPropertyInfo

type AttrGetType FileMonitorRateLimitPropertyInfo = Int32

type AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo

type AttrBaseTypeConstraint FileMonitorRateLimitPropertyInfo = IsFileMonitor

type AttrSetTypeConstraint FileMonitorRateLimitPropertyInfo

type AttrSetTypeConstraint FileMonitorRateLimitPropertyInfo = * ~ Int32

type AttrAllowedOps FileMonitorRateLimitPropertyInfo

type AttrAllowedOps FileMonitorRateLimitPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileMonitorRateLimit :: IsFileMonitor o => Int32 -> IO (GValueConstruct o)

fileMonitorRateLimit :: AttrLabelProxy "rateLimit"

getFileMonitorRateLimit :: (MonadIO m, IsFileMonitor o) => o -> m Int32

setFileMonitorRateLimit :: (MonadIO m, IsFileMonitor o) => o -> Int32 -> m ()

Signals

changed

type C_FileMonitorChangedCallback = Ptr () -> Ptr File -> Ptr File -> CUInt -> Ptr () -> IO ()

type FileMonitorChangedCallback = File -> Maybe File -> FileMonitorEvent -> IO ()

data FileMonitorChangedSignalInfo

Instances

SignalInfo FileMonitorChangedSignalInfo

Associated Types

type HaskellCallbackType FileMonitorChangedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileMonitorChangedSignalInfo -> o -> HaskellCallbackType FileMonitorChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileMonitorChangedSignalInfo

type HaskellCallbackType FileMonitorChangedSignalInfo = FileMonitorChangedCallback

afterFileMonitorChanged :: (GObject a, MonadIO m) => a -> FileMonitorChangedCallback -> m SignalHandlerId

genClosure_FileMonitorChanged :: FileMonitorChangedCallback -> IO Closure

mk_FileMonitorChangedCallback :: C_FileMonitorChangedCallback -> IO (FunPtr C_FileMonitorChangedCallback)

noFileMonitorChangedCallback :: Maybe FileMonitorChangedCallback

onFileMonitorChanged :: (GObject a, MonadIO m) => a -> FileMonitorChangedCallback -> m SignalHandlerId

wrap_FileMonitorChangedCallback :: FileMonitorChangedCallback -> Ptr () -> Ptr File -> Ptr File -> CUInt -> Ptr () -> IO ()