Matterhorn.Events.Keybindings

Documentation

defaultBindings :: KeyEvent -> [Binding]

lookupKeybinding :: Event -> KeyHandlerMap -> Maybe KeyHandler

Find a keybinding that matches a Vty Event

getFirstDefaultBinding :: KeyEvent -> Binding

mkKb :: KeyEvent -> Text -> MH () -> KeyEventHandler

staticKb :: Text -> Event -> MH () -> KeyEventHandler

mkKeybindings :: [KeyEventHandler] -> KeyConfig -> KeyHandlerMap

handleKeyboardEvent

Arguments

:: (KeyConfig -> KeyHandlerMap)

The function to build a key handler map from a key configuration.

-> (Event -> MH ())

The fallback action to invoke if no matching binding can be found.

-> Event

The event to handle.

-> MH Bool

Handle a keyboard event by looking it up in a map of bindings and invoking the matching binding's handler. If no match can be found, invoke a fallback action instead. Return True if the key event was handled with a matching binding; False if not (the fallback case).

data EventHandler

An EventHandler represents a event handler.

Constructors

EH

Fields

• ehDescription :: Text

  The description of this handler's behavior.

• ehAction :: MH ()

  The action to take when this handler is invoked.

data KeyHandler

A handler for a specific key.

Constructors

KH

Fields

• khHandler :: KeyEventHandler

  The handler to invoke.

• khKey :: Event

  The specific key that should trigger this handler.

data KeyEventHandler

A handler for an abstract key event.

Constructors

KEH

Fields

• kehHandler :: EventHandler

  The handler to invoke.

• kehEventTrigger :: KeyEventTrigger

  The trigger for the handler.

data KeyEventTrigger

A trigger for a key event.

Constructors

Static Event

The key event is always triggered by a specific key.

ByEvent KeyEvent

The key event is always triggered by an abstract key event (and thus configured to be bound to specific key(s) in the KeyConfig).

Instances

Eq KeyEventTrigger

Defined in Matterhorn.Events.Keybindings

Methods

(==) :: KeyEventTrigger -> KeyEventTrigger -> Bool

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

Ord KeyEventTrigger

Defined in Matterhorn.Events.Keybindings

Methods

compare :: KeyEventTrigger -> KeyEventTrigger -> Ordering

(<) :: KeyEventTrigger -> KeyEventTrigger -> Bool

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

(>) :: KeyEventTrigger -> KeyEventTrigger -> Bool

(>=) :: KeyEventTrigger -> KeyEventTrigger -> Bool

max :: KeyEventTrigger -> KeyEventTrigger -> KeyEventTrigger

min :: KeyEventTrigger -> KeyEventTrigger -> KeyEventTrigger

Show KeyEventTrigger

Defined in Matterhorn.Events.Keybindings

Methods

showsPrec :: Int -> KeyEventTrigger -> ShowS

show :: KeyEventTrigger -> String

showList :: [KeyEventTrigger] -> ShowS

newtype KeyHandlerMap

Constructors

KeyHandlerMap (Map Event KeyHandler)

data KeyEvent

This enum represents all the possible key events a user might want to use.

Constructors

VtyRefreshEvent

ShowHelpEvent

EnterSelectModeEvent

ReplyRecentEvent

ToggleMessagePreviewEvent

InvokeEditorEvent

EnterFastSelectModeEvent

QuitEvent

NextChannelEvent

PrevChannelEvent

NextChannelEventAlternate

PrevChannelEventAlternate

NextUnreadChannelEvent

NextUnreadUserOrChannelEvent

LastChannelEvent

EnterOpenURLModeEvent

ClearUnreadEvent

ToggleMultiLineEvent

EnterFlaggedPostsEvent

ToggleChannelListVisibleEvent

ToggleExpandedChannelTopicsEvent

ShowAttachmentListEvent

EditorKillToBolEvent

EditorKillToEolEvent

EditorBolEvent

EditorEolEvent

EditorTransposeCharsEvent

EditorDeleteCharacter

EditorPrevCharEvent

EditorNextCharEvent

EditorPrevWordEvent

EditorNextWordEvent

EditorDeleteNextWordEvent

EditorDeletePrevWordEvent

EditorHomeEvent

EditorEndEvent

EditorYankEvent

SelectNextTabEvent

SelectPreviousTabEvent

CancelEvent

LoadMoreEvent

OpenMessageURLEvent

ScrollUpEvent

ScrollDownEvent

ScrollLeftEvent

ScrollRightEvent

PageUpEvent

PageDownEvent

PageRightEvent

PageLeftEvent

ScrollTopEvent

ScrollBottomEvent

SelectOldestMessageEvent

SelectUpEvent

SelectDownEvent

SearchSelectUpEvent

SearchSelectDownEvent

ActivateListItemEvent

ViewMessageEvent

FillGapEvent

FlagMessageEvent

PinMessageEvent

YankMessageEvent

YankWholeMessageEvent

DeleteMessageEvent

EditMessageEvent

ReplyMessageEvent

ReactToMessageEvent

AttachmentListAddEvent

AttachmentListDeleteEvent

AttachmentOpenEvent

FormSubmitEvent

Instances

Enum KeyEvent

Defined in Matterhorn.Types.KeyEvents

Methods

succ :: KeyEvent -> KeyEvent

pred :: KeyEvent -> KeyEvent

toEnum :: Int -> KeyEvent

fromEnum :: KeyEvent -> Int

enumFrom :: KeyEvent -> [KeyEvent]

enumFromThen :: KeyEvent -> KeyEvent -> [KeyEvent]

enumFromTo :: KeyEvent -> KeyEvent -> [KeyEvent]

enumFromThenTo :: KeyEvent -> KeyEvent -> KeyEvent -> [KeyEvent]

Eq KeyEvent

Defined in Matterhorn.Types.KeyEvents

Methods

(==) :: KeyEvent -> KeyEvent -> Bool

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

Ord KeyEvent

Defined in Matterhorn.Types.KeyEvents

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

Defined in Matterhorn.Types.KeyEvents

Methods

showsPrec :: Int -> KeyEvent -> ShowS

show :: KeyEvent -> String

showList :: [KeyEvent] -> ShowS

type KeyConfig = Map KeyEvent BindingState

allEvents :: [KeyEvent]

parseBinding :: Text -> Either String Binding

keyEventName :: KeyEvent -> Text

keyEventFromName :: Text -> Either String KeyEvent

ensureKeybindingConsistency :: KeyConfig -> [(String, KeyConfig -> KeyHandlerMap)] -> Either String ()

Given a configuration, we want to check it for internal consistency (i.e. that a given keybinding isn't associated with multiple events which both need to get generated in the same UI mode) and also for basic usability (i.e. we shouldn't be binding events which can appear in the main UI to a key like e, which would prevent us from being able to type messages containing an e in them!