src/Graphics/Vty/Input/Events.hs · vty

on 00a6a4f help sign in

42 lines 1.7 kB history raw

1module Graphics.Vty.Input.Events where

3-- | Representations of non-modifier keys.

4--

5-- * KFun is indexed from 0 to 63. Range of supported FKeys varies by terminal and keyboard.

6--

7-- * KUpLeft, KUpRight, KDownLeft, KDownRight, KCenter support varies by terminal and keyboard.

8--

9-- * Actually, support for most of these but KEsc, KChar, KBS, and KEnter vary by terminal and

10-- keyboard.

11data Key = KEsc | KChar Char | KBS | KEnter

12 | KLeft | KRight | KUp | KDown

16 deriving (Eq,Show,Ord)

18-- | Modifier keys. Key codes are interpreted such that users are more likely to

19-- have Meta than Alt; for instance on the PC Linux console, 'MMeta' will

20-- generally correspond to the physical Alt key.

21data Modifier = MShift | MCtrl | MMeta | MAlt

22 deriving (Eq,Show,Ord)

24-- | Mouse buttons.

26-- \todo not supported.

27data Button = BLeft | BMiddle | BRight

28 deriving (Eq,Show,Ord)

30-- | Events.

31data Event

32 = EvKey Key [Modifier]

33 -- | \todo mouse events are not supported

34 | EvMouse Int Int Button [Modifier]

35 -- | if read from 'event_channel' this is the size at the time of the signal. If read from

36 -- 'next_event' this is the size at the time the event was processed by Vty. Typically these are

37 -- the same, but if somebody is resizing the terminal quickly they can be different.

38 | EvResize Int Int

39 deriving (Eq,Show,Ord)

41-- | representation of mapping from input bytes to event

42type ClassifyTable = [(String, Event)]