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

GI.GdkPixbuf.Structs.PixbufFormat

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype PixbufFormat = PixbufFormat (ManagedPtr PixbufFormat)
noPixbufFormat :: Maybe PixbufFormat
pixbufFormatCopy :: (HasCallStack, MonadIO m) => PixbufFormat -> m PixbufFormat
pixbufFormatFree :: (HasCallStack, MonadIO m) => PixbufFormat -> m ()
pixbufFormatGetDescription :: (HasCallStack, MonadIO m) => PixbufFormat -> m Text
pixbufFormatGetExtensions :: (HasCallStack, MonadIO m) => PixbufFormat -> m [Text]
pixbufFormatGetLicense :: (HasCallStack, MonadIO m) => PixbufFormat -> m Text
pixbufFormatGetMimeTypes :: (HasCallStack, MonadIO m) => PixbufFormat -> m [Text]
pixbufFormatGetName :: (HasCallStack, MonadIO m) => PixbufFormat -> m Text
pixbufFormatIsDisabled :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool
pixbufFormatIsSaveOptionSupported :: (HasCallStack, MonadIO m) => PixbufFormat -> Text -> m Bool
pixbufFormatIsScalable :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool
pixbufFormatIsWritable :: (HasCallStack, MonadIO m) => PixbufFormat -> m Bool
pixbufFormatSetDisabled :: (HasCallStack, MonadIO m) => PixbufFormat -> Bool -> m ()

Exported types

newtype PixbufFormat Source #

Memory-managed wrapper type.

Constructors

PixbufFormat (ManagedPtr PixbufFormat)

Instances

BoxedObject PixbufFormat Source #
Instance details Defined in GI.GdkPixbuf.Structs.PixbufFormat Methods boxedType :: PixbufFormat -> IO GType #

noPixbufFormat :: Maybe PixbufFormat Source #

A convenience alias for Nothing :: Maybe PixbufFormat.

Methods

copy

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

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

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

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

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

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

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

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

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

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

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

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