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 |
The HookList
struct represents a list of hook functions.
Synopsis
- newtype HookList = HookList (ManagedPtr HookList)
- newZeroHookList :: MonadIO m => m HookList
- noHookList :: Maybe HookList
- hookListClear :: (HasCallStack, MonadIO m) => HookList -> m ()
- hookListInit :: (HasCallStack, MonadIO m) => HookList -> Word32 -> m ()
- hookListInvoke :: (HasCallStack, MonadIO m) => HookList -> Bool -> m ()
- hookListInvokeCheck :: (HasCallStack, MonadIO m) => HookList -> Bool -> m ()
- clearHookListDummy3 :: MonadIO m => HookList -> m ()
- getHookListDummy3 :: MonadIO m => HookList -> m (Ptr ())
- setHookListDummy3 :: MonadIO m => HookList -> Ptr () -> m ()
- clearHookListFinalizeHook :: MonadIO m => HookList -> m ()
- getHookListFinalizeHook :: MonadIO m => HookList -> m (Maybe HookFinalizeFunc)
- setHookListFinalizeHook :: MonadIO m => HookList -> FunPtr C_HookFinalizeFunc -> m ()
- getHookListHookSize :: MonadIO m => HookList -> m Word32
- setHookListHookSize :: MonadIO m => HookList -> Word32 -> m ()
- clearHookListHooks :: MonadIO m => HookList -> m ()
- getHookListHooks :: MonadIO m => HookList -> m (Maybe Hook)
- setHookListHooks :: MonadIO m => HookList -> Ptr Hook -> m ()
- getHookListIsSetup :: MonadIO m => HookList -> m Word32
- setHookListIsSetup :: MonadIO m => HookList -> Word32 -> m ()
- getHookListSeqId :: MonadIO m => HookList -> m CULong
- setHookListSeqId :: MonadIO m => HookList -> CULong -> m ()
Exported types
Memory-managed wrapper type.
Instances
WrappedPtr HookList Source # | |
Defined in GI.GLib.Structs.HookList | |
tag ~ AttrSet => Constructible HookList tag Source # | |
Defined in GI.GLib.Structs.HookList |
Methods
clear
:: (HasCallStack, MonadIO m) | |
=> HookList |
|
-> m () |
init
invoke
invokeCheck
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
setHookListDummy3 :: MonadIO m => HookList -> Ptr () -> m () Source #
Set the value of the “dummy3
” field.
When overloading is enabled, this is equivalent to
set
hookList [ #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
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
set
hookList [ #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
setHookListHookSize :: MonadIO m => HookList -> Word32 -> m () Source #
Set the value of the “hook_size
” field.
When overloading is enabled, this is equivalent to
set
hookList [ #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
setHookListHooks :: MonadIO m => HookList -> Ptr Hook -> m () Source #
Set the value of the “hooks
” field.
When overloading is enabled, this is equivalent to
set
hookList [ #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
setHookListIsSetup :: MonadIO m => HookList -> Word32 -> m () Source #
Set the value of the “is_setup
” field.
When overloading is enabled, this is equivalent to
set
hookList [ #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
setHookListSeqId :: MonadIO m => HookList -> CULong -> m () Source #
Set the value of the “seq_id
” field.
When overloading is enabled, this is equivalent to
set
hookList [ #seqId:=
value ]