GI.GdkPixbuf.Callbacks

Signals

PixbufDestroyNotify

type C_PixbufDestroyNotify = Ptr Word8 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type PixbufDestroyNotify

Arguments

 = Ptr Word8

pixels: The pixel array of the pixbuf that is being finalized.

-> IO ()

A function of this type is responsible for freeing the pixel array of a pixbuf.

The pixbufNewFromData function lets you pass in a pre-allocated pixel array so that a pixbuf can be created from it; in this case you will need to pass in a function of type GdkPixbufDestroyNotify so that the pixel data can be freed when the pixbuf is finalized.

type PixbufDestroyNotify_WithClosures

Arguments

 = Ptr Word8

pixels: The pixel array of the pixbuf that is being finalized.

-> Ptr ()

data: User closure data.

-> IO ()

A function of this type is responsible for freeing the pixel array of a pixbuf.

The pixbufNewFromData function lets you pass in a pre-allocated pixel array so that a pixbuf can be created from it; in this case you will need to pass in a function of type GdkPixbufDestroyNotify so that the pixel data can be freed when the pixbuf is finalized.

drop_closures_PixbufDestroyNotify :: PixbufDestroyNotify -> PixbufDestroyNotify_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_PixbufDestroyNotify

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufDestroyNotify

-> Ptr Word8

pixels: The pixel array of the pixbuf that is being finalized.

-> Ptr ()

data: User closure data.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufDestroyNotify :: MonadIO m => PixbufDestroyNotify -> m (GClosure C_PixbufDestroyNotify)

Wrap the callback into a GClosure.

mk_PixbufDestroyNotify :: C_PixbufDestroyNotify -> IO (FunPtr C_PixbufDestroyNotify)

Generate a function pointer callable from C code, from a C_PixbufDestroyNotify.

noPixbufDestroyNotify :: Maybe PixbufDestroyNotify

A convenience synonym for Nothing :: Maybe PixbufDestroyNotify.

noPixbufDestroyNotify_WithClosures :: Maybe PixbufDestroyNotify_WithClosures

A convenience synonym for Nothing :: Maybe PixbufDestroyNotify_WithClosures.

wrap_PixbufDestroyNotify :: Maybe (Ptr (FunPtr C_PixbufDestroyNotify)) -> PixbufDestroyNotify_WithClosures -> C_PixbufDestroyNotify

Wrap a PixbufDestroyNotify into a C_PixbufDestroyNotify.

PixbufModuleFillInfoFunc

type C_PixbufModuleFillInfoFunc = Ptr PixbufFormat -> IO ()

Type for the callback on the (unwrapped) C side.

type PixbufModuleFillInfoFunc

Arguments

 = PixbufFormat

info: a PixbufFormat.

-> IO ()

Defines the type of the function used to fill a PixbufFormat structure with information about a module.

Since: 2.2

dynamic_PixbufModuleFillInfoFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufModuleFillInfoFunc

-> PixbufFormat

info: a PixbufFormat.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModuleFillInfoFunc :: MonadIO m => PixbufModuleFillInfoFunc -> m (GClosure C_PixbufModuleFillInfoFunc)

Wrap the callback into a GClosure.

mk_PixbufModuleFillInfoFunc :: C_PixbufModuleFillInfoFunc -> IO (FunPtr C_PixbufModuleFillInfoFunc)

Generate a function pointer callable from C code, from a C_PixbufModuleFillInfoFunc.

noPixbufModuleFillInfoFunc :: Maybe PixbufModuleFillInfoFunc

A convenience synonym for Nothing :: Maybe PixbufModuleFillInfoFunc.

wrap_PixbufModuleFillInfoFunc :: Maybe (Ptr (FunPtr C_PixbufModuleFillInfoFunc)) -> PixbufModuleFillInfoFunc -> C_PixbufModuleFillInfoFunc

Wrap a PixbufModuleFillInfoFunc into a C_PixbufModuleFillInfoFunc.

PixbufModuleFillVtableFunc

type C_PixbufModuleFillVtableFunc = Ptr PixbufModule -> IO ()

Type for the callback on the (unwrapped) C side.

type PixbufModuleFillVtableFunc

Arguments

 = PixbufModule

module: a PixbufModule.

-> IO ()

Defines the type of the function used to set the vtable of a PixbufModule when it is loaded.

Since: 2.2

dynamic_PixbufModuleFillVtableFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufModuleFillVtableFunc

-> PixbufModule

module: a PixbufModule.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModuleFillVtableFunc :: MonadIO m => PixbufModuleFillVtableFunc -> m (GClosure C_PixbufModuleFillVtableFunc)

Wrap the callback into a GClosure.

mk_PixbufModuleFillVtableFunc :: C_PixbufModuleFillVtableFunc -> IO (FunPtr C_PixbufModuleFillVtableFunc)

Generate a function pointer callable from C code, from a C_PixbufModuleFillVtableFunc.

noPixbufModuleFillVtableFunc :: Maybe PixbufModuleFillVtableFunc

A convenience synonym for Nothing :: Maybe PixbufModuleFillVtableFunc.

wrap_PixbufModuleFillVtableFunc :: Maybe (Ptr (FunPtr C_PixbufModuleFillVtableFunc)) -> PixbufModuleFillVtableFunc -> C_PixbufModuleFillVtableFunc

Wrap a PixbufModuleFillVtableFunc into a C_PixbufModuleFillVtableFunc.

PixbufModuleIsSaveOptionSupportedFieldCallback

type C_PixbufModuleIsSaveOptionSupportedFieldCallback = CString -> IO CInt

Type for the callback on the (unwrapped) C side.

type PixbufModuleIsSaveOptionSupportedFieldCallback = Text -> IO Bool

No description available in the introspection data.

dynamic_PixbufModuleIsSaveOptionSupportedFieldCallback :: (HasCallStack, MonadIO m) => FunPtr C_PixbufModuleIsSaveOptionSupportedFieldCallback -> Text -> m Bool

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModuleIsSaveOptionSupportedFieldCallback :: MonadIO m => PixbufModuleIsSaveOptionSupportedFieldCallback -> m (GClosure C_PixbufModuleIsSaveOptionSupportedFieldCallback)

Wrap the callback into a GClosure.

mk_PixbufModuleIsSaveOptionSupportedFieldCallback :: C_PixbufModuleIsSaveOptionSupportedFieldCallback -> IO (FunPtr C_PixbufModuleIsSaveOptionSupportedFieldCallback)

Generate a function pointer callable from C code, from a C_PixbufModuleIsSaveOptionSupportedFieldCallback.

noPixbufModuleIsSaveOptionSupportedFieldCallback :: Maybe PixbufModuleIsSaveOptionSupportedFieldCallback

A convenience synonym for Nothing :: Maybe PixbufModuleIsSaveOptionSupportedFieldCallback.

wrap_PixbufModuleIsSaveOptionSupportedFieldCallback :: Maybe (Ptr (FunPtr C_PixbufModuleIsSaveOptionSupportedFieldCallback)) -> PixbufModuleIsSaveOptionSupportedFieldCallback -> C_PixbufModuleIsSaveOptionSupportedFieldCallback

Wrap a PixbufModuleIsSaveOptionSupportedFieldCallback into a C_PixbufModuleIsSaveOptionSupportedFieldCallback.

PixbufModuleLoadIncrementFieldCallback

type C_PixbufModuleLoadIncrementFieldCallback = Ptr () -> Word8 -> Word32 -> Ptr (Ptr GError) -> IO CInt

Type for the callback on the (unwrapped) C side.

type PixbufModuleLoadIncrementFieldCallback

Arguments

 = Ptr ()

-> Word8

-> Word32

-> IO ()

(Can throw GError)

No description available in the introspection data.

dynamic_PixbufModuleLoadIncrementFieldCallback

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufModuleLoadIncrementFieldCallback

-> Ptr ()

-> Word8

-> Word32

-> m ()

(Can throw GError)

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

mk_PixbufModuleLoadIncrementFieldCallback :: C_PixbufModuleLoadIncrementFieldCallback -> IO (FunPtr C_PixbufModuleLoadIncrementFieldCallback)

Generate a function pointer callable from C code, from a C_PixbufModuleLoadIncrementFieldCallback.

noPixbufModuleLoadIncrementFieldCallback :: Maybe PixbufModuleLoadIncrementFieldCallback

A convenience synonym for Nothing :: Maybe PixbufModuleLoadIncrementFieldCallback.

PixbufModulePreparedFunc

type C_PixbufModulePreparedFunc = Ptr Pixbuf -> Ptr PixbufAnimation -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type PixbufModulePreparedFunc

