Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.GtkSource.Objects.File

Contents

Exported types
Methods
Properties

Description

On-disk representation of a [classbuffer].

A GtkSourceFile object is the on-disk representation of a [classbuffer]. With a GtkSourceFile, you can create and configure a [classfileLoader] and [classfileSaver] which take by default the values of the GtkSourceFile properties (except for the file loader which auto-detect some properties). On a successful load or save operation, the GtkSourceFile properties are updated. If an operation fails, the GtkSourceFile properties have still the previous valid values.

Synopsis

newtype File = File (ManagedPtr File)
class (GObject o, IsDescendantOf File o) => IsFile o
toFile :: (MonadIO m, IsFile o) => o -> m 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, MonadIO m, IsFile a) => a -> m (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

newtype File Source #

Memory-managed wrapper type.

Constructors

File (ManagedPtr File)

Instances

Instances details

Eq File Source #
Instance details Defined in GI.GtkSource.Objects.File Methods (==) :: File -> File -> Bool # (/=) :: File -> File -> Bool #
GObject File Source #
Instance details Defined in GI.GtkSource.Objects.File
ManagedPtrNewtype File Source #
Instance details Defined in GI.GtkSource.Objects.File Methods toManagedPtr :: File -> ManagedPtr File
TypedObject File Source #
Instance details Defined in GI.GtkSource.Objects.File Methods glibType :: IO GType
HasParentTypes File Source #
Instance details Defined in GI.GtkSource.Objects.File
IsGValue (Maybe File) Source #	Convert `File` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.GtkSource.Objects.File Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe File -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe File)
type ParentTypes File Source #
Instance details Defined in GI.GtkSource.Objects.File type ParentTypes File = '[Object]

class (GObject o, IsDescendantOf File o) => IsFile o Source #

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

Instances

Instances details

(GObject o, IsDescendantOf File o) => IsFile o Source #
Instance details Defined in GI.GtkSource.Objects.File

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

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

Methods

Click to display all available methods, including inherited ones

Expand

checkFileOnDisk

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 FileMonitor's would take lots of resources.

Since this function is synchronous, it is advised to call it only on local files. See [methodfile.is_local].

getCompressionType

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.

getEncoding

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.

getLocation

fileGetLocation Source #

Arguments

:: (HasCallStack, MonadIO m, IsFile a)
=> a	`file`: a `File`.
-> m File	Returns: the `File`.

No description available in the introspection data.

getNewlineType

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.

isDeleted

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 [propertyfile:location] is Nothing, returns False.

To have an up-to-date value, you must first call [methodfile.check_file_on_disk].

isExternallyModified

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 [propertyfile:location] is Nothing, returns False.

To have an up-to-date value, you must first call [methodfile.check_file_on_disk].

isLocal

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 [propertyfile:location] is Nothing, returns False.

isReadonly

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 [propertyfile:location] is Nothing, returns False.

To have an up-to-date value, you must first call [methodfile.check_file_on_disk].

new

fileNew Source #

Arguments

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

No description available in the introspection data.

setLocation

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.

Properties

compressionType

The compression type.

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.

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.

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, MonadIO m, IsFile a) => a -> m (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.

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).

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

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

checkFileOnDisk

getCompressionType

getEncoding

getLocation

getNewlineType

isDeleted

isExternallyModified

isLocal

isReadonly

new

setLocation

Properties

compressionType

encoding

location

newlineType

readOnly