| terminfo-0.3.1: Haskell bindings to the terminfo library. | Source code | Contents | Index

System.Console.Terminfo.Keys

Portability | portable (FFI)
Stability | experimental
Maintainer | judah.jacobson@gmail.com

Contents

The keypad
Arrow keys
Miscellaneous

Description
The string capabilities in this module are the character sequences corresponding to user input such as arrow keys and function keys.
Synopsis

keypadOn :: Capability TermOutput
keypadOff :: Capability TermOutput
keyUp :: Capability String
keyDown :: Capability String
keyLeft :: Capability String
keyRight :: Capability String
functionKey :: Int -> Capability String
keyBackspace :: Capability String
keyDeleteChar :: Capability String
keyHome :: Capability String
keyEnd :: Capability String

The keypad
The following commands turn the keypad on/off (`smkx` and `rmkx`). They have no effect if those capabilities are not defined. For portability between terminals, the keypad should be explicitly turned on before accepting user key input.

keypadOn :: Capability TermOutput | Source

keypadOff :: Capability TermOutput | Source

Arrow keys

keyUp :: Capability String | Source

keyDown :: Capability String | Source

keyLeft :: Capability String | Source

keyRight :: Capability String | Source

Miscellaneous

functionKey :: Int -> Capability String | Source

Look up the control sequence for a given function sequence. For example, `functionKey 12` retrieves the `kf12` capability.

keyBackspace :: Capability String | Source

keyDeleteChar :: Capability String | Source

keyHome :: Capability String | Source

keyEnd :: Capability String | Source

Produced by Haddock version 2.4.2