Arguments

 = Pixbuf

pixbuf: the Pixbuf that is currently being loaded.

-> PixbufAnimation

anim: if an animation is being loaded, the PixbufAnimation, else Nothing.

-> IO ()

Defines the type of the function that gets called once the initial setup of pixbuf is done.

PixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal.

Since: 2.2

type PixbufModulePreparedFunc_WithClosures

Arguments

 = Pixbuf

pixbuf: the Pixbuf that is currently being loaded.

-> PixbufAnimation

anim: if an animation is being loaded, the PixbufAnimation, else Nothing.

-> Ptr ()

userData: the loader.

-> IO ()

Defines the type of the function that gets called once the initial setup of pixbuf is done.

PixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal.

Since: 2.2

drop_closures_PixbufModulePreparedFunc :: PixbufModulePreparedFunc -> PixbufModulePreparedFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_PixbufModulePreparedFunc

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a, IsPixbufAnimation b)

=> FunPtr C_PixbufModulePreparedFunc

-> a

pixbuf: the Pixbuf that is currently being loaded.

-> b

anim: if an animation is being loaded, the PixbufAnimation, else Nothing.

-> Ptr ()

userData: the loader.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModulePreparedFunc :: MonadIO m => PixbufModulePreparedFunc -> m (GClosure C_PixbufModulePreparedFunc)

Wrap the callback into a GClosure.

mk_PixbufModulePreparedFunc :: C_PixbufModulePreparedFunc -> IO (FunPtr C_PixbufModulePreparedFunc)

Generate a function pointer callable from C code, from a C_PixbufModulePreparedFunc.

noPixbufModulePreparedFunc :: Maybe PixbufModulePreparedFunc

A convenience synonym for Nothing :: Maybe PixbufModulePreparedFunc.

noPixbufModulePreparedFunc_WithClosures :: Maybe PixbufModulePreparedFunc_WithClosures

A convenience synonym for Nothing :: Maybe PixbufModulePreparedFunc_WithClosures.

wrap_PixbufModulePreparedFunc :: Maybe (Ptr (FunPtr C_PixbufModulePreparedFunc)) -> PixbufModulePreparedFunc_WithClosures -> C_PixbufModulePreparedFunc

Wrap a PixbufModulePreparedFunc into a C_PixbufModulePreparedFunc.

PixbufModuleSaveFieldCallback

type C_PixbufModuleSaveFieldCallback = Ptr () -> Ptr Pixbuf -> CString -> CString -> Ptr (Ptr GError) -> IO CInt

Type for the callback on the (unwrapped) C side.

type PixbufModuleSaveFieldCallback

Arguments

 = Ptr ()

-> Pixbuf

-> Text

-> Text

-> IO ()

(Can throw GError)

No description available in the introspection data.

dynamic_PixbufModuleSaveFieldCallback

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)

=> FunPtr C_PixbufModuleSaveFieldCallback

-> Ptr ()

-> a

-> Text

-> Text

-> m ()

(Can throw GError)

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

mk_PixbufModuleSaveFieldCallback :: C_PixbufModuleSaveFieldCallback -> IO (FunPtr C_PixbufModuleSaveFieldCallback)

Generate a function pointer callable from C code, from a C_PixbufModuleSaveFieldCallback.

noPixbufModuleSaveFieldCallback :: Maybe PixbufModuleSaveFieldCallback

A convenience synonym for Nothing :: Maybe PixbufModuleSaveFieldCallback.

PixbufModuleSizeFunc

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

Type for the callback on the (unwrapped) C side.

type PixbufModuleSizeFunc

Arguments

 = Int32

width: pointer to a location containing the current image width

-> Int32

height: pointer to a location containing the current image height

-> IO ()

Defines the type of the function that gets called once the size of the loaded image is known.

The function is expected to set width and height to the desired size to which the image should be scaled. If a module has no efficient way to achieve the desired scaling during the loading of the image, it may either ignore the size request, or only approximate it - gdk-pixbuf will then perform the required scaling on the completely loaded image.

If the function sets width or height to zero, the module should interpret this as a hint that it will be closed soon and shouldn't allocate further resources. This convention is used to implement pixbufGetFileInfo efficiently.

Since: 2.2

type PixbufModuleSizeFunc_WithClosures

Arguments

 = Int32

