KMonad.App.BEnv

When running KMonad, we need to keep track the last switchstate of a Button, because we only allowing switching, (we have to filter out repeated Press or Release events). Additionally, we keep track of what Keycode a button is bound to, to provide the myBinding functionality from MonadK.

Documentation

data BEnv

The configuration of a Button with some additional state to keep track of the last Switch

Constructors

BEnv

Fields

• _beButton :: !Button

  The configuration for this button

• _binding :: !Keycode

  The Keycode to which this button is bound

• _lastSwitch :: !(MVar Switch)

  State to keep track of last manipulation

Instances

HasButton BEnv

Defined in KMonad.App.BEnv

Methods

button :: Lens' BEnv Button

pressAction :: Lens' BEnv Action

releaseAction :: Lens' BEnv Action

HasBEnv BEnv

Defined in KMonad.App.BEnv

Methods

bEnv :: Lens' BEnv BEnv

beButton :: Lens' BEnv Button

binding :: Lens' BEnv Keycode

lastSwitch :: Lens' BEnv (MVar Switch)

class HasBEnv c where

Minimal complete definition

bEnv

Methods

bEnv :: Lens' c BEnv

beButton :: Lens' c Button

binding :: Lens' c Keycode

lastSwitch :: Lens' c (MVar Switch)

Instances

HasBEnv BEnv

Defined in KMonad.App.BEnv

Methods

bEnv :: Lens' BEnv BEnv

beButton :: Lens' BEnv Button

binding :: Lens' BEnv Keycode

lastSwitch :: Lens' BEnv (MVar Switch)

initBEnv :: MonadIO m => Button -> Keycode -> m BEnv

Initialize a BEnv, note that a key is always initialized in an unpressed state.

runBEnv :: MonadUnliftIO m => BEnv -> Switch -> m (Maybe Action)

Try to switch a BEnv. This only does something if the Switch is different from the lastSwitch field. I.e. pressing a pressed button or releasing a released button does nothing.