gi-gobject-2.0.15: GObject bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GObject.Callbacks

Contents

Description

 

Synopsis

Signals

BaseFinalizeFunc

dynamic_BaseFinalizeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BaseFinalizeFunc 
-> TypeClass

gClass: The TypeClass structure to finalize

-> m () 

BaseInitFunc

dynamic_BaseInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BaseInitFunc 
-> TypeClass

gClass: The TypeClass structure to initialize

-> m () 

BindingTransformFunc

dynamic_BindingTransformFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsBinding a) 
=> FunPtr C_BindingTransformFunc 
-> a

binding: a Binding

-> GValue

fromValue: the Value containing the value to transform

-> GValue

toValue: the Value in which to store the transformed value

-> Ptr ()

userData: data passed to the transform function

-> m Bool

Returns: True if the transformation was successful, and False otherwise

BoxedCopyFunc

type BoxedCopyFunc = Ptr () -> IO (Ptr ()) Source #

type C_BoxedCopyFunc = Ptr () -> IO (Ptr ()) Source #

dynamic_BoxedCopyFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BoxedCopyFunc 
-> Ptr ()

boxed: The boxed structure to be copied.

-> m (Ptr ())

Returns: The newly created copy of the boxed structure.

BoxedFreeFunc

type BoxedFreeFunc = Ptr () -> IO () Source #

type C_BoxedFreeFunc = Ptr () -> IO () Source #

dynamic_BoxedFreeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BoxedFreeFunc 
-> Ptr ()

boxed: The boxed structure to be freed.

-> m () 

Callback

type C_Callback = IO () Source #

type Callback = IO () Source #

ClassFinalizeFunc

dynamic_ClassFinalizeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ClassFinalizeFunc 
-> TypeClass

gClass: The TypeClass structure to finalize

-> Ptr ()

classData: The classData member supplied via the TypeInfo structure

-> m () 

ClassInitFunc

type ClassInitFunc = TypeClass -> Ptr () -> IO () Source #

dynamic_ClassInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ClassInitFunc 
-> TypeClass

gClass: The TypeClass structure to initialize.

-> Ptr ()

classData: The classData member supplied via the TypeInfo structure.

-> m () 

ClosureMarshalFieldCallback

ClosureNotify

type C_ClosureNotify = Ptr () -> Ptr Closure -> IO () Source #

type ClosureNotify = Ptr () -> Closure -> IO () Source #

dynamic_ClosureNotify Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ClosureNotify 
-> Ptr ()

data: data specified when registering the notification callback

-> Closure

closure: the Closure on which the notification is emitted

-> m () 

InstanceInitFunc

dynamic_InstanceInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_InstanceInitFunc 
-> TypeInstance

instance: The instance to initialize

-> TypeClass

gClass: The class of the type the instance is created for

-> m () 

InterfaceFinalizeFunc

dynamic_InterfaceFinalizeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_InterfaceFinalizeFunc 
-> TypeInterface

gIface: The interface structure to finalize

-> Ptr ()

ifaceData: The interfaceData supplied via the InterfaceInfo structure

-> m () 

InterfaceInitFunc

dynamic_InterfaceInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_InterfaceInitFunc 
-> TypeInterface

gIface: The interface structure to initialize

-> Ptr ()

ifaceData: The interfaceData supplied via the InterfaceInfo structure

-> m () 

ObjectFinalizeFunc

dynamic_ObjectFinalizeFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_ObjectFinalizeFunc 
-> a

object: the Object being finalized

-> m () 

ObjectGetPropertyFunc

dynamic_ObjectGetPropertyFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_ObjectGetPropertyFunc 
-> a

object: a Object

-> Word32

propertyId: the numeric id under which the property was registered with objectClassInstallProperty.

-> GValue

value: a Value to return the property value in

-> GParamSpec

pspec: the ParamSpec describing the property

-> m () 

ObjectSetPropertyFunc

dynamic_ObjectSetPropertyFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_ObjectSetPropertyFunc 
-> a

object: a Object

-> Word32

propertyId: the numeric id under which the property was registered with objectClassInstallProperty.

-> GValue

value: the new value for the property

-> GParamSpec

pspec: the ParamSpec describing the property

-> m () 

ParamSpecTypeInfoFinalizeFieldCallback

ParamSpecTypeInfoInstanceInitFieldCallback

ParamSpecTypeInfoValueSetDefaultFieldCallback

ParamSpecTypeInfoValueValidateFieldCallback

