HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulevty-6.5Haskell2010

Graphics.Vty.Input.Events

  • 6 types
  • Packagevty-6.5
  • Exports6
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceEvents.hs
datadata Key
#

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

Instances8Eq, Ord, Read, Show, Generic, NFData, …
datadata Modifier
#

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.

MShiftMCtrlMMetaMAlt
Instances8Eq, Ord, Read, Show, Generic, NFData, …
datadata Event
#

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
  • 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.

Instances7Eq, Ord, Read, Show, Generic, NFData, …
datadata Button
#

Mouse buttons.

BLeftBMiddleBRightBScrollUpBScrollDown
Instances7Eq, Ord, Read, Show, Generic, NFData, …
datadata InternalEvent
#

The type of internal events that drive the internal Vty event dispatching to the application.

Constructors

  • ResumeAfterInterrupt

    Vty resumed operation after the process was interrupted (e.g. with a signal). In practice this translates into a screen redraw in the input event loop.

  • InputEvent Event

    An input event was received.