Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype File = File (ManagedPtr File)
- class (GObject o, IsDescendantOf File o) => IsFile o
- toFile :: (MonadIO m, IsFile o) => o -> m File
- noFile :: Maybe File
- fileCheckFileOnDisk :: (HasCallStack, MonadIO m, IsFile a) => a -> m ()
- fileGetCompressionType :: (HasCallStack, MonadIO m, IsFile a) => a -> m CompressionType
- fileGetEncoding :: (HasCallStack, MonadIO m, IsFile a) => a -> m Encoding
- fileGetLocation :: (HasCallStack, MonadIO m, IsFile a) => a -> m File
- fileGetNewlineType :: (HasCallStack, MonadIO m, IsFile a) => a -> m NewlineType
- fileIsDeleted :: (HasCallStack, MonadIO m, IsFile a) => a -> m Bool
- fileIsExternallyModified :: (HasCallStack, MonadIO m, IsFile a) => a -> m Bool
- fileIsLocal :: (HasCallStack, MonadIO m, IsFile a) => a -> m Bool
- fileIsReadonly :: (HasCallStack, MonadIO m, IsFile a) => a -> m Bool
- fileNew :: (HasCallStack, MonadIO m) => m File
- fileSetLocation :: (HasCallStack, MonadIO m, IsFile a, IsFile b) => a -> Maybe b -> m ()
- getFileCompressionType :: (MonadIO m, IsFile o) => o -> m CompressionType
- getFileEncoding :: (MonadIO m, IsFile o) => o -> m Encoding
- 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 ()
- getFileNewlineType :: (MonadIO m, IsFile o) => o -> m NewlineType
- getFileReadOnly :: (MonadIO m, IsFile o) => o -> m Bool
Exported types
Memory-managed wrapper type.
Instances
GObject File Source # | |
Defined in GI.GtkSource.Objects.File gobjectType :: IO GType # | |
HasParentTypes File Source # | |
Defined in GI.GtkSource.Objects.File | |
type ParentTypes File Source # | |
Defined in GI.GtkSource.Objects.File |
class (GObject o, IsDescendantOf File o) => IsFile o Source #
Instances
(GObject o, IsDescendantOf File o) => IsFile o Source # | |
Defined in GI.GtkSource.Objects.File |
Methods
checkFileOnDisk
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> m CompressionType | Returns: the compression type. |
No description available in the introspection data.
Since: 3.14
getEncoding
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> m Encoding | Returns: the character encoding. |
getLocation
No description available in the introspection data.
Since: 3.14
getNewlineType
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> m NewlineType | Returns: the newline type. |
No description available in the introspection data.
Since: 3.14
isDeleted
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> m Bool | Returns: whether the file is local. |
isReadonly
:: (HasCallStack, MonadIO m, IsFile a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m) | |
=> m File | Returns: a new |
No description available in the introspection data.
Since: 3.14
setLocation
Sets the location.
Since: 3.14
Properties
compressionType
The compression type.
Since: 3.14
getFileCompressionType :: (MonadIO m, IsFile o) => o -> m CompressionType Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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 Source #
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 Source #
Get the value of the “read-only
” property.
When overloading is enabled, this is equivalent to
get
file #readOnly