GI.GtkSource.Objects.File

No description available in the introspection data.

Exported types

newtype File

Memory-managed wrapper type.

Constructors

File (ManagedPtr File)

Instances

GObject File

Defined in GI.GtkSource.Objects.File

Methods

gobjectType :: File -> IO GType

IsObject File

Defined in GI.GtkSource.Objects.File

IsFile File

Defined in GI.GtkSource.Objects.File

class GObject o => IsFile o

Type class for types which can be safely cast to File, for instance with toFile.

Instances

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

Defined in GI.GtkSource.Objects.File

IsFile File

Defined in GI.GtkSource.Objects.File

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

Cast to File, for types for which this is known to be safe. For general casts, use castTo.

noFile :: Maybe File

A convenience alias for Nothing :: 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

The compression type.

Since: 3.14

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

Get the value of the “compression-type” property. When overloading is enabled, this is equivalent to

get file #compressionType

encoding

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

Since: 3.14

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

Get the value of the “encoding” property. When overloading is enabled, this is equivalent to

get file #encoding

location

The location.

Since: 3.14

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

Set the value of the “location” property to Nothing. When overloading is enabled, this is equivalent to

clear #location

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

Construct a GValueConstruct with valid value for the “location” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “location” property. When overloading is enabled, this is equivalent to

get file #location

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

Set the value of the “location” property. When overloading is enabled, this is equivalent to

set file [ #location := value ]

newlineType

The line ending type.

Since: 3.14

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

Get the value of the “newline-type” property. When overloading is enabled, this is equivalent to

get file #newlineType

readOnly

Whether the file is read-only or not. The value of this property is not updated automatically (there is no file monitors).

Since: 3.18

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

Get the value of the “read-only” property. When overloading is enabled, this is equivalent to

get file #readOnly