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

Contents

Exported types
Methods
Properties

Description

Synopsis

Exported types

newtype FileLoader Source #

Constructors

FileLoader (ManagedPtr FileLoader)

Instances

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

IsFileLoader FileLoader Source #

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

type AttributeList FileLoader Source #
type AttributeList FileLoader
type SignalList FileLoader Source #
type SignalList FileLoader

class GObject o => IsFileLoader o Source #

Instances

(GObject a, UnknownAncestorError Constraint FileLoader a) => IsFileLoader a Source #

IsFileLoader FileLoader Source #

toFileLoader :: IsFileLoader o => o -> IO FileLoader Source #

noFileLoader :: Maybe FileLoader Source #

Methods

getBuffer

data FileLoaderGetBufferMethodInfo Source #

Instances

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

fileLoaderGetBuffer Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m Buffer	Returns: the `Buffer` to load the contents into.

No description available in the introspection data.

Since: 3.14

getCompressionType

data FileLoaderGetCompressionTypeMethodInfo Source #

Instances

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

fileLoaderGetCompressionType Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m CompressionType	Returns: the detected compression type.

No description available in the introspection data.

Since: 3.14

getEncoding

data FileLoaderGetEncodingMethodInfo Source #

Instances

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

fileLoaderGetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m Encoding	Returns: the detected file encoding.

No description available in the introspection data.

Since: 3.14

getFile

data FileLoaderGetFileMethodInfo Source #

Instances

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

fileLoaderGetFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m File	Returns: the `File`.

No description available in the introspection data.

Since: 3.14

getInputStream

data FileLoaderGetInputStreamMethodInfo Source #

Instances

((~) * signature (m (Maybe InputStream)), MonadIO m, IsFileLoader a) => MethodInfo * FileLoaderGetInputStreamMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileLoaderGetInputStreamMethodInfo a -> signature -> s #

fileLoaderGetInputStream Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m (Maybe InputStream)	Returns: the `InputStream` to load, or `Nothing` if a `File` is used.

No description available in the introspection data.

Since: 3.14

getLocation

data FileLoaderGetLocationMethodInfo Source #

Instances

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

fileLoaderGetLocation Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m (Maybe File)	Returns: the `File` to load, or `Nothing` if an input stream is used.

No description available in the introspection data.

Since: 3.14

getNewlineType

data FileLoaderGetNewlineTypeMethodInfo Source #

Instances

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

fileLoaderGetNewlineType Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> m NewlineType	Returns: the detected newline type.

No description available in the introspection data.

Since: 3.14

loadAsync

data FileLoaderLoadAsyncMethodInfo Source #

Instances

((~) * signature (Int32 -> Maybe b -> Maybe FileProgressCallback -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsFileLoader a, IsCancellable b) => MethodInfo * FileLoaderLoadAsyncMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileLoaderLoadAsyncMethodInfo a -> signature -> s #

fileLoaderLoadAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a, IsCancellable b)
=> a	`loader`: a `FileLoader`.
-> Int32	`ioPriority`: the I/O priority of the request. E.g. `PRIORITY_LOW`, `PRIORITY_DEFAULT` or `PRIORITY_HIGH`.
-> Maybe b	`cancellable`: optional `Cancellable` object, `Nothing` to ignore.
-> Maybe FileProgressCallback	`progressCallback`: function to call back with progress information, or `Nothing` if progress information is not needed.
-> Maybe AsyncReadyCallback	`callback`: a `AsyncReadyCallback` to call when the request is satisfied.
-> m ()

Loads asynchronously the file or input stream contents into the Buffer. See the AsyncResult documentation to know how to use this function.

Since: 3.14

loadFinish

data FileLoaderLoadFinishMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsFileLoader a, IsAsyncResult b) => MethodInfo * FileLoaderLoadFinishMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileLoaderLoadFinishMethodInfo a -> signature -> s #

fileLoaderLoadFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a, IsAsyncResult b)
=> a	`loader`: a `FileLoader`.
-> b	`result`: a `AsyncResult`.
-> m ()	(Can throw `GError`)

Finishes a file loading started with fileLoaderLoadAsync.

If the contents has been loaded, the following File properties will be updated: the location, the encoding, the newline type and the compression type.

Since: 3.14

new

fileLoaderNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a, IsFile b)
=> a	`buffer`: the `Buffer` to load the contents into.
-> b	`file`: the `File`.
-> m FileLoader	Returns: a new `FileLoader` object.

Creates a new FileLoader object. The contents is read from the 'GI.GtkSource.Objects.File.File'\'s location. If not already done, call fileSetLocation before calling this constructor. The previous location is anyway not needed, because as soon as the file loading begins, the buffer is emptied.

Since: 3.14

newFromStream

fileLoaderNewFromStream Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuffer a, IsFile b, IsInputStream c)
=> a	`buffer`: the `Buffer` to load the contents into.
-> b	`file`: the `File`.
-> c	`stream`: the `InputStream` to load, e.g. stdin.
-> m FileLoader	Returns: a new `FileLoader` object.

Creates a new FileLoader object. The contents is read from stream.

Since: 3.14

setCandidateEncodings

data FileLoaderSetCandidateEncodingsMethodInfo Source #

Instances

((~) * signature ([Encoding] -> m ()), MonadIO m, IsFileLoader a) => MethodInfo * FileLoaderSetCandidateEncodingsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FileLoaderSetCandidateEncodingsMethodInfo a -> signature -> s #

