WildBind.FrontEnd

Data types and type classes about front-ends.

You have to look at this module if you want to create a front-end implementation.

Documentation

data FrontEvent s i

Event from the front-end. s is the state of the front-end. i is the input.

Constructors

FEInput i

An event that a new input is made.

FEChange s

An event that the front-end state is changed.

Instances

(Eq s, Eq i) => Eq (FrontEvent s i)

Methods

(==) :: FrontEvent s i -> FrontEvent s i -> Bool

(/=) :: FrontEvent s i -> FrontEvent s i -> Bool

(Ord s, Ord i) => Ord (FrontEvent s i)

Methods

compare :: FrontEvent s i -> FrontEvent s i -> Ordering

(<) :: FrontEvent s i -> FrontEvent s i -> Bool

(<=) :: FrontEvent s i -> FrontEvent s i -> Bool

(>) :: FrontEvent s i -> FrontEvent s i -> Bool

(>=) :: FrontEvent s i -> FrontEvent s i -> Bool

max :: FrontEvent s i -> FrontEvent s i -> FrontEvent s i

min :: FrontEvent s i -> FrontEvent s i -> FrontEvent s i

(Show s, Show i) => Show (FrontEvent s i)

Methods

showsPrec :: Int -> FrontEvent s i -> ShowS

show :: FrontEvent s i -> String

showList :: [FrontEvent s i] -> ShowS

data FrontEnd s i

Interface to the front-end. s is the state of the front-end, i is the input.

Constructors

FrontEnd

Fields

• frontDefaultDescription :: i -> ActionDescription

  Default ActionDescription for inputs

• frontSetGrab :: i -> IO ()

  Action to grab (or capture) the specified input symbol on the device.

• frontUnsetGrab :: i -> IO ()

  Action to release the grab for the input symbol.

• frontNextEvent :: IO (FrontEvent s i)

  Action to retrieve the next event. It should block if no event is queued.