GI.GLib.Structs.HookList

The HookList struct represents a list of hook functions.

Exported types

newtype HookList

Constructors

HookList (ManagedPtr HookList)

Instances

WrappedPtr HookList

Methods

wrappedPtrCalloc :: IO (Ptr HookList)

wrappedPtrCopy :: HookList -> IO HookList

wrappedPtrFree :: Maybe (FunPtr (Ptr HookList -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible HookList tag

Methods

new :: MonadIO m => (ManagedPtr HookList -> HookList) -> [AttrOp HookList tag] -> m HookList

newZeroHookList :: MonadIO m => m HookList

Construct a HookList struct initialized to zero.

noHookList :: Maybe HookList

Methods

clear

hookListClear

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> m ()

Removes all the Hook elements from a HookList.

init

hookListInit

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Word32

hookSize: the size of each element in the HookList, typically sizeof (GHook).

-> m ()

Initializes a HookList. This must be called before the HookList is used.

invoke

hookListInvoke

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Bool

mayRecurse: True if functions which are already running (e.g. in another thread) can be called. If set to False, these are skipped

-> m ()

Calls all of the Hook functions in a HookList.

invokeCheck

hookListInvokeCheck

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Bool

mayRecurse: True if functions which are already running (e.g. in another thread) can be called. If set to False, these are skipped

-> m ()

Calls all of the Hook functions in a HookList. Any function which returns False is removed from the HookList.

Properties

dummy3

clearHookListDummy3 :: MonadIO m => HookList -> m ()

getHookListDummy3 :: MonadIO m => HookList -> m (Ptr ())

setHookListDummy3 :: MonadIO m => HookList -> Ptr () -> m ()

finalizeHook

clearHookListFinalizeHook :: MonadIO m => HookList -> m ()

getHookListFinalizeHook :: MonadIO m => HookList -> m (Maybe HookFinalizeFunc)

setHookListFinalizeHook :: MonadIO m => HookList -> FunPtr C_HookFinalizeFunc -> m ()

hookSize

getHookListHookSize :: MonadIO m => HookList -> m Word32

setHookListHookSize :: MonadIO m => HookList -> Word32 -> m ()

hooks

clearHookListHooks :: MonadIO m => HookList -> m ()

getHookListHooks :: MonadIO m => HookList -> m (Maybe Hook)

setHookListHooks :: MonadIO m => HookList -> Ptr Hook -> m ()

isSetup

getHookListIsSetup :: MonadIO m => HookList -> m Word32

setHookListIsSetup :: MonadIO m => HookList -> Word32 -> m ()

seqId

getHookListSeqId :: MonadIO m => HookList -> m CULong

setHookListSeqId :: MonadIO m => HookList -> CULong -> m ()