| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.HookList
Description
The HookList struct represents a list of hook functions.
Synopsis
- newtype HookList = HookList (ManagedPtr HookList)
- newZeroHookList :: MonadIO m => m HookList
- type family ResolveHookListMethod (t :: Symbol) o where ...
- data HookListClearMethodInfo
- hookListClear :: (HasCallStack, MonadIO m) => HookList -> m ()
- data HookListInitMethodInfo
- hookListInit :: (HasCallStack, MonadIO m) => HookList -> Word32 -> m ()
- data HookListInvokeMethodInfo
- hookListInvoke :: (HasCallStack, MonadIO m) => HookList -> Bool -> m ()
- data HookListInvokeCheckMethodInfo
- hookListInvokeCheck :: (HasCallStack, MonadIO m) => HookList -> Bool -> m ()
- data HookListMarshalMethodInfo
- hookListMarshal :: (HasCallStack, MonadIO m) => HookList -> Bool -> HookMarshaller -> m ()
- data HookListMarshalCheckMethodInfo
- hookListMarshalCheck :: (HasCallStack, MonadIO m) => HookList -> Bool -> HookCheckMarshaller -> m ()
- clearHookListDummy3 :: MonadIO m => HookList -> m ()
- getHookListDummy3 :: MonadIO m => HookList -> m (Ptr ())
- hookList_dummy3 :: AttrLabelProxy "dummy3"
- setHookListDummy3 :: MonadIO m => HookList -> Ptr () -> m ()
- clearHookListFinalizeHook :: MonadIO m => HookList -> m ()
- getHookListFinalizeHook :: MonadIO m => HookList -> m (Maybe HookFinalizeFunc)
- hookList_finalizeHook :: AttrLabelProxy "finalizeHook"
- setHookListFinalizeHook :: MonadIO m => HookList -> FunPtr C_HookFinalizeFunc -> m ()
- getHookListHookSize :: MonadIO m => HookList -> m Word32
- hookList_hookSize :: AttrLabelProxy "hookSize"
- setHookListHookSize :: MonadIO m => HookList -> Word32 -> m ()
- clearHookListHooks :: MonadIO m => HookList -> m ()
- getHookListHooks :: MonadIO m => HookList -> m (Maybe Hook)
- hookList_hooks :: AttrLabelProxy "hooks"
- setHookListHooks :: MonadIO m => HookList -> Ptr Hook -> m ()
- getHookListIsSetup :: MonadIO m => HookList -> m Word32
- hookList_isSetup :: AttrLabelProxy "isSetup"
- setHookListIsSetup :: MonadIO m => HookList -> Word32 -> m ()
- getHookListSeqId :: MonadIO m => HookList -> m CULong
- hookList_seqId :: AttrLabelProxy "seqId"
- setHookListSeqId :: MonadIO m => HookList -> CULong -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| HookList (ManagedPtr HookList) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveHookListMethod (t :: Symbol) o where ... Source #
Equations
| ResolveHookListMethod "clear" o = HookListClearMethodInfo | |
| ResolveHookListMethod "init" o = HookListInitMethodInfo | |
| ResolveHookListMethod "invoke" o = HookListInvokeMethodInfo | |
| ResolveHookListMethod "invokeCheck" o = HookListInvokeCheckMethodInfo | |
| ResolveHookListMethod "marshal" o = HookListMarshalMethodInfo | |
| ResolveHookListMethod "marshalCheck" o = HookListMarshalCheckMethodInfo | |
| ResolveHookListMethod l o = MethodResolutionFailed l o :: Type |
clear
data HookListClearMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod HookListClearMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListClearMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => HookList |
|
| -> m () |
init
data HookListInitMethodInfo Source #
Instances
| (signature ~ (Word32 -> m ()), MonadIO m) => OverloadedMethod HookListInitMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListInitMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
invoke
data HookListInvokeMethodInfo Source #
Instances
| (signature ~ (Bool -> m ()), MonadIO m) => OverloadedMethod HookListInvokeMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListInvokeMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
invokeCheck
data HookListInvokeCheckMethodInfo Source #
Instances
| (signature ~ (Bool -> m ()), MonadIO m) => OverloadedMethod HookListInvokeCheckMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListInvokeCheckMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
marshal
data HookListMarshalMethodInfo Source #
Instances
| (signature ~ (Bool -> HookMarshaller -> m ()), MonadIO m) => OverloadedMethod HookListMarshalMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListMarshalMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => HookList |
|
| -> Bool |
|
| -> HookMarshaller |
|
| -> m () |
Calls a function on each valid Hook.
marshalCheck
data HookListMarshalCheckMethodInfo Source #
Instances
| (signature ~ (Bool -> HookCheckMarshaller -> m ()), MonadIO m) => OverloadedMethod HookListMarshalCheckMethodInfo HookList signature Source # | |
Defined in GI.GLib.Structs.HookList Methods overloadedMethod :: HookList -> signature # | |
| OverloadedMethodInfo HookListMarshalCheckMethodInfo HookList Source # | |
Defined in GI.GLib.Structs.HookList Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => HookList |
|
| -> Bool |
|
| -> HookCheckMarshaller |
|
| -> m () |
Properties
dummy3
unused
clearHookListDummy3 :: MonadIO m => HookList -> m () Source #
Set the value of the “dummy3” field to Nothing.
When overloading is enabled, this is equivalent to
clear #dummy3
getHookListDummy3 :: MonadIO m => HookList -> m (Ptr ()) Source #
Get the value of the “dummy3” field.
When overloading is enabled, this is equivalent to
get hookList #dummy3
hookList_dummy3 :: AttrLabelProxy "dummy3" Source #
setHookListDummy3 :: MonadIO m => HookList -> Ptr () -> m () Source #
Set the value of the “dummy3” field.
When overloading is enabled, this is equivalent to
sethookList [ #dummy3:=value ]
finalizeHook
the function to call to finalize a Hook element.
The default behaviour is to call the hooks destroy function
clearHookListFinalizeHook :: MonadIO m => HookList -> m () Source #
Set the value of the “finalize_hook” field to Nothing.
When overloading is enabled, this is equivalent to
clear #finalizeHook
getHookListFinalizeHook :: MonadIO m => HookList -> m (Maybe HookFinalizeFunc) Source #
Get the value of the “finalize_hook” field.
When overloading is enabled, this is equivalent to
get hookList #finalizeHook
hookList_finalizeHook :: AttrLabelProxy "finalizeHook" Source #
setHookListFinalizeHook :: MonadIO m => HookList -> FunPtr C_HookFinalizeFunc -> m () Source #
Set the value of the “finalize_hook” field.
When overloading is enabled, this is equivalent to
sethookList [ #finalizeHook:=value ]
hookSize
the size of the HookList elements, in bytes
getHookListHookSize :: MonadIO m => HookList -> m Word32 Source #
Get the value of the “hook_size” field.
When overloading is enabled, this is equivalent to
get hookList #hookSize
hookList_hookSize :: AttrLabelProxy "hookSize" Source #
setHookListHookSize :: MonadIO m => HookList -> Word32 -> m () Source #
Set the value of the “hook_size” field.
When overloading is enabled, this is equivalent to
sethookList [ #hookSize:=value ]
hooks
the first Hook element in the list
clearHookListHooks :: MonadIO m => HookList -> m () Source #
Set the value of the “hooks” field to Nothing.
When overloading is enabled, this is equivalent to
clear #hooks
getHookListHooks :: MonadIO m => HookList -> m (Maybe Hook) Source #
Get the value of the “hooks” field.
When overloading is enabled, this is equivalent to
get hookList #hooks
hookList_hooks :: AttrLabelProxy "hooks" Source #
setHookListHooks :: MonadIO m => HookList -> Ptr Hook -> m () Source #
Set the value of the “hooks” field.
When overloading is enabled, this is equivalent to
sethookList [ #hooks:=value ]
isSetup
1 if the HookList has been initialized
getHookListIsSetup :: MonadIO m => HookList -> m Word32 Source #
Get the value of the “is_setup” field.
When overloading is enabled, this is equivalent to
get hookList #isSetup
hookList_isSetup :: AttrLabelProxy "isSetup" Source #
setHookListIsSetup :: MonadIO m => HookList -> Word32 -> m () Source #
Set the value of the “is_setup” field.
When overloading is enabled, this is equivalent to
sethookList [ #isSetup:=value ]
seqId
the next free Hook id
getHookListSeqId :: MonadIO m => HookList -> m CULong Source #
Get the value of the “seq_id” field.
When overloading is enabled, this is equivalent to
get hookList #seqId
hookList_seqId :: AttrLabelProxy "seqId" Source #
setHookListSeqId :: MonadIO m => HookList -> CULong -> m () Source #
Set the value of the “seq_id” field.
When overloading is enabled, this is equivalent to
sethookList [ #seqId:=value ]