GLib.HookList¶

record (struct)

The HookList struct represents a list of hook functions.

Methods¶

def clear(self) -> None

Removes all the Hook elements from a HookList.

def init(self, hook_size: int) -> None

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

Parameters:

hook_size — the size of each element in the HookList, typically sizeof (GHook).

def invoke(self, may_recurse: bool) -> None

Calls all of the Hook functions in a HookList.

Parameters:

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

def invoke_check(self, may_recurse: bool) -> None

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

Parameters:

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

def marshal(self, may_recurse: bool, marshaller: HookMarshaller) -> None

Calls a function on each valid Hook.

Parameters:

may_recurse — True if hooks which are currently running (e.g. in another thread) are considered valid. If set to False, these are skipped
marshaller — the function to call for each Hook

def marshal_check(self, may_recurse: bool, marshaller: HookCheckMarshaller) -> None

Calls a function on each valid Hook and destroys it if the function returns False.

Parameters:

may_recurse — True if hooks which are currently running (e.g. in another thread) are considered valid. If set to False, these are skipped
marshaller — the function to call for each Hook

seq_id: int  # read/write

hook_size: int  # read/write

is_setup: int  # read/write

hooks: Hook  # read/write

dummy3: int  # read/write

finalize_hook: HookFinalizeFunc  # read/write

dummy: list[int]  # read/write