License	MIT
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	GHC2021

BearLibTerminal.Keycodes

Description

All events and keycodes that can be received by polling or queried for in the window state.

Synopsis

newtype Keycode = Keycode Int
pattern TkA :: Keycode
pattern TkB :: Keycode
pattern TkC :: Keycode
pattern TkD :: Keycode
pattern TkE :: Keycode
pattern TkF :: Keycode
pattern TkG :: Keycode
pattern TkH :: Keycode
pattern TkI :: Keycode
pattern TkJ :: Keycode
pattern TkK :: Keycode
pattern TkL :: Keycode
pattern TkM :: Keycode
pattern TkN :: Keycode
pattern TkO :: Keycode
pattern TkP :: Keycode
pattern TkQ :: Keycode
pattern TkR :: Keycode
pattern TkS :: Keycode
pattern TkT :: Keycode
pattern TkU :: Keycode
pattern TkV :: Keycode
pattern TkW :: Keycode
pattern TkX :: Keycode
pattern TkY :: Keycode
pattern TkZ :: Keycode
pattern Tk1 :: Keycode
pattern Tk2 :: Keycode
pattern Tk3 :: Keycode
pattern Tk4 :: Keycode
pattern Tk5 :: Keycode
pattern Tk6 :: Keycode
pattern Tk7 :: Keycode
pattern Tk8 :: Keycode
pattern Tk9 :: Keycode
pattern Tk0 :: Keycode
pattern TkReturn :: Keycode
pattern TkEnter :: Keycode
pattern TkEscape :: Keycode
pattern TkBackspace :: Keycode
pattern TkTab :: Keycode
pattern TkSpace :: Keycode
pattern TkMinus :: Keycode
pattern TkEquals :: Keycode
pattern TkLbracket :: Keycode
pattern TkRbracket :: Keycode
pattern TkBackslash :: Keycode
pattern TkSemicolon :: Keycode
pattern TkApostrophe :: Keycode
pattern TkGrave :: Keycode
pattern TkComma :: Keycode
pattern TkPeriod :: Keycode
pattern TkSlash :: Keycode
pattern TkF1 :: Keycode
pattern TkF2 :: Keycode
pattern TkF3 :: Keycode
pattern TkF4 :: Keycode
pattern TkF5 :: Keycode
pattern TkF6 :: Keycode
pattern TkF7 :: Keycode
pattern TkF8 :: Keycode
pattern TkF9 :: Keycode
pattern TkF10 :: Keycode
pattern TkF11 :: Keycode
pattern TkF12 :: Keycode
pattern TkPause :: Keycode
pattern TkInsert :: Keycode
pattern TkHome :: Keycode
pattern TkPageup :: Keycode
pattern TkDelete :: Keycode
pattern TkEnd :: Keycode
pattern TkPagedown :: Keycode
pattern TkRight :: Keycode
pattern TkLeft :: Keycode
pattern TkDown :: Keycode
pattern TkUp :: Keycode
pattern TkKpDivide :: Keycode
pattern TkKpMultiply :: Keycode
pattern TkKpMinus :: Keycode
pattern TkKpPlus :: Keycode
pattern TkKpEnter :: Keycode
pattern TkKp1 :: Keycode
pattern TkKp2 :: Keycode
pattern TkKp3 :: Keycode
pattern TkKp4 :: Keycode
pattern TkKp5 :: Keycode
pattern TkKp6 :: Keycode
pattern TkKp7 :: Keycode
pattern TkKp8 :: Keycode
pattern TkKp9 :: Keycode
pattern TkKp0 :: Keycode
pattern TkKpPeriod :: Keycode
pattern TkShift :: Keycode
pattern TkControl :: Keycode
pattern TkAlt :: Keycode
pattern TkMouseLeft :: Keycode
pattern TkMouseRight :: Keycode
pattern TkMouseMiddle :: Keycode
pattern TkMouseX1 :: Keycode
pattern TkMouseX2 :: Keycode
pattern TkMouseMove :: Keycode
pattern TkMouseScroll :: Keycode
pattern TkMouseX :: Keycode
pattern TkMouseY :: Keycode
pattern TkMousePixelX :: Keycode
pattern TkMousePixelY :: Keycode
pattern TkMouseWheel :: Keycode
pattern TkMouseClicks :: Keycode
pattern TkKeyReleased :: Keycode
pattern TkWidth :: Keycode
pattern TkHeight :: Keycode
pattern TkCellWidth :: Keycode
pattern TkCellHeight :: Keycode
pattern TkColor :: Keycode
pattern TkBkcolor :: Keycode
pattern TkLayer :: Keycode
pattern TkComposition :: Keycode
pattern TkChar :: Keycode
pattern TkWchar :: Keycode
pattern TkEvent :: Keycode
pattern TkFullscreen :: Keycode
pattern TkClose :: Keycode
pattern TkResized :: Keycode

Documentation

newtype Keycode Source #

Events and states are defined in the original library as integer constants, which are all called keycodes. This is a very liberal use of a "virtual keycode", because many of them are not keys. These are defined as bidirectional pattern synonyms so that they still can be treated as bitwise operable (e.g. checking for key release events). These are used for: - terminalRead - polling for events (key presses, key releases, window events, mouse movements) - terminalState and terminalKeyState - for querying current window state (e.g. mouse position) and the status of whether keys are currently pressed respectively. For full reference of the input queue, see http://foo.wyrd.name/en:bearlibterminal:reference:input.

Constructors

Keycode Int

Instances

Instances details

Bounded Keycode Source #

Instance details

Defined in BearLibTerminal.Keycodes

Methods

minBound :: Keycode #

maxBound :: Keycode #

Enum Keycode Source #

Instance details

Defined in BearLibTerminal.Keycodes

Methods

succ :: Keycode -> Keycode #

pred :: Keycode -> Keycode #

toEnum :: Int -> Keycode #

fromEnum :: Keycode -> Int #

enumFrom :: Keycode -> [Keycode] #

enumFromThen :: Keycode -> Keycode -> [Keycode] #

enumFromTo :: Keycode -> Keycode -> [Keycode] #

enumFromThenTo :: Keycode -> Keycode -> Keycode -> [Keycode] #

Generic Keycode Source #

Instance details

Defined in BearLibTerminal.Keycodes

Associated Types

type Rep Keycode
Instance details Defined in BearLibTerminal.Keycodes type Rep Keycode = D1 ('MetaData "Keycode" "BearLibTerminal.Keycodes" "bearlibterminal-0.1.0.1-inplace" 'True) (C1 ('MetaCons "Keycode" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))