Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GtkSource.Objects.File

Contents

Exported types
Methods
Properties

Description

Synopsis

Exported types

newtype File Source #

Constructors

File (ManagedPtr File)

Instances

GObject File Source #
Methods gobjectType :: File -> IO GType #
IsObject File Source #

IsFile File Source #

((~) * info (ResolveFileMethod t File), MethodInfo * info File p) => IsLabel t (File -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> File -> p #
((~) * info (ResolveFileMethod t File), MethodInfo * info File p) => IsLabelProxy t (File -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> File -> p #
HasAttributeList * File Source #

type AttributeList File Source #
type AttributeList File
type SignalList File Source #
type SignalList File

class GObject o => IsFile o Source #

Instances

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

IsFile File Source #

toFile :: IsFile o => o -> IO File Source #

noFile :: Maybe File Source #

Methods

checkFileOnDisk

data FileCheckFileOnDiskMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsFile a) => MethodInfo * FileCheckFileOnDiskMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileCheckFileOnDiskMethodInfo a -> signature -> s #

fileCheckFileOnDisk Source #

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

data FileGetCompressionTypeMethodInfo Source #

Instances

((~) * signature (m CompressionType), MonadIO m, IsFile a) => MethodInfo * FileGetCompressionTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileGetCompressionTypeMethodInfo a -> signature -> s #

fileGetCompressionType Source #

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

data FileGetEncodingMethodInfo Source #

Instances

((~) * signature (m Encoding), MonadIO m, IsFile a) => MethodInfo * FileGetEncodingMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileGetEncodingMethodInfo a -> signature -> s #

fileGetEncoding Source #

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

data FileGetLocationMethodInfo Source #

Instances

((~) * signature (m File), MonadIO m, IsFile a) => MethodInfo * FileGetLocationMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileGetLocationMethodInfo a -> signature -> s #

fileGetLocation Source #

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

data FileGetNewlineTypeMethodInfo Source #

Instances

((~) * signature (m NewlineType), MonadIO m, IsFile a) => MethodInfo * FileGetNewlineTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileGetNewlineTypeMethodInfo a -> signature -> s #

fileGetNewlineType Source #

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

data FileIsDeletedMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsFile a) => MethodInfo * FileIsDeletedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileIsDeletedMethodInfo a -> signature -> s #

fileIsDeleted Source #

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

data FileIsExternallyModifiedMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsFile a) => MethodInfo * FileIsExternallyModifiedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileIsExternallyModifiedMethodInfo a -> signature -> s #

fileIsExternallyModified Source #

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

data FileIsLocalMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsFile a) => MethodInfo * FileIsLocalMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileIsLocalMethodInfo a -> signature -> s #

fileIsLocal Source #

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

data FileIsReadonlyMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsFile a) => MethodInfo * FileIsReadonlyMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileIsReadonlyMethodInfo a -> signature -> s #

fileIsReadonly Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m File	Returns: a new `File` object.

No description available in the introspection data.

Since: 3.14

setLocation

data FileSetLocationMethodInfo Source #

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsFile a, IsFile b) => MethodInfo * FileSetLocationMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileSetLocationMethodInfo a -> signature -> s #

fileSetLocation Source #

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

data FileCompressionTypePropertyInfo Source #

Instances

AttrInfo FileCompressionTypePropertyInfo Source #
Associated Types type AttrAllowedOps FileCompressionTypePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileCompressionTypePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileCompressionTypePropertyInfo :: * -> Constraint # type AttrGetType FileCompressionTypePropertyInfo :: * # type AttrLabel FileCompressionTypePropertyInfo :: Symbol # type AttrOrigin FileCompressionTypePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileCompressionTypePropertyInfo o => Proxy * FileCompressionTypePropertyInfo -> o -> IO (AttrGetType FileCompressionTypePropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileCompressionTypePropertyInfo o, AttrSetTypeConstraint FileCompressionTypePropertyInfo b) => Proxy * FileCompressionTypePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileCompressionTypePropertyInfo o => Proxy * FileCompressionTypePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileCompressionTypePropertyInfo o, AttrSetTypeConstraint FileCompressionTypePropertyInfo b) => Proxy * FileCompressionTypePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileCompressionTypePropertyInfo Source #
type AttrOrigin FileCompressionTypePropertyInfo = File
type AttrLabel FileCompressionTypePropertyInfo Source #
type AttrLabel FileCompressionTypePropertyInfo = "compression-type"
type AttrGetType FileCompressionTypePropertyInfo Source #
type AttrGetType FileCompressionTypePropertyInfo = CompressionType
type AttrBaseTypeConstraint FileCompressionTypePropertyInfo Source #
type AttrBaseTypeConstraint FileCompressionTypePropertyInfo = IsFile
type AttrSetTypeConstraint FileCompressionTypePropertyInfo Source #
type AttrSetTypeConstraint FileCompressionTypePropertyInfo = * ~ ()
type AttrAllowedOps FileCompressionTypePropertyInfo Source #
type AttrAllowedOps FileCompressionTypePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

