GI.GLib.Structs.Hook

The Hook struct represents a single hook function in a HookList.

Exported types

newtype Hook

Constructors

Hook (ManagedPtr Hook)

Instances

WrappedPtr Hook

Methods

wrappedPtrCalloc :: IO (Ptr Hook)

wrappedPtrCopy :: Hook -> IO Hook

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

(~) AttrOpTag tag AttrSet => Constructible Hook tag

Methods

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

newZeroHook :: MonadIO m => m Hook

Construct a Hook struct initialized to zero.

noHook :: Maybe Hook

Methods

compareIds

hookCompareIds

Arguments

:: (HasCallStack, MonadIO m)

=> Hook

newHook: a Hook

-> Hook

sibling: a Hook to compare with newHook

-> m Int32

Returns: a value <= 0 if the id of sibling is >= the id of newHook

Compares the ids of two Hook elements, returning a negative value if the second id is greater than the first.

destroy

hookDestroy

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> CULong

hookId: a hook ID

-> m Bool

Returns: True if the Hook was found in the HookList and destroyed

Destroys a Hook, given its ID.

destroyLink

hookDestroyLink

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Hook

hook: the Hook to remove

-> m ()

Removes one Hook from a HookList, marking it inactive and calling hookUnref on it.

free

hookFree

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Hook

hook: the Hook to free

-> m ()

Calls the HookList finalizeHook function if it exists, and frees the memory allocated for the Hook.

insertBefore

hookInsertBefore

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Maybe Hook

sibling: the Hook to insert the new Hook before

-> Hook

hook: the Hook to insert

-> m ()

Inserts a Hook into a HookList, before a given Hook.

prepend

hookPrepend

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Hook

hook: the Hook to add to the start of hookList

-> m ()

Prepends a Hook on the start of a HookList.

unref

hookUnref

Arguments

:: (HasCallStack, MonadIO m)

=> HookList

hookList: a HookList

-> Hook

hook: the Hook to unref

-> m ()

Decrements the reference count of a Hook. If the reference count falls to 0, the Hook is removed from the HookList and hookFree is called to free it.

Properties

data

clearHookData :: MonadIO m => Hook -> m ()

getHookData :: MonadIO m => Hook -> m (Ptr ())

setHookData :: MonadIO m => Hook -> Ptr () -> m ()

destroy

clearHookDestroy :: MonadIO m => Hook -> m ()

getHookDestroy :: MonadIO m => Hook -> m (Maybe DestroyNotify)

setHookDestroy :: MonadIO m => Hook -> FunPtr C_DestroyNotify -> m ()

flags

getHookFlags :: MonadIO m => Hook -> m Word32

setHookFlags :: MonadIO m => Hook -> Word32 -> m ()

func

clearHookFunc :: MonadIO m => Hook -> m ()

getHookFunc :: MonadIO m => Hook -> m (Ptr ())

setHookFunc :: MonadIO m => Hook -> Ptr () -> m ()

hookId

getHookHookId :: MonadIO m => Hook -> m CULong

setHookHookId :: MonadIO m => Hook -> CULong -> m ()

next

clearHookNext :: MonadIO m => Hook -> m ()

getHookNext :: MonadIO m => Hook -> m (Maybe Hook)

setHookNext :: MonadIO m => Hook -> Ptr Hook -> m ()

prev

clearHookPrev :: MonadIO m => Hook -> m ()

getHookPrev :: MonadIO m => Hook -> m (Maybe Hook)

setHookPrev :: MonadIO m => Hook -> Ptr Hook -> m ()

refCount

getHookRefCount :: MonadIO m => Hook -> m Word32

setHookRefCount :: MonadIO m => Hook -> Word32 -> m ()