Hbro.Event

Types

class Show e => Event e where

An event type is defined by its input type.

Associated Types

type Input e :: *

Methods

describeInput :: e -> Input e -> Maybe Text

Instances

Event LogMessage

Event KeyMapPressed

Event KeyPressed

Event ZoomLevelChanged

Event URIChanged

Event TitleChanged

Event ResourceOpened

Event ProgressChanged

Event NewWindow

Event LoadStarted

Event LoadRequested

Event LoadFinished

Event LoadFailed

Event LoadCommitted

Event LinkUnhovered

Event LinkHovered

Event LinkClicked

Event Download

Event Scrolled

data Event e => Signal e

A signal notifies the occurrence of an event.

Instances

Event e => Describable (Signal e)

type Handler m a = Input a -> m ()

Event handler.

Signal manipulation

newSignal :: (BaseIO m, Event e) => e -> m (Signal e)

Signal exports no constructor, use this function instead.

emit :: (Event e, MonadIO m, MonadLogger m) => Signal e -> Input e -> m ()

Trigger an event.

emit' :: (Event e, MonadIO m) => Signal e -> Input e -> m ()

Like emit, but doesn't log anything.

closeSignal :: (Event e, MonadIO m, MonadLogger m, MonadResource m) => Signal e -> m ()

Close a signal and all its attached hooks.

closeSignal' :: (Event e, MonadIO m, MonadResource m) => Signal e -> m ()

Like close, but doesn't log anything.

listenTo :: (Event a, MonadIO m) => Signal a -> m (Async (Maybe (Input a)))

Asynchronously wait for the next event.

Handlers

addHandler :: (Event a, ControlIO m, MonadResource m) => Signal a -> Handler m a -> m ReleaseKey

Execute a function each time an event occurs.

addRecursiveHandler :: (Event a, ControlIO m, MonadResource m) => Signal a -> b -> (b -> Input a -> m b) -> m ReleaseKey

Generalized version of addHandler where the callback function may recurse.

deleteHandlers :: (Event e, MonadIO m, MonadResource m) => Signal e -> m ()

Stop all handlers associated to the given signal.