fileCompressionType :: AttrLabelProxy "compressionType" Source #

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

encoding

data FileEncodingPropertyInfo Source #

Instances

AttrInfo FileEncodingPropertyInfo Source #
Associated Types type AttrAllowedOps FileEncodingPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileEncodingPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileEncodingPropertyInfo :: * -> Constraint # type AttrGetType FileEncodingPropertyInfo :: * # type AttrLabel FileEncodingPropertyInfo :: Symbol # type AttrOrigin FileEncodingPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileEncodingPropertyInfo o => Proxy * FileEncodingPropertyInfo -> o -> IO (AttrGetType FileEncodingPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileEncodingPropertyInfo o, AttrSetTypeConstraint FileEncodingPropertyInfo b) => Proxy * FileEncodingPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileEncodingPropertyInfo o => Proxy * FileEncodingPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileEncodingPropertyInfo o, AttrSetTypeConstraint FileEncodingPropertyInfo b) => Proxy * FileEncodingPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileEncodingPropertyInfo Source #
type AttrOrigin FileEncodingPropertyInfo = File
type AttrLabel FileEncodingPropertyInfo Source #
type AttrLabel FileEncodingPropertyInfo = "encoding"
type AttrGetType FileEncodingPropertyInfo Source #
type AttrGetType FileEncodingPropertyInfo = Encoding
type AttrBaseTypeConstraint FileEncodingPropertyInfo Source #
type AttrBaseTypeConstraint FileEncodingPropertyInfo = IsFile
type AttrSetTypeConstraint FileEncodingPropertyInfo Source #
type AttrSetTypeConstraint FileEncodingPropertyInfo = * ~ ()
type AttrAllowedOps FileEncodingPropertyInfo Source #
type AttrAllowedOps FileEncodingPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

fileEncoding :: AttrLabelProxy "encoding" Source #

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

location

data FileLocationPropertyInfo Source #

Instances

AttrInfo FileLocationPropertyInfo Source #
Associated Types type AttrAllowedOps FileLocationPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileLocationPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileLocationPropertyInfo :: * -> Constraint # type AttrGetType FileLocationPropertyInfo :: * # type AttrLabel FileLocationPropertyInfo :: Symbol # type AttrOrigin FileLocationPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileLocationPropertyInfo o => Proxy * FileLocationPropertyInfo -> o -> IO (AttrGetType FileLocationPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileLocationPropertyInfo o, AttrSetTypeConstraint FileLocationPropertyInfo b) => Proxy * FileLocationPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileLocationPropertyInfo o => Proxy * FileLocationPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileLocationPropertyInfo o, AttrSetTypeConstraint FileLocationPropertyInfo b) => Proxy * FileLocationPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileLocationPropertyInfo Source #
type AttrOrigin FileLocationPropertyInfo = File
type AttrLabel FileLocationPropertyInfo Source #
type AttrLabel FileLocationPropertyInfo = "location"
type AttrGetType FileLocationPropertyInfo Source #
type AttrGetType FileLocationPropertyInfo = File
type AttrBaseTypeConstraint FileLocationPropertyInfo Source #
type AttrBaseTypeConstraint FileLocationPropertyInfo = IsFile
type AttrSetTypeConstraint FileLocationPropertyInfo Source #
type AttrSetTypeConstraint FileLocationPropertyInfo = IsFile
type AttrAllowedOps FileLocationPropertyInfo Source #
type AttrAllowedOps FileLocationPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

