GI.GdkPixbuf.Structs.PixbufFormat

A GdkPixbufFormat contains information about the image format accepted by a module.

Only modules should access the fields directly, applications should use the gdk_pixbuf_format_* family of functions.

Since: 2.2

Exported types

newtype PixbufFormat

Memory-managed wrapper type.

Constructors

PixbufFormat (ManagedPtr PixbufFormat)

Instances

Eq PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

(==) :: PixbufFormat -> PixbufFormat -> Bool

(/=) :: PixbufFormat -> PixbufFormat -> Bool

GBoxed PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

ManagedPtrNewtype PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

toManagedPtr :: PixbufFormat -> ManagedPtr PixbufFormat

TypedObject PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

glibType :: IO GType

HasParentTypes PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

tag ~ 'AttrSet => Constructible PixbufFormat tag

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

new :: MonadIO m => (ManagedPtr PixbufFormat -> PixbufFormat) -> [AttrOp PixbufFormat tag] -> m PixbufFormat

IsGValue (Maybe PixbufFormat)

Convert PixbufFormat to and from GValue. See toGValue and fromGValue.

Defined in GI.GdkPixbuf.Structs.PixbufFormat

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe PixbufFormat -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe PixbufFormat)

type ParentTypes PixbufFormat

Defined in GI.GdkPixbuf.Structs.PixbufFormat

type ParentTypes PixbufFormat = '[] :: [Type]

newZeroPixbufFormat :: MonadIO m => m PixbufFormat

Construct a PixbufFormat struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

copy, free, isDisabled, isSaveOptionSupported, isScalable, isWritable.

Getters

getDescription, getExtensions, getLicense, getMimeTypes, getName.

Setters

setDisabled.

copy

pixbufFormatCopy

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a pixbuf format

-> m PixbufFormat

Returns: the newly allocated copy of a GdkPixbufFormat. Use pixbufFormatFree to free the resources when done

Creates a copy of format.

Since: 2.22

free

pixbufFormatFree

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a pixbuf format

-> m ()

Frees the resources allocated when copying a GdkPixbufFormat using pixbufFormatCopy

Since: 2.22

getDescription

pixbufFormatGetDescription

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> m Text

Returns: a description of the format.

Returns a description of the format.

Since: 2.2

getExtensions

pixbufFormatGetExtensions

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> m [Text]

Returns: an array of filename extensions

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

Since: 2.2

getLicense

pixbufFormatGetLicense

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a pixbuf format

-> m Text

Returns: a string describing the license of the pixbuf format

Returns information about the license of the image loader for the format.

The returned string should be a shorthand for a well known license, e.g. "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license.

Since: 2.6

getMimeTypes

pixbufFormatGetMimeTypes

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> m [Text]

Returns: an array of mime types

Returns the mime types supported by the format.

Since: 2.2

getName

pixbufFormatGetName

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> m Text

Returns: the name of the format.

Returns the name of the format.

Since: 2.2

isDisabled

pixbufFormatIsDisabled

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> m Bool

Returns: whether this image format is disabled.

Returns whether this image format is disabled.

See pixbufFormatSetDisabled.

Since: 2.6

isSaveOptionSupported

pixbufFormatIsSaveOptionSupported

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a pixbuf format

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

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

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

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

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

Arguments

:: (HasCallStack, MonadIO m)

=> PixbufFormat

format: a GdkPixbufFormat

-> Bool

disabled: TRUE to disable the format format

-> m ()

Disables or enables an image format.

If a format is disabled, GdkPixbuf 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

Properties

description

a description of the image format

clearPixbufFormatDescription :: MonadIO m => PixbufFormat -> m ()

Set the value of the “description” field to Nothing. When overloading is enabled, this is equivalent to

clear #description

getPixbufFormatDescription :: MonadIO m => PixbufFormat -> m (Maybe Text)

Get the value of the “description” field. When overloading is enabled, this is equivalent to

get pixbufFormat #description

setPixbufFormatDescription :: MonadIO m => PixbufFormat -> CString -> m ()

Set the value of the “description” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #description := value ]

disabled