fileLoaderSetCandidateEncodings Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileLoader a)
=> a	`loader`: a `FileLoader`.
-> [Encoding]	`candidateEncodings`: a list of `Encoding`<!-- -->s.
-> m ()

Sets the candidate encodings for the file loading. The encodings are tried in the same order as the list.

For convenience, candidateEncodings can contain duplicates. Only the first occurrence of a duplicated encoding is kept in the list.

By default the candidate encodings are (in that order in the list): 1. If set, the 'GI.GtkSource.Objects.File.File'\'s encoding as returned by fileGetEncoding. 2. The default candidates as returned by encodingGetDefaultCandidates.

Since: 3.14

Properties

buffer

data FileLoaderBufferPropertyInfo Source #

Instances

AttrInfo FileLoaderBufferPropertyInfo Source #
Associated Types type AttrAllowedOps FileLoaderBufferPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileLoaderBufferPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileLoaderBufferPropertyInfo :: * -> Constraint # type AttrGetType FileLoaderBufferPropertyInfo :: * # type AttrLabel FileLoaderBufferPropertyInfo :: Symbol # type AttrOrigin FileLoaderBufferPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileLoaderBufferPropertyInfo o => Proxy * FileLoaderBufferPropertyInfo -> o -> IO (AttrGetType FileLoaderBufferPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileLoaderBufferPropertyInfo o, AttrSetTypeConstraint FileLoaderBufferPropertyInfo b) => Proxy * FileLoaderBufferPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileLoaderBufferPropertyInfo o => Proxy * FileLoaderBufferPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileLoaderBufferPropertyInfo o, AttrSetTypeConstraint FileLoaderBufferPropertyInfo b) => Proxy * FileLoaderBufferPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileLoaderBufferPropertyInfo Source #
type AttrOrigin FileLoaderBufferPropertyInfo = FileLoader
type AttrLabel FileLoaderBufferPropertyInfo Source #
type AttrLabel FileLoaderBufferPropertyInfo = "buffer"
type AttrGetType FileLoaderBufferPropertyInfo Source #
type AttrGetType FileLoaderBufferPropertyInfo = Buffer
type AttrBaseTypeConstraint FileLoaderBufferPropertyInfo Source #
type AttrBaseTypeConstraint FileLoaderBufferPropertyInfo = IsFileLoader
type AttrSetTypeConstraint FileLoaderBufferPropertyInfo Source #
type AttrSetTypeConstraint FileLoaderBufferPropertyInfo = IsBuffer
type AttrAllowedOps FileLoaderBufferPropertyInfo Source #
type AttrAllowedOps FileLoaderBufferPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructFileLoaderBuffer :: (IsFileLoader o, IsBuffer a) => a -> IO (GValueConstruct o) Source #

fileLoaderBuffer :: AttrLabelProxy "buffer" Source #

getFileLoaderBuffer :: (MonadIO m, IsFileLoader o) => o -> m Buffer Source #

file

data FileLoaderFilePropertyInfo Source #

Instances

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

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

fileLoaderFile :: AttrLabelProxy "file" Source #

getFileLoaderFile :: (MonadIO m, IsFileLoader o) => o -> m File Source #

inputStream

data FileLoaderInputStreamPropertyInfo Source #

Instances

AttrInfo FileLoaderInputStreamPropertyInfo Source #
Associated Types type AttrAllowedOps FileLoaderInputStreamPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FileLoaderInputStreamPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo :: * -> Constraint # type AttrGetType FileLoaderInputStreamPropertyInfo :: * # type AttrLabel FileLoaderInputStreamPropertyInfo :: Symbol # type AttrOrigin FileLoaderInputStreamPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo o => Proxy * FileLoaderInputStreamPropertyInfo -> o -> IO (AttrGetType FileLoaderInputStreamPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo o, AttrSetTypeConstraint FileLoaderInputStreamPropertyInfo b) => Proxy * FileLoaderInputStreamPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo o => Proxy * FileLoaderInputStreamPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo o, AttrSetTypeConstraint FileLoaderInputStreamPropertyInfo b) => Proxy * FileLoaderInputStreamPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FileLoaderInputStreamPropertyInfo Source #
type AttrOrigin FileLoaderInputStreamPropertyInfo = FileLoader
type AttrLabel FileLoaderInputStreamPropertyInfo Source #
type AttrLabel FileLoaderInputStreamPropertyInfo = "input-stream"
type AttrGetType FileLoaderInputStreamPropertyInfo Source #
type AttrGetType FileLoaderInputStreamPropertyInfo = Maybe InputStream
type AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo Source #
type AttrBaseTypeConstraint FileLoaderInputStreamPropertyInfo = IsFileLoader
type AttrSetTypeConstraint FileLoaderInputStreamPropertyInfo Source #
type AttrSetTypeConstraint FileLoaderInputStreamPropertyInfo = IsInputStream
type AttrAllowedOps FileLoaderInputStreamPropertyInfo Source #
type AttrAllowedOps FileLoaderInputStreamPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructFileLoaderInputStream :: (IsFileLoader o, IsInputStream a) => a -> IO (GValueConstruct o) Source #

fileLoaderInputStream :: AttrLabelProxy "inputStream" Source #

getFileLoaderInputStream :: (MonadIO m, IsFileLoader o) => o -> m (Maybe InputStream) Source #

location

data FileLoaderLocationPropertyInfo Source #

Instances

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

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

fileLoaderLocation :: AttrLabelProxy "location" Source #

getFileLoaderLocation :: (MonadIO m, IsFileLoader o) => o -> m (Maybe File) Source #