width: pointer to a location containing the current image width

-> Int32

height: pointer to a location containing the current image height

-> Ptr ()

userData: the loader.

-> IO ()

Defines the type of the function that gets called once the size of the loaded image is known.

The function is expected to set width and height to the desired size to which the image should be scaled. If a module has no efficient way to achieve the desired scaling during the loading of the image, it may either ignore the size request, or only approximate it - gdk-pixbuf will then perform the required scaling on the completely loaded image.

If the function sets width or height to zero, the module should interpret this as a hint that it will be closed soon and shouldn't allocate further resources. This convention is used to implement pixbufGetFileInfo efficiently.

Since: 2.2

drop_closures_PixbufModuleSizeFunc :: PixbufModuleSizeFunc -> PixbufModuleSizeFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_PixbufModuleSizeFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufModuleSizeFunc

-> Int32

width: pointer to a location containing the current image width

-> Int32

height: pointer to a location containing the current image height

-> Ptr ()

userData: the loader.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModuleSizeFunc :: MonadIO m => PixbufModuleSizeFunc -> m (GClosure C_PixbufModuleSizeFunc)

Wrap the callback into a GClosure.

mk_PixbufModuleSizeFunc :: C_PixbufModuleSizeFunc -> IO (FunPtr C_PixbufModuleSizeFunc)

Generate a function pointer callable from C code, from a C_PixbufModuleSizeFunc.

noPixbufModuleSizeFunc :: Maybe PixbufModuleSizeFunc

A convenience synonym for Nothing :: Maybe PixbufModuleSizeFunc.

noPixbufModuleSizeFunc_WithClosures :: Maybe PixbufModuleSizeFunc_WithClosures

A convenience synonym for Nothing :: Maybe PixbufModuleSizeFunc_WithClosures.

wrap_PixbufModuleSizeFunc :: Maybe (Ptr (FunPtr C_PixbufModuleSizeFunc)) -> PixbufModuleSizeFunc_WithClosures -> C_PixbufModuleSizeFunc

Wrap a PixbufModuleSizeFunc into a C_PixbufModuleSizeFunc.

PixbufModuleStopLoadFieldCallback

type C_PixbufModuleStopLoadFieldCallback = Ptr () -> Ptr (Ptr GError) -> IO CInt

Type for the callback on the (unwrapped) C side.

type PixbufModuleStopLoadFieldCallback

Arguments

 = Ptr ()

-> IO ()

(Can throw GError)

No description available in the introspection data.

dynamic_PixbufModuleStopLoadFieldCallback

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufModuleStopLoadFieldCallback

-> Ptr ()

-> m ()

(Can throw GError)

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

mk_PixbufModuleStopLoadFieldCallback :: C_PixbufModuleStopLoadFieldCallback -> IO (FunPtr C_PixbufModuleStopLoadFieldCallback)

Generate a function pointer callable from C code, from a C_PixbufModuleStopLoadFieldCallback.

noPixbufModuleStopLoadFieldCallback :: Maybe PixbufModuleStopLoadFieldCallback

A convenience synonym for Nothing :: Maybe PixbufModuleStopLoadFieldCallback.

PixbufModuleUpdatedFunc

type C_PixbufModuleUpdatedFunc = Ptr Pixbuf -> Int32 -> Int32 -> Int32 -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type PixbufModuleUpdatedFunc

Arguments

 = Pixbuf

pixbuf: the Pixbuf that is currently being loaded.

-> Int32

x: the X origin of the updated area.

-> Int32

y: the Y origin of the updated area.

-> Int32

width: the width of the updated area.

-> Int32

height: the height of the updated area.

-> IO ()

Defines the type of the function that gets called every time a region of pixbuf is updated.

PixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-updated">area_updated</link>" signal.

Since: 2.2

type PixbufModuleUpdatedFunc_WithClosures

Arguments

 = Pixbuf

pixbuf: the Pixbuf that is currently being loaded.

-> Int32

x: the X origin of the updated area.

-> Int32

y: the Y origin of the updated area.

-> Int32

width: the width of the updated area.

-> Int32

height: the height of the updated area.

-> Ptr ()

userData: the loader.

-> IO ()

Defines the type of the function that gets called every time a region of pixbuf is updated.

PixbufLoader uses a function of this type to emit the "<link linkend="GdkPixbufLoader-area-updated">area_updated</link>" signal.

