Copyright	(c) David Janssen 2019
License	MIT
Maintainer	janssen.dhj@gmail.com
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

KMonad.Keyboard

Contents

KeyEvents and their helpers
Predicates
LMaps
Reexports

Description

This module contains or reexports all the basic, non-IO concepts related to dealing with key codes, events, and mappings. For keyboard-related IO see KMonad.Keyboard.IO.

Synopsis

data Switch
- = Press
- | Release
data KeyEvent
switch :: Lens' KeyEvent Switch
keycode :: Lens' KeyEvent Keycode
mkKeyEvent :: Switch -> Keycode -> KeyEvent
mkPress :: Keycode -> KeyEvent
mkRelease :: Keycode -> KeyEvent
type KeyPred = KeyEvent -> Bool
isPress :: KeyPred
isRelease :: KeyPred
isKeycode :: Keycode -> KeyPred
isPressOf :: Keycode -> KeyPred
isReleaseOf :: Keycode -> KeyPred
type LayerTag = Text
type LMap a = LayerStack LayerTag Keycode a
module KMonad.Keyboard.Keycode

KeyEvents and their helpers

An KeyEvent in KMonad is either the Press or Release of a particular Keycode. A complete list of keycodes can be found in KMonad.Keyboard.Keycode.

data Switch Source #

KMonad recognizes 2 different types of actions: presses and releases. Note that we do not handle repeat events at all.

Constructors

Press
Release

Instances

Enum Switch Source #
Instance details Defined in KMonad.Keyboard Methods succ :: Switch -> Switch # pred :: Switch -> Switch # toEnum :: Int -> Switch # fromEnum :: Switch -> Int # enumFrom :: Switch -> [Switch] # enumFromThen :: Switch -> Switch -> [Switch] # enumFromTo :: Switch -> Switch -> [Switch] # enumFromThenTo :: Switch -> Switch -> Switch -> [Switch] #
Eq Switch Source #
Instance details Defined in KMonad.Keyboard Methods (==) :: Switch -> Switch -> Bool # (/=) :: Switch -> Switch -> Bool #
Ord Switch Source #
Instance details Defined in KMonad.Keyboard Methods compare :: Switch -> Switch -> Ordering # (<) :: Switch -> Switch -> Bool # (<=) :: Switch -> Switch -> Bool # (>) :: Switch -> Switch -> Bool # (>=) :: Switch -> Switch -> Bool # max :: Switch -> Switch -> Switch # min :: Switch -> Switch -> Switch #
Show Switch Source #
Instance details Defined in KMonad.Keyboard Methods showsPrec :: Int -> Switch -> ShowS # show :: Switch -> String # showList :: [Switch] -> ShowS #
Generic Switch Source #
Instance details Defined in KMonad.Keyboard Associated Types type Rep Switch :: Type -> Type # Methods from :: Switch -> Rep Switch x # to :: Rep Switch x -> Switch #
Hashable Switch Source #
Instance details Defined in KMonad.Keyboard Methods hashWithSalt :: Int -> Switch -> Int # hash :: Switch -> Int #
type Rep Switch Source #
Instance details Defined in KMonad.Keyboard type Rep Switch = D1 (MetaData "Switch" "KMonad.Keyboard" "kmonad-0.4.1-FPseCbFTtIEC38tuwaAvvU" False) (C1 (MetaCons "Press" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Release" PrefixI False) (U1 :: Type -> Type))

data KeyEvent Source #

An KeyEvent is a Switch on a particular Keycode

Instances

Eq KeyEvent Source #
Instance details Defined in KMonad.Keyboard Methods (==) :: KeyEvent -> KeyEvent -> Bool # (/=) :: KeyEvent -> KeyEvent -> Bool #
Ord KeyEvent Source #	An `Ord` instance, where Press > Release, and otherwise we `Ord` on the `Keycode`
Instance details Defined in KMonad.Keyboard Methods compare :: KeyEvent -> KeyEvent -> Ordering # (<) :: KeyEvent -> KeyEvent -> Bool # (<=) :: KeyEvent -> KeyEvent -> Bool # (>) :: KeyEvent -> KeyEvent -> Bool # (>=) :: KeyEvent -> KeyEvent -> Bool # max :: KeyEvent -> KeyEvent -> KeyEvent # min :: KeyEvent -> KeyEvent -> KeyEvent #
Show KeyEvent Source #
Instance details Defined in KMonad.Keyboard Methods showsPrec :: Int -> KeyEvent -> ShowS # show :: KeyEvent -> String # showList :: [KeyEvent] -> ShowS #
Generic KeyEvent Source #
Instance details Defined in KMonad.Keyboard Associated Types type Rep KeyEvent :: Type -> Type # Methods from :: KeyEvent -> Rep KeyEvent x # to :: Rep KeyEvent x -> KeyEvent #
Hashable KeyEvent Source #
Instance details Defined in KMonad.Keyboard Methods hashWithSalt :: Int -> KeyEvent -> Int # hash :: KeyEvent -> Int #
Display KeyEvent Source #	A `Display` instance for `KeyEvent`s that prints them out nicely.
Instance details Defined in KMonad.Keyboard Methods display :: KeyEvent -> Utf8Builder # textDisplay :: KeyEvent -> Text #
type Rep KeyEvent Source #
Instance details Defined in KMonad.Keyboard type Rep KeyEvent = D1 (MetaData "KeyEvent" "KMonad.Keyboard" "kmonad-0.4.1-FPseCbFTtIEC38tuwaAvvU" False) (C1 (MetaCons "KeyEvent" PrefixI True) (S1 (MetaSel (Just "_switch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Switch) :*: S1 (MetaSel (Just "_keycode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Keycode)))