a boolean determining whether the loader is disabled`

getPixbufFormatDisabled :: MonadIO m => PixbufFormat -> m Bool

Get the value of the “disabled” field. When overloading is enabled, this is equivalent to

get pixbufFormat #disabled

setPixbufFormatDisabled :: MonadIO m => PixbufFormat -> Bool -> m ()

Set the value of the “disabled” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #disabled := value ]

domain

the message domain for the description

clearPixbufFormatDomain :: MonadIO m => PixbufFormat -> m ()

Set the value of the “domain” field to Nothing. When overloading is enabled, this is equivalent to

clear #domain

getPixbufFormatDomain :: MonadIO m => PixbufFormat -> m (Maybe Text)

Get the value of the “domain” field. When overloading is enabled, this is equivalent to

get pixbufFormat #domain

setPixbufFormatDomain :: MonadIO m => PixbufFormat -> CString -> m ()

Set the value of the “domain” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #domain := value ]

extensions

typical filename extensions for the image format

clearPixbufFormatExtensions :: MonadIO m => PixbufFormat -> m ()

Set the value of the “extensions” field to Nothing. When overloading is enabled, this is equivalent to

clear #extensions

getPixbufFormatExtensions :: MonadIO m => PixbufFormat -> m (Maybe [Text])

Get the value of the “extensions” field. When overloading is enabled, this is equivalent to

get pixbufFormat #extensions

setPixbufFormatExtensions :: MonadIO m => PixbufFormat -> Ptr CString -> m ()

Set the value of the “extensions” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #extensions := value ]

flags

a combination of GdkPixbufFormatFlags

getPixbufFormatFlags :: MonadIO m => PixbufFormat -> m Word32

Get the value of the “flags” field. When overloading is enabled, this is equivalent to

get pixbufFormat #flags

setPixbufFormatFlags :: MonadIO m => PixbufFormat -> Word32 -> m ()

Set the value of the “flags” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #flags := value ]

license

a string containing license information, typically set to shorthands like "GPL", "LGPL", etc.

clearPixbufFormatLicense :: MonadIO m => PixbufFormat -> m ()

Set the value of the “license” field to Nothing. When overloading is enabled, this is equivalent to

clear #license

getPixbufFormatLicense :: MonadIO m => PixbufFormat -> m (Maybe Text)

Get the value of the “license” field. When overloading is enabled, this is equivalent to

get pixbufFormat #license

setPixbufFormatLicense :: MonadIO m => PixbufFormat -> CString -> m ()

Set the value of the “license” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #license := value ]

mimeTypes

the MIME types for the image format

clearPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> m ()

Set the value of the “mime_types” field to Nothing. When overloading is enabled, this is equivalent to

clear #mimeTypes

getPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> m (Maybe [Text])

Get the value of the “mime_types” field. When overloading is enabled, this is equivalent to

get pixbufFormat #mimeTypes

setPixbufFormatMimeTypes :: MonadIO m => PixbufFormat -> Ptr CString -> m ()

Set the value of the “mime_types” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #mimeTypes := value ]

name

the name of the image format

clearPixbufFormatName :: MonadIO m => PixbufFormat -> m ()

Set the value of the “name” field to Nothing. When overloading is enabled, this is equivalent to

clear #name

getPixbufFormatName :: MonadIO m => PixbufFormat -> m (Maybe Text)

Get the value of the “name” field. When overloading is enabled, this is equivalent to

get pixbufFormat #name

setPixbufFormatName :: MonadIO m => PixbufFormat -> CString -> m ()

Set the value of the “name” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #name := value ]

signature

the signature of the module

clearPixbufFormatSignature :: MonadIO m => PixbufFormat -> m ()

Set the value of the “signature” field to Nothing. When overloading is enabled, this is equivalent to

clear #signature

getPixbufFormatSignature :: MonadIO m => PixbufFormat -> m (Maybe PixbufModulePattern)

Get the value of the “signature” field. When overloading is enabled, this is equivalent to

get pixbufFormat #signature

setPixbufFormatSignature :: MonadIO m => PixbufFormat -> Ptr PixbufModulePattern -> m ()

Set the value of the “signature” field. When overloading is enabled, this is equivalent to

set pixbufFormat [ #signature := value ]