Since: 2.2

drop_closures_PixbufModuleUpdatedFunc :: PixbufModuleUpdatedFunc -> PixbufModuleUpdatedFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_PixbufModuleUpdatedFunc

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)

=> FunPtr C_PixbufModuleUpdatedFunc

-> a

pixbuf: the Pixbuf that is currently being loaded.

-> Int32

x: the X origin of the updated area.

-> Int32

y: the Y origin of the updated area.

-> Int32

width: the width of the updated area.

-> Int32

height: the height of the updated area.

-> Ptr ()

userData: the loader.

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufModuleUpdatedFunc :: MonadIO m => PixbufModuleUpdatedFunc -> m (GClosure C_PixbufModuleUpdatedFunc)

Wrap the callback into a GClosure.

mk_PixbufModuleUpdatedFunc :: C_PixbufModuleUpdatedFunc -> IO (FunPtr C_PixbufModuleUpdatedFunc)

Generate a function pointer callable from C code, from a C_PixbufModuleUpdatedFunc.

noPixbufModuleUpdatedFunc :: Maybe PixbufModuleUpdatedFunc

A convenience synonym for Nothing :: Maybe PixbufModuleUpdatedFunc.

noPixbufModuleUpdatedFunc_WithClosures :: Maybe PixbufModuleUpdatedFunc_WithClosures

A convenience synonym for Nothing :: Maybe PixbufModuleUpdatedFunc_WithClosures.

wrap_PixbufModuleUpdatedFunc :: Maybe (Ptr (FunPtr C_PixbufModuleUpdatedFunc)) -> PixbufModuleUpdatedFunc_WithClosures -> C_PixbufModuleUpdatedFunc

Wrap a PixbufModuleUpdatedFunc into a C_PixbufModuleUpdatedFunc.

PixbufSaveFunc

type C_PixbufSaveFunc = Ptr Word8 -> Word64 -> Ptr (Ptr GError) -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type PixbufSaveFunc

Arguments

 = ByteString

buf: bytes to be written.

-> IO (Bool, GError)

Returns: TRUE if successful, FALSE otherwise

Save functions used by Pixbuf.save_to_callback().

This function is called once for each block of bytes that is "written" by gdk_pixbuf_save_to_callback().

If successful it should return TRUE; if an error occurs it should set error and return FALSE, in which case gdk_pixbuf_save_to_callback() will fail with the same error.

Since: 2.4

type PixbufSaveFunc_WithClosures

Arguments

 = ByteString

buf: bytes to be written.

-> Ptr ()

data: user data passed to gdk_pixbuf_save_to_callback().

-> IO (Bool, GError)

Returns: TRUE if successful, FALSE otherwise

Save functions used by Pixbuf.save_to_callback().

This function is called once for each block of bytes that is "written" by gdk_pixbuf_save_to_callback().

If successful it should return TRUE; if an error occurs it should set error and return FALSE, in which case gdk_pixbuf_save_to_callback() will fail with the same error.

Since: 2.4

drop_closures_PixbufSaveFunc :: PixbufSaveFunc -> PixbufSaveFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_PixbufSaveFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_PixbufSaveFunc

-> ByteString

buf: bytes to be written.

-> Ptr ()

data: user data passed to gdk_pixbuf_save_to_callback().

-> m (Bool, GError)

Returns: TRUE if successful, FALSE otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_PixbufSaveFunc :: MonadIO m => PixbufSaveFunc -> m (GClosure C_PixbufSaveFunc)

Wrap the callback into a GClosure.

mk_PixbufSaveFunc :: C_PixbufSaveFunc -> IO (FunPtr C_PixbufSaveFunc)

Generate a function pointer callable from C code, from a C_PixbufSaveFunc.

noPixbufSaveFunc :: Maybe PixbufSaveFunc

A convenience synonym for Nothing :: Maybe PixbufSaveFunc.

noPixbufSaveFunc_WithClosures :: Maybe PixbufSaveFunc_WithClosures

A convenience synonym for Nothing :: Maybe PixbufSaveFunc_WithClosures.

wrap_PixbufSaveFunc :: Maybe (Ptr (FunPtr C_PixbufSaveFunc)) -> PixbufSaveFunc_WithClosures -> C_PixbufSaveFunc

Wrap a PixbufSaveFunc into a C_PixbufSaveFunc.