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.GObject.Structs.CClosure

Contents

Exported types
Methods
Properties
- callback
- closure

Description

A CClosure is a specialization of Closure for C function callbacks.

Synopsis

Exported types

newtype CClosure #

Constructors

CClosure (ManagedPtr CClosure)

Instances

WrappedPtr CClosure #
Methods wrappedPtrCalloc :: IO (Ptr CClosure) # wrappedPtrCopy :: CClosure -> IO CClosure # wrappedPtrFree :: Maybe (FunPtr (Ptr CClosure -> IO ())) #
(~) AttrOpTag tag AttrSet => Constructible CClosure tag #
Methods new :: MonadIO m => (ManagedPtr CClosure -> CClosure) -> [AttrOp CClosure tag] -> m CClosure #
((~) * info (ResolveCClosureMethod t CClosure), MethodInfo * info CClosure p) => IsLabel t (CClosure -> p) #
Methods fromLabel :: Proxy# Symbol t -> CClosure -> p #
((~) * info (ResolveCClosureMethod t CClosure), MethodInfo * info CClosure p) => IsLabelProxy t (CClosure -> p) #
Methods fromLabelProxy :: Proxy Symbol t -> CClosure -> p #
HasAttributeList * CClosure #

type AttributeList CClosure #
type AttributeList CClosure

newZeroCClosure :: MonadIO m => m CClosure #

Construct a CClosure struct initialized to zero.

noCClosure :: Maybe CClosure #

Methods

marshalBOOLEAN_BOXEDBOXED

cClosureMarshalBOOLEAN_BOXEDBOXED #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as signalAccumulatorTrueHandled.

marshalBOOLEAN_FLAGS

cClosureMarshalBOOLEAN_FLAGS #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with handlers that take a flags type as an argument and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as signalAccumulatorTrueHandled.

marshalGeneric

cClosureMarshalGeneric #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnGvalue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A generic marshaller function implemented via libffi.

Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a Nothing marshaller.

Since: 2.30

marshalSTRING_OBJECTPOINTER

cClosureMarshalSTRING_OBJECTPOINTER #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with handlers that take a Object and a pointer and produce a string. It is highly unlikely that your signal handler fits this description.

marshalVOID_BOOLEAN

cClosureMarshalVOID_BOOLEAN #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single boolean argument.

marshalVOID_BOXED

cClosureMarshalVOID_BOXED #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single argument which is any boxed pointer type.

marshalVOID_CHAR

cClosureMarshalVOID_CHAR #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single character argument.

marshalVOID_DOUBLE

cClosureMarshalVOID_DOUBLE #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with one double-precision floating point argument.

marshalVOID_ENUM

cClosureMarshalVOID_ENUM #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single argument with an enumerated type.

marshalVOID_FLAGS

cClosureMarshalVOID_FLAGS #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single argument with a flags types.

marshalVOID_FLOAT

cClosureMarshalVOID_FLOAT #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with one single-precision floating point argument.

marshalVOID_INT

cClosureMarshalVOID_INT #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single integer argument.

marshalVOID_LONG

cClosureMarshalVOID_LONG #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with with a single long integer argument.

marshalVOID_OBJECT

cClosureMarshalVOID_OBJECT #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single Object argument.

marshalVOID_PARAM

cClosureMarshalVOID_PARAM #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single argument of type ParamSpec.

marshalVOID_POINTER

cClosureMarshalVOID_POINTER #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single raw pointer argument type.

If it is possible, it is better to use one of the more specific functions such as cclosureMarshalVOID_OBJECT or cclosureMarshalVOID_OBJECT.

marshalVOID_STRING

cClosureMarshalVOID_STRING #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single string argument.

marshalVOID_UCHAR

cClosureMarshalVOID_UCHAR #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single unsigned character argument.

marshalVOID_UINT

cClosureMarshalVOID_UINT #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with with a single unsigned integer argument.

marshalVOID_UINTPOINTER

cClosureMarshalVOID_UINTPOINTER #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a unsigned int and a pointer as arguments.

marshalVOID_ULONG

cClosureMarshalVOID_ULONG #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single unsigned long integer argument.

marshalVOID_VARIANT

cClosureMarshalVOID_VARIANT #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with a single GVariant argument.

marshalVOID_VOID

cClosureMarshalVOID_VOID #

Arguments

:: (HasCallStack, MonadIO m)
=> Closure	`closure`: A `Closure`.
-> GValue	`returnValue`: A `Value` to store the return value. May be `Nothing` if the callback of closure doesn't return a value.
-> Word32	`nParamValues`: The length of the `paramValues` array.
-> GValue	`paramValues`: An array of `GValues` holding the arguments on which to invoke the callback of closure.
-> Ptr ()	`invocationHint`: The invocation hint given as the last argument to `closureInvoke`.
-> Ptr ()	`marshalData`: Additional data specified when registering the marshaller, see `g_closure_set_marshal()` and `g_closure_set_meta_marshal()`
-> m ()

A GClosureMarshal function for use with signals with no arguments.

Properties

callback

cClosure_callback :: AttrLabelProxy "callback" #

clearCClosureCallback :: MonadIO m => CClosure -> m () #

getCClosureCallback :: MonadIO m => CClosure -> m (Ptr ()) #

setCClosureCallback :: MonadIO m => CClosure -> Ptr () -> m () #

closure

cClosure_closure :: AttrLabelProxy "closure" #

getCClosureClosure :: MonadIO m => CClosure -> m Closure #