GI.GdkPixbuf.Objects.PixbufLoader

The GdkPixbufLoader struct contains only private fields.

Exported types

newtype PixbufLoader

Constructors

PixbufLoader (ManagedPtr PixbufLoader)

Instances

GObject PixbufLoader

Methods

gobjectType :: PixbufLoader -> IO GType

IsObject PixbufLoader

IsPixbufLoader PixbufLoader

((~) * info (ResolvePixbufLoaderMethod t PixbufLoader), MethodInfo * info PixbufLoader p) => IsLabel t (PixbufLoader -> p)

Methods

fromLabel :: Proxy# Symbol t -> PixbufLoader -> p

((~) * info (ResolvePixbufLoaderMethod t PixbufLoader), MethodInfo * info PixbufLoader p) => IsLabelProxy t (PixbufLoader -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> PixbufLoader -> p

HasAttributeList * PixbufLoader

type AttributeList PixbufLoader

type AttributeList PixbufLoader

type SignalList PixbufLoader

type SignalList PixbufLoader

class GObject o => IsPixbufLoader o

Instances

(GObject a, UnknownAncestorError Constraint PixbufLoader a) => IsPixbufLoader a

IsPixbufLoader PixbufLoader

toPixbufLoader :: IsPixbufLoader o => o -> IO PixbufLoader

noPixbufLoader :: Maybe PixbufLoader

Methods

close

data PixbufLoaderCloseMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderCloseMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderCloseMethodInfo a -> signature -> s

pixbufLoaderClose

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> m ()

(Can throw GError)

Informs a pixbuf loader that no further writes with pixbufLoaderWrite will occur, so that it can free its internal loading structures. Also, tries to parse any data that hasn't yet been parsed; if the remaining data is partial or corrupt, an error will be returned. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains. If you're just cancelling a load rather than expecting it to be finished, passing Nothing for error to ignore it is reasonable.

Remember that this does not unref the loader, so if you plan not to use it anymore, please objectUnref it.

getAnimation

data PixbufLoaderGetAnimationMethodInfo

Instances

((~) * signature (m PixbufAnimation), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderGetAnimationMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderGetAnimationMethodInfo a -> signature -> s

pixbufLoaderGetAnimation

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader

-> m PixbufAnimation

Returns: The PixbufAnimation that the loader is loading, or Nothing if not enough data has been read to determine the information.

Queries the PixbufAnimation that a pixbuf loader is currently creating. In general it only makes sense to call this function after the "area-prepared" signal has been emitted by the loader. If the loader doesn't have enough bytes yet (hasn't emitted the "area-prepared" signal) this function will return Nothing.

getFormat

data PixbufLoaderGetFormatMethodInfo

Instances

((~) * signature (m (Maybe PixbufFormat)), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderGetFormatMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderGetFormatMethodInfo a -> signature -> s

pixbufLoaderGetFormat

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> m (Maybe PixbufFormat)

Returns: A PixbufFormat or Nothing. The return value is owned by GdkPixbuf and should not be freed.

Obtains the available information about the format of the currently loading image file.

Since: 2.2

getPixbuf

data PixbufLoaderGetPixbufMethodInfo

Instances

((~) * signature (m Pixbuf), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderGetPixbufMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderGetPixbufMethodInfo a -> signature -> s

pixbufLoaderGetPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> m Pixbuf

Returns: The Pixbuf that the loader is creating, or Nothing if not enough data has been read to determine how to create the image buffer.

Queries the Pixbuf that a pixbuf loader is currently creating. In general it only makes sense to call this function after the "area-prepared" signal has been emitted by the loader; this means that enough data has been read to know the size of the image that will be allocated. If the loader has not received enough data via pixbufLoaderWrite, then this function returns Nothing. The returned pixbuf will be the same in all future calls to the loader, so simply calling objectRef should be sufficient to continue using it. Additionally, if the loader is an animation, it will return the "static image" of the animation (see pixbufAnimationGetStaticImage).

new

pixbufLoaderNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PixbufLoader

Returns: A newly-created pixbuf loader.

Creates a new pixbuf loader object.

newWithMimeType

pixbufLoaderNewWithMimeType

Arguments

:: (HasCallStack, MonadIO m)

=> Text

mimeType: the mime type to be loaded

-> m PixbufLoader

Returns: A newly-created pixbuf loader. (Can throw GError)

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of mime type mimeType, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected mime type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific mime type.

The list of supported mime types depends on what image loaders are installed, but typically "image/png", "image/jpeg", "image/gif", "image/tiff" and "image/x-xpixmap" are among the supported mime types. To obtain the full list of supported mime types, call pixbufFormatGetMimeTypes on each of the PixbufFormat structs returned by pixbufGetFormats.

Since: 2.4

newWithType

pixbufLoaderNewWithType

Arguments

:: (HasCallStack, MonadIO m)

=> Text

imageType: name of the image format to be loaded with the image

-> m PixbufLoader

Returns: A newly-created pixbuf loader. (Can throw GError)

Creates a new pixbuf loader object that always attempts to parse image data as if it were an image of type imageType, instead of identifying the type automatically. Useful if you want an error if the image isn't the expected type, for loading image formats that can't be reliably identified by looking at the data, or if the user manually forces a specific type.

The list of supported image formats depends on what image loaders are installed, but typically "png", "jpeg", "gif", "tiff" and "xpm" are among the supported formats. To obtain the full list of supported image formats, call pixbufFormatGetName on each of the PixbufFormat structs returned by pixbufGetFormats.

setSize

data PixbufLoaderSetSizeMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderSetSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderSetSizeMethodInfo a -> signature -> s

pixbufLoaderSetSize

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> Int32

width: The desired width of the image being loaded.

-> Int32

height: The desired height of the image being loaded.

-> m ()

Causes the image to be scaled while it is loaded. The desired image size can be determined relative to the original size of the image by calling pixbufLoaderSetSize from a signal handler for the ::size-prepared signal.

Attempts to set the desired image size are ignored after the emission of the ::size-prepared signal.

Since: 2.2

write

data PixbufLoaderWriteMethodInfo

Instances

((~) * signature (ByteString -> m ()), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderWriteMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderWriteMethodInfo a -> signature -> s

pixbufLoaderWrite

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> ByteString

buf: Pointer to image data.

-> m ()

(Can throw GError)

This will cause a pixbuf loader to parse the next count bytes of an image. It will return True if the data was loaded successfully, and False if an error occurred. In the latter case, the loader will be closed, and will not accept further writes. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains.

writeBytes

data PixbufLoaderWriteBytesMethodInfo

Instances

((~) * signature (Bytes -> m ()), MonadIO m, IsPixbufLoader a) => MethodInfo * PixbufLoaderWriteBytesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy PixbufLoaderWriteBytesMethodInfo a -> signature -> s

pixbufLoaderWriteBytes

Arguments

:: (HasCallStack, MonadIO m, IsPixbufLoader a)

=> a

loader: A pixbuf loader.

-> Bytes

buffer: The image data as a Bytes

-> m ()

(Can throw GError)

This will cause a pixbuf loader to parse a buffer inside a Bytes for an image. It will return True if the data was loaded successfully, and False if an error occurred. In the latter case, the loader will be closed, and will not accept further writes. If False is returned, error will be set to an error from the GDK_PIXBUF_ERROR or G_FILE_ERROR domains.

See also: pixbufLoaderWrite

Since: 2.30

Signals

areaPrepared

type C_PixbufLoaderAreaPreparedCallback = Ptr () -> Ptr () -> IO ()

type PixbufLoaderAreaPreparedCallback = IO ()

data PixbufLoaderAreaPreparedSignalInfo

Instances

SignalInfo PixbufLoaderAreaPreparedSignalInfo

Associated Types

type HaskellCallbackType PixbufLoaderAreaPreparedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o PixbufLoaderAreaPreparedSignalInfo -> o -> HaskellCallbackType PixbufLoaderAreaPreparedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType PixbufLoaderAreaPreparedSignalInfo

type HaskellCallbackType PixbufLoaderAreaPreparedSignalInfo = PixbufLoaderAreaPreparedCallback

afterPixbufLoaderAreaPrepared :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderAreaPreparedCallback -> m SignalHandlerId

genClosure_PixbufLoaderAreaPrepared :: PixbufLoaderAreaPreparedCallback -> IO Closure

mk_PixbufLoaderAreaPreparedCallback :: C_PixbufLoaderAreaPreparedCallback -> IO (FunPtr C_PixbufLoaderAreaPreparedCallback)

noPixbufLoaderAreaPreparedCallback :: Maybe PixbufLoaderAreaPreparedCallback

onPixbufLoaderAreaPrepared :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderAreaPreparedCallback -> m SignalHandlerId

wrap_PixbufLoaderAreaPreparedCallback :: PixbufLoaderAreaPreparedCallback -> Ptr () -> Ptr () -> IO ()

areaUpdated

type C_PixbufLoaderAreaUpdatedCallback = Ptr () -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> IO ()

type PixbufLoaderAreaUpdatedCallback = Int32 -> Int32 -> Int32 -> Int32 -> IO ()

data PixbufLoaderAreaUpdatedSignalInfo

Instances

SignalInfo PixbufLoaderAreaUpdatedSignalInfo

Associated Types

type HaskellCallbackType PixbufLoaderAreaUpdatedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o PixbufLoaderAreaUpdatedSignalInfo -> o -> HaskellCallbackType PixbufLoaderAreaUpdatedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType PixbufLoaderAreaUpdatedSignalInfo

type HaskellCallbackType PixbufLoaderAreaUpdatedSignalInfo = PixbufLoaderAreaUpdatedCallback

afterPixbufLoaderAreaUpdated :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderAreaUpdatedCallback -> m SignalHandlerId

genClosure_PixbufLoaderAreaUpdated :: PixbufLoaderAreaUpdatedCallback -> IO Closure

mk_PixbufLoaderAreaUpdatedCallback :: C_PixbufLoaderAreaUpdatedCallback -> IO (FunPtr C_PixbufLoaderAreaUpdatedCallback)

noPixbufLoaderAreaUpdatedCallback :: Maybe PixbufLoaderAreaUpdatedCallback

onPixbufLoaderAreaUpdated :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderAreaUpdatedCallback -> m SignalHandlerId

wrap_PixbufLoaderAreaUpdatedCallback :: PixbufLoaderAreaUpdatedCallback -> Ptr () -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> IO ()

closed

type C_PixbufLoaderClosedCallback = Ptr () -> Ptr () -> IO ()

type PixbufLoaderClosedCallback = IO ()

data PixbufLoaderClosedSignalInfo

Instances

SignalInfo PixbufLoaderClosedSignalInfo

Associated Types

type HaskellCallbackType PixbufLoaderClosedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o PixbufLoaderClosedSignalInfo -> o -> HaskellCallbackType PixbufLoaderClosedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType PixbufLoaderClosedSignalInfo

type HaskellCallbackType PixbufLoaderClosedSignalInfo = PixbufLoaderClosedCallback

afterPixbufLoaderClosed :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderClosedCallback -> m SignalHandlerId

genClosure_PixbufLoaderClosed :: PixbufLoaderClosedCallback -> IO Closure

mk_PixbufLoaderClosedCallback :: C_PixbufLoaderClosedCallback -> IO (FunPtr C_PixbufLoaderClosedCallback)

noPixbufLoaderClosedCallback :: Maybe PixbufLoaderClosedCallback

onPixbufLoaderClosed :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderClosedCallback -> m SignalHandlerId

wrap_PixbufLoaderClosedCallback :: PixbufLoaderClosedCallback -> Ptr () -> Ptr () -> IO ()

sizePrepared

type C_PixbufLoaderSizePreparedCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

type PixbufLoaderSizePreparedCallback = Int32 -> Int32 -> IO ()

data PixbufLoaderSizePreparedSignalInfo

Instances

SignalInfo PixbufLoaderSizePreparedSignalInfo

Associated Types

type HaskellCallbackType PixbufLoaderSizePreparedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o PixbufLoaderSizePreparedSignalInfo -> o -> HaskellCallbackType PixbufLoaderSizePreparedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType PixbufLoaderSizePreparedSignalInfo

type HaskellCallbackType PixbufLoaderSizePreparedSignalInfo = PixbufLoaderSizePreparedCallback

afterPixbufLoaderSizePrepared :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderSizePreparedCallback -> m SignalHandlerId

genClosure_PixbufLoaderSizePrepared :: PixbufLoaderSizePreparedCallback -> IO Closure

mk_PixbufLoaderSizePreparedCallback :: C_PixbufLoaderSizePreparedCallback -> IO (FunPtr C_PixbufLoaderSizePreparedCallback)

noPixbufLoaderSizePreparedCallback :: Maybe PixbufLoaderSizePreparedCallback

onPixbufLoaderSizePrepared :: (IsPixbufLoader a, MonadIO m) => a -> PixbufLoaderSizePreparedCallback -> m SignalHandlerId

wrap_PixbufLoaderSizePreparedCallback :: PixbufLoaderSizePreparedCallback -> Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()