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.GdkPixbuf.Structs.PixbufFormat

Contents

Exported types
Methods

Description

Synopsis

Exported types

newtype PixbufFormat Source #

Constructors

PixbufFormat (ManagedPtr PixbufFormat)

Instances

BoxedObject PixbufFormat Source #
Methods boxedType :: PixbufFormat -> IO GType #
((~) * info (ResolvePixbufFormatMethod t PixbufFormat), MethodInfo * info PixbufFormat p) => IsLabel t (PixbufFormat -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> PixbufFormat -> p #
((~) * info (ResolvePixbufFormatMethod t PixbufFormat), MethodInfo * info PixbufFormat p) => IsLabelProxy t (PixbufFormat -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> PixbufFormat -> p #
HasAttributeList * PixbufFormat Source #

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * PixbufFormatSetDisabledMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatSetDisabledMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Bool), MonadIO m) => MethodInfo * PixbufFormatIsWritableMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatIsWritableMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Bool), MonadIO m) => MethodInfo * PixbufFormatIsScalableMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatIsScalableMethodInfo PixbufFormat -> signature -> s #
((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * PixbufFormatIsSaveOptionSupportedMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatIsSaveOptionSupportedMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Bool), MonadIO m) => MethodInfo * PixbufFormatIsDisabledMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatIsDisabledMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetNameMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetNameMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m [Text]), MonadIO m) => MethodInfo * PixbufFormatGetMimeTypesMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetMimeTypesMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetLicenseMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetLicenseMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m [Text]), MonadIO m) => MethodInfo * PixbufFormatGetExtensionsMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetExtensionsMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetDescriptionMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetDescriptionMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * PixbufFormatFreeMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatFreeMethodInfo PixbufFormat -> signature -> s #
((~) * signature (m PixbufFormat), MonadIO m) => MethodInfo * PixbufFormatCopyMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatCopyMethodInfo PixbufFormat -> signature -> s #
type AttributeList PixbufFormat Source #
type AttributeList PixbufFormat

noPixbufFormat :: Maybe PixbufFormat Source #

Methods

copy

data PixbufFormatCopyMethodInfo Source #

Instances

((~) * signature (m PixbufFormat), MonadIO m) => MethodInfo * PixbufFormatCopyMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatCopyMethodInfo PixbufFormat -> signature -> s #

pixbufFormatCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m PixbufFormat	Returns: the newly allocated copy of a `PixbufFormat`. Use `pixbufFormatFree` to free the resources when done

Creates a copy of format

Since: 2.22

free

data PixbufFormatFreeMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * PixbufFormatFreeMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatFreeMethodInfo PixbufFormat -> signature -> s #

pixbufFormatFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m ()

Frees the resources allocated when copying a PixbufFormat using pixbufFormatCopy

Since: 2.22

getDescription

data PixbufFormatGetDescriptionMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetDescriptionMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetDescriptionMethodInfo PixbufFormat -> signature -> s #

pixbufFormatGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Text	Returns: a description of the format.

Returns a description of the format.

Since: 2.2

getExtensions

data PixbufFormatGetExtensionsMethodInfo Source #

Instances

((~) * signature (m [Text]), MonadIO m) => MethodInfo * PixbufFormatGetExtensionsMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetExtensionsMethodInfo PixbufFormat -> signature -> s #

pixbufFormatGetExtensions Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m [Text]	Returns: a `Nothing`-terminated array of filename extensions which must be freed with `strfreev` when it is no longer needed.

Returns the filename extensions typically used for files in the given format.

Since: 2.2

getLicense

data PixbufFormatGetLicenseMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetLicenseMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetLicenseMethodInfo PixbufFormat -> signature -> s #

pixbufFormatGetLicense Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Text	Returns: a string describing the license of `format`.

Returns information about the license of the image loader for the format. The returned string should be a shorthand for a wellknown license, e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. This string should be freed with free when it's no longer needed.

Since: 2.6

getMimeTypes

data PixbufFormatGetMimeTypesMethodInfo Source #

Instances

((~) * signature (m [Text]), MonadIO m) => MethodInfo * PixbufFormatGetMimeTypesMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetMimeTypesMethodInfo PixbufFormat -> signature -> s #

pixbufFormatGetMimeTypes Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m [Text]	Returns: a `Nothing`-terminated array of mime types which must be freed with `strfreev` when it is no longer needed.

Returns the mime types supported by the format.

Since: 2.2

getName

data PixbufFormatGetNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * PixbufFormatGetNameMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatGetNameMethodInfo PixbufFormat -> signature -> s #

pixbufFormatGetName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Text	Returns: the name of the format.

Returns the name of the format.

Since: 2.2

isDisabled

data PixbufFormatIsDisabledMethodInfo Source #

Instances

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

pixbufFormatIsDisabled Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Bool	Returns: whether this image format is disabled.

Returns whether this image format is disabled. See pixbufFormatSetDisabled.

Since: 2.6

isSaveOptionSupported

data PixbufFormatIsSaveOptionSupportedMethodInfo Source #

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * PixbufFormatIsSaveOptionSupportedMethodInfo PixbufFormat signature Source #
Methods overloadedMethod :: MethodProxy PixbufFormatIsSaveOptionSupportedMethodInfo PixbufFormat -> signature -> s #

pixbufFormatIsSaveOptionSupported Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> Text	`optionKey`: the name of an option
-> m Bool	Returns: `True` if the specified option is supported

Returns True if the save option specified by optionKey is supported when saving a pixbuf using the module implementing format. See gdk_pixbuf_save() for more information about option keys.

Since: 2.36

isScalable

data PixbufFormatIsScalableMethodInfo Source #

Instances

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

pixbufFormatIsScalable Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Bool	Returns: whether this image format is scalable.

Returns whether this image format is scalable. If a file is in a scalable format, it is preferable to load it at the desired size, rather than loading it at the default size and scaling the resulting pixbuf to the desired size.

Since: 2.6

isWritable

data PixbufFormatIsWritableMethodInfo Source #

Instances

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

pixbufFormatIsWritable Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> m Bool	Returns: whether pixbufs can be saved in the given format.

Returns whether pixbufs can be saved in the given format.

Since: 2.2

setDisabled

data PixbufFormatSetDisabledMethodInfo Source #

Instances

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

pixbufFormatSetDisabled Source #

Arguments

:: (HasCallStack, MonadIO m)
=> PixbufFormat	`format`: a `PixbufFormat`
-> Bool	`disabled`: `True` to disable the format `format`
-> m ()

Disables or enables an image format. If a format is disabled, gdk-pixbuf won't use the image loader for this format to load images. Applications can use this to avoid using image loaders with an inappropriate license, see pixbufFormatGetLicense.

Since: 2.6