KMonad.App

Documentation

data AppCfg

Record of all the configuration options required to run KMonad's core App loop.

Constructors

AppCfg

Fields

• _keySinkDev :: Acquire KeySink

  How to open a KeySink

• _keySourceDev :: Acquire KeySource

  How to open a KeySource

• _keymapCfg :: LMap Button

  The map defining the Button layout

• _firstLayer :: LayerTag

  Active layer when KMonad starts

• _fallThrough :: Bool

  Whether uncaught events should be emitted or not

• _allowCmd :: Bool

  Whether shell-commands are allowed

Instances

HasAppCfg AppCfg

Defined in KMonad.App

Methods

appCfg :: Lens' AppCfg AppCfg

allowCmd :: Lens' AppCfg Bool

fallThrough :: Lens' AppCfg Bool

firstLayer :: Lens' AppCfg LayerTag

keySinkDev :: Lens' AppCfg (Acquire KeySink)

keySourceDev :: Lens' AppCfg (Acquire KeySource)

keymapCfg :: Lens' AppCfg (LMap Button)

class HasAppCfg c where

Minimal complete definition

appCfg

Methods

appCfg :: Lens' c AppCfg

allowCmd :: Lens' c Bool

fallThrough :: Lens' c Bool

firstLayer :: Lens' c LayerTag

keySinkDev :: Lens' c (Acquire KeySink)

keySourceDev :: Lens' c (Acquire KeySource)

keymapCfg :: Lens' c (LMap Button)

Instances

HasAppCfg AppCfg

Defined in KMonad.App

Methods

appCfg :: Lens' AppCfg AppCfg

allowCmd :: Lens' AppCfg Bool

fallThrough :: Lens' AppCfg Bool

firstLayer :: Lens' AppCfg LayerTag

keySinkDev :: Lens' AppCfg (Acquire KeySink)

keySourceDev :: Lens' AppCfg (Acquire KeySource)

keymapCfg :: Lens' AppCfg (LMap Button)

startApp :: HasLogFunc e => AppCfg -> RIO e ()

Run KMonad using the provided configuration

Orphan instances

(HasAppEnv e, HasAppCfg e, HasLogFunc e) => MonadKIO (RIO e)

Methods

emit :: KeyEvent -> RIO e ()

pause :: Milliseconds -> RIO e ()

hold :: Bool -> RIO e ()

register :: HookLocation -> Hook (RIO e) -> RIO e ()

layerOp :: LayerOp -> RIO e ()

inject :: KeyEvent -> RIO e ()

shellCmd :: Text -> RIO e ()