GI.GLib.Structs.HookList

The HookList struct represents a list of hook functions.

Exported types

newtype HookList

Memory-managed wrapper type.

Constructors

HookList (ManagedPtr HookList)

Instances

Eq HookList

Defined in GI.GLib.Structs.HookList

Methods

(==) :: HookList -> HookList -> Bool

(/=) :: HookList -> HookList -> Bool

BoxedPtr HookList

Defined in GI.GLib.Structs.HookList

Methods

boxedPtrCopy :: HookList -> IO HookList

boxedPtrFree :: HookList -> IO ()

CallocPtr HookList

Defined in GI.GLib.Structs.HookList

Methods

boxedPtrCalloc :: IO (Ptr HookList)

ManagedPtrNewtype HookList

Defined in GI.GLib.Structs.HookList

Methods

toManagedPtr :: HookList -> ManagedPtr HookList

tag ~ 'AttrSet => Constructible HookList tag

Defined in GI.GLib.Structs.HookList

Methods

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

newZeroHookList :: MonadIO m => m HookList

Construct a HookList struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

clear, init, invoke, invokeCheck.

Getters

None.

Setters

None.

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

unused

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

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 ())

Get the value of the “dummy3” field. When overloading is enabled, this is equivalent to

get hookList #dummy3

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

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 ()

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)

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 ()

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

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 ()

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 ()

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)

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 ()

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

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 ()

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

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 ()

Set the value of the “seq_id” field. When overloading is enabled, this is equivalent to

set hookList [ #seqId := value ]