ParamSpecTypeInfoValuesCmpFieldCallback

SignalAccumulator

dynamic_SignalAccumulator Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_SignalAccumulator 
-> SignalInvocationHint

ihint: Signal invocation hint, see SignalInvocationHint.

-> GValue

returnAccu: Accumulator to collect callback return values in, this is the return value of the current signal emission.

-> GValue

handlerReturn: A Value holding the return value of the signal handler.

-> Ptr ()

data: Callback data that was specified when creating the signal.

-> m Bool

Returns: The accumulator function returns whether the signal emission should be aborted. Returning False means to abort the current emission and True is returned for continuation.

SignalEmissionHook

dynamic_SignalEmissionHook Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_SignalEmissionHook 
-> SignalInvocationHint

ihint: Signal invocation hint, see SignalInvocationHint.

-> [GValue]

paramValues: the instance on which the signal was emitted, followed by the parameters of the emission.

-> Ptr ()

data: user data associated with the hook.

-> m Bool

Returns: whether it wants to stay connected. If it returns False, the signal hook is disconnected (and destroyed).

ToggleNotify

type C_ToggleNotify = Ptr () -> Ptr Object -> CInt -> IO () Source #

type ToggleNotify = Ptr () -> Object -> Bool -> IO () Source #

dynamic_ToggleNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_ToggleNotify 
-> Ptr ()

data: Callback data passed to g_object_add_toggle_ref()

-> a

object: The object on which g_object_add_toggle_ref() was called.

-> Bool

isLastRef: True if the toggle reference is now the last reference to the object. False if the toggle reference was the last reference and there are now other references.

-> m () 

TypeClassCacheFunc

dynamic_TypeClassCacheFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TypeClassCacheFunc 
-> Ptr ()

cacheData: data that was given to the g_type_add_class_cache_func() call

-> TypeClass

gClass: The TypeClass structure which is unreferenced

-> m Bool

Returns: True to stop further GTypeClassCacheFuncs from being called, False to continue

TypeInterfaceCheckFunc

dynamic_TypeInterfaceCheckFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TypeInterfaceCheckFunc 
-> Ptr ()

checkData: data passed to g_type_add_interface_check()

-> TypeInterface

gIface: the interface that has been initialized

-> m () 

TypePluginCompleteInterfaceInfo

dynamic_TypePluginCompleteInterfaceInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsTypePlugin a) 
=> FunPtr C_TypePluginCompleteInterfaceInfo 
-> a

plugin: the TypePlugin

-> GType

instanceType: the GType of an instantiable type to which the interface is added

-> GType

interfaceType: the GType of the interface whose info is completed

-> InterfaceInfo

info: the InterfaceInfo to fill in

-> m () 

TypePluginCompleteTypeInfo

dynamic_TypePluginCompleteTypeInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsTypePlugin a) 
=> FunPtr C_TypePluginCompleteTypeInfo 
-> a

plugin: the TypePlugin

-> GType

gType: the GType whose info is completed

-> TypeInfo

info: the TypeInfo struct to fill in

-> TypeValueTable

valueTable: the TypeValueTable to fill in

-> m () 

TypePluginUnuse

dynamic_TypePluginUnuse Source #

Arguments

:: (HasCallStack, MonadIO m, IsTypePlugin a) 
=> FunPtr C_TypePluginUnuse 
-> a

plugin: the TypePlugin whose use count should be decreased

-> m () 

TypePluginUse

dynamic_TypePluginUse Source #

Arguments

:: (HasCallStack, MonadIO m, IsTypePlugin a) 
=> FunPtr C_TypePluginUse 
-> a

plugin: the TypePlugin whose use count should be increased

-> m () 

TypeValueTableCollectValueFieldCallback

TypeValueTableLcopyValueFieldCallback

TypeValueTableValueCopyFieldCallback

TypeValueTableValueFreeFieldCallback

TypeValueTableValueInitFieldCallback

TypeValueTableValuePeekPointerFieldCallback

ValueTransform

dynamic_ValueTransform Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ValueTransform 
-> GValue

srcValue: Source value.

-> GValue

destValue: Target value.

-> m () 

WeakNotify

type C_WeakNotify = Ptr () -> Ptr Object -> IO () Source #

type WeakNotify = Ptr () -> Object -> IO () Source #

dynamic_WeakNotify Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_WeakNotify 
-> Ptr ()

data: data that was provided when the weak reference was established

-> a

whereTheObjectWas: the object being finalized

-> m ()