Client.EventLoop.Actions

Documentation

data Action

Actions that can be invoked using the keyboard.

Constructors

ActBackspace

ActDelete

ActLeft

ActRight

ActHome

ActEnd

ActOlderLine

ActNewerLine

ActScrollUp

ActScrollDown

ActBackWord

ActForwardWord

ActYank

ActKillHome

ActKillEnd

ActKillWordBack

ActKillWordForward

ActToggle

ActBold

ActColor

ActItalic

ActUnderline

ActReverseVideo

ActClearFormat

ActInsertEnter

ActDigraph

ActRetreatFocus

ActAdvanceFocus

ActAdvanceNetwork

ActJumpToActivity

ActJumpPrevious

ActJump Int

ActTabComplete

ActTabCompleteBack

ActEnter

ActReset

ActRefresh

ActCommand Text

ActInsert Char

ActIgnored

Instances

Eq Action

Defined in Client.EventLoop.Actions

Methods

(==) :: Action -> Action -> Bool

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

Ord Action

Defined in Client.EventLoop.Actions

Methods

compare :: Action -> Action -> Ordering

(<) :: Action -> Action -> Bool

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

(>) :: Action -> Action -> Bool

(>=) :: Action -> Action -> Bool

max :: Action -> Action -> Action

min :: Action -> Action -> Action

Read Action

Defined in Client.EventLoop.Actions

Methods

readsPrec :: Int -> ReadS Action

readList :: ReadS [Action]

readPrec :: ReadPrec Action

readListPrec :: ReadPrec [Action]

Show Action

Defined in Client.EventLoop.Actions

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

HasSpec Action

Defined in Client.EventLoop.Actions

Methods

anySpec :: ValueSpec Action

data KeyMap

Lookup table for keyboard events to actions. Use with keyToAction.

Instances

Show KeyMap

Defined in Client.EventLoop.Actions

Methods

showsPrec :: Int -> KeyMap -> ShowS

show :: KeyMap -> String

showList :: [KeyMap] -> ShowS

keyToAction

Arguments

:: KeyMap

actions

-> [Modifier]

jump modifier

-> Text

window names

-> [Modifier]

actual modifier

-> Key

key

-> Action

action

Lookup the action to perform in response to a particular key event.

initialKeyMap :: KeyMap

Default key bindings

addKeyBinding

Arguments

:: [Modifier]

modifiers

-> Key

key

-> Action

action

-> KeyMap

actions

-> KeyMap

Bind a keypress event to a new action.

removeKeyBinding

Arguments

:: [Modifier]

modifiers

-> Key

key

-> KeyMap

actions

-> KeyMap

Unbind the action associated with a key.

keyMapEntries :: KeyMap -> [([Modifier], Key, Action)]

Keys as text

parseKey :: String -> Maybe ([Modifier], Key)

prettyModifierKey :: [Modifier] -> Key -> String

actionName :: Action -> Text

Render action as human-readable text.