fileLocation :: AttrLabelProxy "location" Source #

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

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

newlineType

data FileNewlineTypePropertyInfo Source #

Instances

AttrInfo FileNewlineTypePropertyInfo Source #
Associated Types type AttrAllowedOps FileNewlineTypePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileNewlineTypePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileNewlineTypePropertyInfo :: * -> Constraint # type AttrGetType FileNewlineTypePropertyInfo :: * # type AttrLabel FileNewlineTypePropertyInfo :: Symbol # type AttrOrigin FileNewlineTypePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileNewlineTypePropertyInfo o => Proxy * FileNewlineTypePropertyInfo -> o -> IO (AttrGetType FileNewlineTypePropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileNewlineTypePropertyInfo o, AttrSetTypeConstraint FileNewlineTypePropertyInfo b) => Proxy * FileNewlineTypePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileNewlineTypePropertyInfo o => Proxy * FileNewlineTypePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileNewlineTypePropertyInfo o, AttrSetTypeConstraint FileNewlineTypePropertyInfo b) => Proxy * FileNewlineTypePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileNewlineTypePropertyInfo Source #
type AttrOrigin FileNewlineTypePropertyInfo = File
type AttrLabel FileNewlineTypePropertyInfo Source #
type AttrLabel FileNewlineTypePropertyInfo = "newline-type"
type AttrGetType FileNewlineTypePropertyInfo Source #
type AttrGetType FileNewlineTypePropertyInfo = NewlineType
type AttrBaseTypeConstraint FileNewlineTypePropertyInfo Source #
type AttrBaseTypeConstraint FileNewlineTypePropertyInfo = IsFile
type AttrSetTypeConstraint FileNewlineTypePropertyInfo Source #
type AttrSetTypeConstraint FileNewlineTypePropertyInfo = * ~ ()
type AttrAllowedOps FileNewlineTypePropertyInfo Source #
type AttrAllowedOps FileNewlineTypePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

fileNewlineType :: AttrLabelProxy "newlineType" Source #

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

readOnly

data FileReadOnlyPropertyInfo Source #

Instances

AttrInfo FileReadOnlyPropertyInfo Source #
Associated Types type AttrAllowedOps FileReadOnlyPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileReadOnlyPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileReadOnlyPropertyInfo :: * -> Constraint # type AttrGetType FileReadOnlyPropertyInfo :: * # type AttrLabel FileReadOnlyPropertyInfo :: Symbol # type AttrOrigin FileReadOnlyPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileReadOnlyPropertyInfo o => Proxy * FileReadOnlyPropertyInfo -> o -> IO (AttrGetType FileReadOnlyPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileReadOnlyPropertyInfo o, AttrSetTypeConstraint FileReadOnlyPropertyInfo b) => Proxy * FileReadOnlyPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileReadOnlyPropertyInfo o => Proxy * FileReadOnlyPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileReadOnlyPropertyInfo o, AttrSetTypeConstraint FileReadOnlyPropertyInfo b) => Proxy * FileReadOnlyPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileReadOnlyPropertyInfo Source #
type AttrOrigin FileReadOnlyPropertyInfo = File
type AttrLabel FileReadOnlyPropertyInfo Source #
type AttrLabel FileReadOnlyPropertyInfo = "read-only"
type AttrGetType FileReadOnlyPropertyInfo Source #
type AttrGetType FileReadOnlyPropertyInfo = Bool
type AttrBaseTypeConstraint FileReadOnlyPropertyInfo Source #
type AttrBaseTypeConstraint FileReadOnlyPropertyInfo = IsFile
type AttrSetTypeConstraint FileReadOnlyPropertyInfo Source #
type AttrSetTypeConstraint FileReadOnlyPropertyInfo = * ~ ()
type AttrAllowedOps FileReadOnlyPropertyInfo Source #
type AttrAllowedOps FileReadOnlyPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

fileReadOnly :: AttrLabelProxy "readOnly" Source #

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