gi-glib-2.0.11: GLib bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.HookList

Contents

Description

The HookList struct represents a list of hook functions.

Synopsis

Exported types

newtype HookList Source #

Constructors

HookList (ManagedPtr HookList) 

Instances

WrappedPtr HookList Source # 
(~) AttrOpTag tag AttrSet => Constructible HookList tag Source # 

Methods

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

((~) * info (ResolveHookListMethod t HookList), MethodInfo * info HookList p) => IsLabel t (HookList -> p) Source # 

Methods

fromLabel :: Proxy# Symbol t -> HookList -> p #

((~) * info (ResolveHookListMethod t HookList), MethodInfo * info HookList p) => IsLabelProxy t (HookList -> p) Source # 

Methods

fromLabelProxy :: Proxy Symbol t -> HookList -> p #

HasAttributeList * HookList Source # 
((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * HookListInvokeCheckMethodInfo HookList signature Source # 
((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * HookListInvokeMethodInfo HookList signature Source # 
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * HookListInitMethodInfo HookList signature Source # 
((~) * signature (m ()), MonadIO m) => MethodInfo * HookListClearMethodInfo HookList signature Source # 
type AttributeList HookList Source # 

newZeroHookList :: MonadIO m => m HookList Source #

Construct a HookList struct initialized to zero.

Methods

clear

hookListClear Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> HookList

hookList: a HookList

-> m () 

Removes all the Hook elements from a HookList.

init

data HookListInitMethodInfo Source #

Instances

((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * HookListInitMethodInfo HookList signature Source # 

hookListInit Source #

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 Source #

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 Source #

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

finalizeHook

hookSize

hooks

isSetup

seqId