Safe Haskell	Safe-Inferred
Language	Haskell2010

KMonad.Keyboard.Types

Synopsis

data Switch
- = Press
- | Release
data KeyEvent
mkKeyEvent :: Switch -> Keycode -> KeyEvent
class HasKeyEvent c where
- keyEvent :: Lens' c KeyEvent
- keycode :: Lens' c Keycode
- switch :: Lens' c Switch
type KeyPred = KeyEvent -> Bool
type LayerTag = Text
type LMap a = LayerStack LayerTag Keycode a

Documentation

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

Instances details

Enum Switch Source #
Instance details Defined in KMonad.Keyboard.Types 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] #
Generic Switch Source #
Instance details Defined in KMonad.Keyboard.Types Associated Types type Rep Switch :: Type -> Type # Methods from :: Switch -> Rep Switch x # to :: Rep Switch x -> Switch #
Show Switch Source #
Instance details Defined in KMonad.Keyboard.Types Methods showsPrec :: Int -> Switch -> ShowS # show :: Switch -> String # showList :: [Switch] -> ShowS #
Eq Switch Source #
Instance details Defined in KMonad.Keyboard.Types Methods (==) :: Switch -> Switch -> Bool # (/=) :: Switch -> Switch -> Bool #
Ord Switch Source #
Instance details Defined in KMonad.Keyboard.Types 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 #
Hashable Switch Source #
Instance details Defined in KMonad.Keyboard.Types Methods hashWithSalt :: Int -> Switch -> Int # hash :: Switch -> Int #
type Rep Switch Source #
Instance details Defined in KMonad.Keyboard.Types type Rep Switch = D1 ('MetaData "Switch" "KMonad.Keyboard.Types" "kmonad-0.4.2-inplace" '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

Instances details

Generic KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types Associated Types type Rep KeyEvent :: Type -> Type # Methods from :: KeyEvent -> Rep KeyEvent x # to :: Rep KeyEvent x -> KeyEvent #
Show KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types Methods showsPrec :: Int -> KeyEvent -> ShowS # show :: KeyEvent -> String # showList :: [KeyEvent] -> ShowS #
Eq KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types 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.Types 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 #
Hashable KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types Methods hashWithSalt :: Int -> KeyEvent -> Int # hash :: KeyEvent -> Int #
HasKeyEvent KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types Methods keyEvent :: Lens' KeyEvent KeyEvent Source # keycode :: Lens' KeyEvent Keycode Source # switch :: Lens' KeyEvent Switch Source #
Display KeyEvent Source #	A `Display` instance for `KeyEvent`s that prints them out nicely.
Instance details Defined in KMonad.Keyboard.Types Methods display :: KeyEvent -> Utf8Builder # textDisplay :: KeyEvent -> Text #
type Rep KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types type Rep KeyEvent = D1 ('MetaData "KeyEvent" "KMonad.Keyboard.Types" "kmonad-0.4.2-inplace" 'False) (C1 ('MetaCons "KeyEvent" 'PrefixI 'True) (S1 ('MetaSel ('Just "_switch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Switch) :*: S1 ('MetaSel ('Just "_keycode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Keycode)))

mkKeyEvent :: Switch -> Keycode -> KeyEvent Source #

Create a new KeyEvent from a Switch and a Keycode

class HasKeyEvent c where Source #

Minimal complete definition

keyEvent

Methods

keyEvent :: Lens' c KeyEvent Source #

keycode :: Lens' c Keycode Source #

switch :: Lens' c Switch Source #

Instances

Instances details

HasKeyEvent KeyEvent Source #
Instance details Defined in KMonad.Keyboard.Types Methods keyEvent :: Lens' KeyEvent KeyEvent Source # keycode :: Lens' KeyEvent Keycode Source # switch :: Lens' KeyEvent Switch Source #

type KeyPred = KeyEvent -> Bool Source #

Predicate on KeyEvent's

type LayerTag = Text Source #

Layers are identified by a tag that is simply a Text value.

type LMap a = LayerStack LayerTag Keycode a Source #

LMaps are mappings from LayerTagd maps from Keycode to things.