Game.LambdaHack.Client.UI.Key

Frontend-independent keyboard input operations.

Documentation

data Key

Frontend-independent datatype to represent keys.

Constructors

Esc

Return

Space

Tab

BackTab

BackSpace

PgUp

PgDn

Left

Right

Up

Down

End

Begin

Insert

Delete

Home

KP !Char

a keypad key for a character (digits and operators)

Char !Char

a single printable character

Fun !Int

function key

LeftButtonPress

left mouse button pressed

MiddleButtonPress

middle mouse button pressed

RightButtonPress

right mouse button pressed

LeftButtonRelease

left mouse button released

MiddleButtonRelease

middle mouse button released

RightButtonRelease

right mouse button released

WheelNorth

mouse wheel rotated north

WheelSouth

mouse wheel rotated south

Unknown !String

an unknown key, registered to warn the user

DeadKey

Instances

Eq Key

Methods

(==) :: Key -> Key -> Bool

(/=) :: Key -> Key -> Bool

Ord Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Generic Key

Associated Types

type Rep Key :: * -> *

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Binary Key

Methods

put :: Key -> Put

get :: Get Key

putList :: [Key] -> Put

NFData Key

Methods

rnf :: Key -> ()

type Rep Key

type Rep Key = D1 (MetaData "Key" "Game.LambdaHack.Client.UI.Key" "LambdaHack-0.6.0.0-KKqNxYnoEMa5Wo2qfudFog" False) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Esc" PrefixI False) U1) ((:+:) (C1 (MetaCons "Return" PrefixI False) U1) (C1 (MetaCons "Space" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "Tab" PrefixI False) U1) (C1 (MetaCons "BackTab" PrefixI False) U1)) ((:+:) (C1 (MetaCons "BackSpace" PrefixI False) U1) (C1 (MetaCons "PgUp" PrefixI False) U1)))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "PgDn" PrefixI False) U1) (C1 (MetaCons "Left" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Right" PrefixI False) U1) (C1 (MetaCons "Up" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "Down" PrefixI False) U1) (C1 (MetaCons "End" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Begin" PrefixI False) U1) (C1 (MetaCons "Insert" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Delete" PrefixI False) U1) ((:+:) (C1 (MetaCons "Home" PrefixI False) U1) (C1 (MetaCons "KP" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Char))))) ((:+:) ((:+:) (C1 (MetaCons "Char" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Char))) (C1 (MetaCons "Fun" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))) ((:+:) (C1 (MetaCons "LeftButtonPress" PrefixI False) U1) (C1 (MetaCons "MiddleButtonPress" PrefixI False) U1)))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "RightButtonPress" PrefixI False) U1) (C1 (MetaCons "LeftButtonRelease" PrefixI False) U1)) ((:+:) (C1 (MetaCons "MiddleButtonRelease" PrefixI False) U1) (C1 (MetaCons "RightButtonRelease" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "WheelNorth" PrefixI False) U1) (C1 (MetaCons "WheelSouth" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Unknown" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String))) (C1 (MetaCons "DeadKey" PrefixI False) U1))))))

showKey :: Key -> String

handleDir :: Bool -> Bool -> KM -> Maybe Vector

Configurable event handler for the direction keys. Used for directed commands such as close door.

dirAllKey :: Bool -> Bool -> [Key]

moveBinding :: Bool -> Bool -> (Vector -> a) -> (Vector -> a) -> [(KM, a)]

Binding of both sets of movement keys.

mkKM :: String -> KM

mkChar :: Char -> KM

mkKP :: Char -> KM

keyTranslate :: String -> Key

Translate key from a GTK string description to our internal key type. To be used, in particular, for the command bindings and macros in the config file.

See https://github.com/twobob/gtk-/blob/master/gdk/keyname-table.h

keyTranslateWeb :: String -> Bool -> Key

Translate key from a Web API string description (https:/developer.mozilla.orgen-USdocsWebAPIKeyboardEvent/key#Key_values) to our internal key type. To be used in web frontends. The argument says whether Shift is pressed.

data Modifier

Our own encoding of modifiers.

Constructors

NoModifier

Shift

Control

Alt

Instances

Eq Modifier

Methods

(==) :: Modifier -> Modifier -> Bool

(/=) :: Modifier -> Modifier -> Bool

Ord Modifier

Methods

compare :: Modifier -> Modifier -> Ordering

(<) :: Modifier -> Modifier -> Bool

(<=) :: Modifier -> Modifier -> Bool

(>) :: Modifier -> Modifier -> Bool

(>=) :: Modifier -> Modifier -> Bool

max :: Modifier -> Modifier -> Modifier

min :: Modifier -> Modifier -> Modifier

Show Modifier

Methods

showsPrec :: Int -> Modifier -> ShowS

show :: Modifier -> String

showList :: [Modifier] -> ShowS

Generic Modifier

Associated Types

type Rep Modifier :: * -> *

Methods

from :: Modifier -> Rep Modifier x

to :: Rep Modifier x -> Modifier

Binary Modifier

Methods

put :: Modifier -> Put

get :: Get Modifier

putList :: [Modifier] -> Put

NFData Modifier

Methods

rnf :: Modifier -> ()

type Rep Modifier

type Rep Modifier = D1 (MetaData "Modifier" "Game.LambdaHack.Client.UI.Key" "LambdaHack-0.6.0.0-KKqNxYnoEMa5Wo2qfudFog" False) ((:+:) ((:+:) (C1 (MetaCons "NoModifier" PrefixI False) U1) (C1 (MetaCons "Shift" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Control" PrefixI False) U1) (C1 (MetaCons "Alt" PrefixI False) U1)))

data KM

Constructors

KM

Fields

• modifier :: !Modifier
• key :: !Key

Instances

Eq KM

Methods

(==) :: KM -> KM -> Bool

(/=) :: KM -> KM -> Bool

Ord KM

Methods

compare :: KM -> KM -> Ordering

(<) :: KM -> KM -> Bool

(<=) :: KM -> KM -> Bool

(>) :: KM -> KM -> Bool

(>=) :: KM -> KM -> Bool

max :: KM -> KM -> KM

min :: KM -> KM -> KM

Show KM

Methods

showsPrec :: Int -> KM -> ShowS

show :: KM -> String

showList :: [KM] -> ShowS

Generic KM

Associated Types

type Rep KM :: * -> *

Methods

from :: KM -> Rep KM x

to :: Rep KM x -> KM

Binary KM

Methods

put :: KM -> Put

get :: Get KM

putList :: [KM] -> Put

NFData KM

Methods

rnf :: KM -> ()

type Rep KM

type Rep KM = D1 (MetaData "KM" "Game.LambdaHack.Client.UI.Key" "LambdaHack-0.6.0.0-KKqNxYnoEMa5Wo2qfudFog" False) (C1 (MetaCons "KM" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "modifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Modifier)) (S1 (MetaSel (Just Symbol "key") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Key))))

showKM :: KM -> String

Show a key with a modifier, if any.

escKM :: KM

spaceKM :: KM

safeSpaceKM :: KM

returnKM :: KM

pgupKM :: KM

pgdnKM :: KM

wheelNorthKM :: KM

wheelSouthKM :: KM

upKM :: KM

downKM :: KM

leftKM :: KM

rightKM :: KM

homeKM :: KM

endKM :: KM

backspaceKM :: KM

leftButtonReleaseKM :: KM

rightButtonReleaseKM :: KM