vty-5.25.1: A simple terminal UI library

Safe Haskell | Safe
Language | Haskell2010

Graphics.Vty.Input.Events

Synopsis

- data Key
  - = KEsc
  - | KChar Char
  - | KBS
  - | KEnter
  - | KLeft
  - | KRight
  - | KUp
  - | KDown
  - | KUpLeft
  - | KUpRight
  - | KDownLeft
  - | KDownRight
  - | KCenter
  - | KFun Int
  - | KBackTab
  - | KPrtScr
  - | KPause
  - | KIns
  - | KHome
  - | KPageUp
  - | KDel
  - | KEnd
  - | KPageDown
  - | KBegin
  - | KMenu
- data Modifier
  - = MShift
  - | MCtrl
  - | MMeta
  - | MAlt
- data Button
  - = BLeft
  - | BMiddle
  - | BRight
  - | BScrollUp
  - | BScrollDown
- data Event
  - = EvKey Key [Modifier]
  - | EvMouseDown Int Int Button [Modifier]
  - | EvMouseUp Int Int (Maybe Button)
  - | EvResize Int Int
  - | EvPaste ByteString
  - | EvLostFocus
  - | EvGainedFocus
- type ClassifyMap = [(String, Event)]

# Documentation

data Key Source #

Representations of non-modifier keys.

- KFun is indexed from 0 to 63. Range of supported FKeys varies by terminal and keyboard.
- KUpLeft, KUpRight, KDownLeft, KDownRight, KCenter support varies by terminal and keyboard.
- Actually, support for most of these but KEsc, KChar, KBS, and KEnter vary by terminal and keyboard.

Constructors

KEsc |
KChar Char |
KBS |
KEnter |
KLeft |
KRight |
KUp |
KDown |
KUpLeft |
KUpRight |
KDownLeft |
KDownRight |
KCenter |
KFun Int |
KBackTab |
KPrtScr |
KPause |
KIns |
KHome |
KPageUp |
KDel |
KEnd |
KPageDown |
KBegin |
KMenu |

Instances

Eq Key Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods (==) :: Key -> Key -> Bool Source # (/=) :: Key -> Key -> Bool Source #
Ord Key Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods compare :: Key -> Key -> Ordering Source # (<) :: Key -> Key -> Bool Source # (<=) :: Key -> Key -> Bool Source # (>) :: Key -> Key -> Bool Source # (>=) :: Key -> Key -> Bool Source # max :: Key -> Key -> Key Source # min :: Key -> Key -> Key Source #
Read Key Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods readsPrec :: Int -> ReadS Key Source # readList :: ReadS [Key] Source # readPrec :: ReadPrec Key Source # readListPrec :: ReadPrec [Key] Source #
Show Key Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods showsPrec :: Int -> Key -> ShowS Source # show :: Key -> String Source # showList :: [Key] -> ShowS Source #
Generic Key Source # |
Instance details Defined in Graphics.Vty.Input.Events Associated Types type Rep Key :: Type -> Type Source # Methods from :: Key -> Rep Key x Source # to :: Rep Key x -> Key Source #
type Rep Key Source # |

Instance details

Defined in Graphics.Vty.Input.Events

