GI.GtkSource.Objects.File

Exported types

newtype File

Constructors

File (ManagedPtr File)

Instances

GObject File

Methods

gobjectType :: File -> IO GType

IsObject File

IsFile File

class GObject o => IsFile o

Instances

(GObject a, UnknownAncestorError Constraint File a) => IsFile a

IsFile File

toFile :: (MonadIO m, IsFile o) => o -> m File

noFile :: Maybe File

Methods

checkFileOnDisk

fileCheckFileOnDisk

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m ()

Checks synchronously the file on disk, to know whether the file is externally modified, or has been deleted, and whether the file is read-only.

File doesn't create a FileMonitor to track those properties, so this function needs to be called instead. Creating lots of 'GI.Gio.Objects.FileMonitor.FileMonitor'\'s would take lots of resources.

Since this function is synchronous, it is advised to call it only on local files. See fileIsLocal.

Since: 3.18

getCompressionType

fileGetCompressionType

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m CompressionType

Returns: the compression type.

No description available in the introspection data.

Since: 3.14

getEncoding

fileGetEncoding

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m Encoding

Returns: the character encoding.

The encoding is initially Nothing. After a successful file loading or saving operation, the encoding is non-Nothing.

Since: 3.14

getLocation

fileGetLocation

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m File

Returns: the File.

No description available in the introspection data.

Since: 3.14

getNewlineType

fileGetNewlineType

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m NewlineType

Returns: the newline type.

No description available in the introspection data.

Since: 3.14

isDeleted

fileIsDeleted

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m Bool

Returns: whether the file has been deleted.

Returns whether the file has been deleted. If the File:location is Nothing, returns False.

To have an up-to-date value, you must first call fileCheckFileOnDisk.

Since: 3.18

isExternallyModified

fileIsExternallyModified

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m Bool

Returns: whether the file is externally modified.

Returns whether the file is externally modified. If the File:location is Nothing, returns False.

To have an up-to-date value, you must first call fileCheckFileOnDisk.

Since: 3.18

isLocal

fileIsLocal

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m Bool

Returns: whether the file is local.

Returns whether the file is local. If the File:location is Nothing, returns False.

Since: 3.18

isReadonly

fileIsReadonly

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: a File.

-> m Bool

Returns: whether the file is read-only.

Returns whether the file is read-only. If the File:location is Nothing, returns False.

To have an up-to-date value, you must first call fileCheckFileOnDisk.

Since: 3.18

new

fileNew

Arguments

:: (HasCallStack, MonadIO m)

=> m File

Returns: a new File object.

No description available in the introspection data.

Since: 3.14

setLocation

fileSetLocation

Arguments

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

=> a

file: a File.

-> Maybe b

location: the new File, or Nothing.

-> m ()

Sets the location.

Since: 3.14

Properties

compressionType

getFileCompressionType :: (MonadIO m, IsFile o) => o -> m CompressionType

encoding

getFileEncoding :: (MonadIO m, IsFile o) => o -> m Encoding

location

clearFileLocation :: (MonadIO m, IsFile o) => o -> m ()

constructFileLocation :: (IsFile o, IsFile a) => a -> IO (GValueConstruct o)

getFileLocation :: (MonadIO m, IsFile o) => o -> m File

setFileLocation :: (MonadIO m, IsFile o, IsFile a) => o -> a -> m ()

newlineType

getFileNewlineType :: (MonadIO m, IsFile o) => o -> m NewlineType

readOnly

getFileReadOnly :: (MonadIO m, IsFile o) => o -> m Bool