type Rep Key = D1 (MetaData "Key" "Graphics.Vty.Input.Events" "vty-5.25.1-7oKAOTf5ibHBKcogdwktuc" False) ((((C1 (MetaCons "KEsc" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KChar" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Char)) :+: C1 (MetaCons "KBS" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "KEnter" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KLeft" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KRight" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "KUp" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KDown" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KUpLeft" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "KUpRight" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KDownLeft" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KDownRight" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "KCenter" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KFun" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "KBackTab" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "KPrtScr" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KPause" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KIns" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "KHome" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "KPageUp" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KDel" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "KEnd" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KPageDown" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "KBegin" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KMenu" PrefixI False) (U1 :: Type -> Type))))))

data Modifier Source #

Modifier keys. Key codes are interpreted such that users are more likely to have Meta than Alt; for instance on the PC Linux console, `MMeta` will generally correspond to the physical Alt key.

Constructors

MShift |
MCtrl |
MMeta |
MAlt |

Instances

Eq Modifier Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods (==) :: Modifier -> Modifier -> Bool Source # (/=) :: Modifier -> Modifier -> Bool Source #
Ord Modifier Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods compare :: Modifier -> Modifier -> Ordering Source # (<) :: Modifier -> Modifier -> Bool Source # (<=) :: Modifier -> Modifier -> Bool Source # (>) :: Modifier -> Modifier -> Bool Source # (>=) :: Modifier -> Modifier -> Bool Source # max :: Modifier -> Modifier -> Modifier Source # min :: Modifier -> Modifier -> Modifier Source #
Read Modifier Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods readsPrec :: Int -> ReadS Modifier Source # readList :: ReadS [Modifier] Source # readPrec :: ReadPrec Modifier Source # readListPrec :: ReadPrec [Modifier] Source #
Show Modifier Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods showsPrec :: Int -> Modifier -> ShowS Source # show :: Modifier -> String Source # showList :: [Modifier] -> ShowS Source #
Generic Modifier Source # |
Instance details Defined in Graphics.Vty.Input.Events Associated Types type Rep Modifier :: Type -> Type Source # Methods from :: Modifier -> Rep Modifier x Source # to :: Rep Modifier x -> Modifier Source #
type Rep Modifier Source # |

Instance details

Defined in Graphics.Vty.Input.Events

type Rep Modifier = D1 (MetaData "Modifier" "Graphics.Vty.Input.Events" "vty-5.25.1-7oKAOTf5ibHBKcogdwktuc" False) ((C1 (MetaCons "MShift" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "MCtrl" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "MMeta" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "MAlt" PrefixI False) (U1 :: Type -> Type)))

data Button Source #

Mouse buttons.

Constructors

BLeft |
BMiddle |
BRight |
BScrollUp |
BScrollDown |

Instances

Eq Button Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods (==) :: Button -> Button -> Bool Source # (/=) :: Button -> Button -> Bool Source #
Ord Button Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods compare :: Button -> Button -> Ordering Source # (<) :: Button -> Button -> Bool Source # (<=) :: Button -> Button -> Bool Source # (>) :: Button -> Button -> Bool Source # (>=) :: Button -> Button -> Bool Source # max :: Button -> Button -> Button Source # min :: Button -> Button -> Button Source #
Read Button Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods readsPrec :: Int -> ReadS Button Source # readList :: ReadS [Button] Source # readPrec :: ReadPrec Button Source # readListPrec :: ReadPrec [Button] Source #
Show Button Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods showsPrec :: Int -> Button -> ShowS Source # show :: Button -> String Source # showList :: [Button] -> ShowS Source #
Generic Button Source # |
Instance details Defined in Graphics.Vty.Input.Events Associated Types type Rep Button :: Type -> Type Source # Methods from :: Button -> Rep Button x Source # to :: Rep Button x -> Button Source #
type Rep Button Source # |

Instance details

Defined in Graphics.Vty.Input.Events

type Rep Button = D1 (MetaData "Button" "Graphics.Vty.Input.Events" "vty-5.25.1-7oKAOTf5ibHBKcogdwktuc" False) ((C1 (MetaCons "BLeft" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "BMiddle" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "BRight" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "BScrollUp" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "BScrollDown" PrefixI False) (U1 :: Type -> Type))))

data Event Source #

Events.

Constructors

EvKey Key [Modifier] | A keyboard key was pressed with the specified modifiers.
EvMouseDown Int Int Button [Modifier] | A mouse button was pressed at the specified column and row. Any modifiers available in the event are also provided.
EvMouseUp Int Int (Maybe Button) | A mouse button was released at the specified column and row. Some terminals report only that a button was released without specifying which one; in that case, Nothing is provided. Otherwise Just the button released is included in the event.
EvResize Int Int | If read from `eventChannel` this is the size at the time of the signal. If read from `nextEvent` this is the size at the time the event was processed by Vty. Typically these are the same, but if somebody is resizing the terminal quickly they can be different.

EvPaste ByteString

A paste event occurs when a bracketed paste input sequence is received. For terminals that support bracketed paste mode, these events will be triggered on a paste event. Terminals that do not support bracketed pastes will send the paste contents as ordinary input (which is probably bad, so beware!) Note that the data is provided in raw form and you'll have to decode (e.g. as UTF-8) if that's what your application expects.

EvLostFocus | The terminal running the application lost input focus.
EvGainedFocus | The terminal running the application gained input focus.

Instances

Eq Event Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods (==) :: Event -> Event -> Bool Source # (/=) :: Event -> Event -> Bool Source #
Ord Event Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods compare :: Event -> Event -> Ordering Source # (<) :: Event -> Event -> Bool Source # (<=) :: Event -> Event -> Bool Source # (>) :: Event -> Event -> Bool Source # (>=) :: Event -> Event -> Bool Source # max :: Event -> Event -> Event Source # min :: Event -> Event -> Event Source #
Read Event Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods readsPrec :: Int -> ReadS Event Source # readList :: ReadS [Event] Source # readPrec :: ReadPrec Event Source # readListPrec :: ReadPrec [Event] Source #
Show Event Source # |
Instance details Defined in Graphics.Vty.Input.Events Methods showsPrec :: Int -> Event -> ShowS Source # show :: Event -> String Source # showList :: [Event] -> ShowS Source #
Generic Event Source # |
Instance details Defined in Graphics.Vty.Input.Events Associated Types type Rep Event :: Type -> Type Source # Methods from :: Event -> Rep Event x Source # to :: Rep Event x -> Event Source #
type Rep Event Source # |

Instance details

Defined in Graphics.Vty.Input.Events

type Rep Event = D1 (MetaData "Event" "Graphics.Vty.Input.Events" "vty-5.25.1-7oKAOTf5ibHBKcogdwktuc" False) ((C1 (MetaCons "EvKey" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Modifier])) :+: (C1 (MetaCons "EvMouseDown" PrefixI False) ((S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Button) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Modifier]))) :+: C1 (MetaCons "EvMouseUp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Button)))))) :+: ((C1 (MetaCons "EvResize" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "EvPaste" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))) :+: (C1 (MetaCons "EvLostFocus" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "EvGainedFocus" PrefixI False) (U1 :: Type -> Type))))

type ClassifyMap = [(String, Event)] Source #