Safe Haskell	None
Language	Haskell2010

Matterhorn.Events.Keybindings

Synopsis

defaultBindings :: KeyEvent -> [Binding]
lookupKeybinding :: Event -> KeyHandlerMap -> Maybe KeyHandler
firstActiveBinding :: KeyConfig -> KeyEvent -> Binding
mkKb :: KeyEvent -> Text -> MH () -> KeyEventHandler
staticKb :: Text -> Event -> MH () -> KeyEventHandler
mkKeybindings :: [KeyEventHandler] -> KeyConfig -> KeyHandlerMap
handleKeyboardEvent :: (KeyConfig -> KeyHandlerMap) -> (Event -> MH ()) -> Event -> MH Bool
data EventHandler = EH {
- ehDescription :: Text
- ehAction :: MH ()
}
data KeyHandler = KH {
- khHandler :: KeyEventHandler
- khKey :: Event
}
data KeyEventHandler = KEH {
- kehHandler :: EventHandler
- kehEventTrigger :: KeyEventTrigger
}
data KeyEventTrigger
- = Static Event
- | ByEvent KeyEvent
newtype KeyHandlerMap = KeyHandlerMap (Map Event KeyHandler)
data KeyEvent
type KeyConfig = Map KeyEvent BindingState
allEvents :: [KeyEvent]
parseBinding :: Text -> Either String Binding
keyEventName :: KeyEvent -> Text
keyEventFromName :: Text -> Either String KeyEvent
ensureKeybindingConsistency :: KeyConfig -> [(Text, [KeyEventHandler])] -> Either String ()

Documentation

defaultBindings :: KeyEvent -> [Binding] Source #

lookupKeybinding :: Event -> KeyHandlerMap -> Maybe KeyHandler Source #

Find a keybinding that matches a Vty Event

firstActiveBinding :: KeyConfig -> KeyEvent -> Binding Source #

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

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

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

handleKeyboardEvent Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

Instances details

Eq KeyEventTrigger Source #
Instance details Defined in Matterhorn.Events.Keybindings Methods (==) :: KeyEventTrigger -> KeyEventTrigger -> Bool # (/=) :: KeyEventTrigger -> KeyEventTrigger -> Bool #
Ord KeyEventTrigger Source #
Instance details 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 Source #
Instance details Defined in Matterhorn.Events.Keybindings Methods showsPrec :: Int -> KeyEventTrigger -> ShowS # show :: KeyEventTrigger -> String # showList :: [KeyEventTrigger] -> ShowS #

newtype KeyHandlerMap Source #

Constructors

KeyHandlerMap (Map Event KeyHandler)

data KeyEvent Source #

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
SaveAttachmentEvent
CancelEvent
LoadMoreEvent
OpenMessageURLEvent
ScrollUpEvent
ScrollDownEvent
ScrollLeftEvent
ScrollRightEvent
PageUpEvent
PageDownEvent
PageRightEvent
PageLeftEvent
ScrollTopEvent
ScrollBottomEvent
SelectOldestMessageEvent
SelectUpEvent
SelectDownEvent
SearchSelectUpEvent
SearchSelectDownEvent
ActivateListItemEvent
ViewMessageEvent
FillGapEvent
CopyPostLinkEvent
FlagMessageEvent
PinMessageEvent
YankMessageEvent
YankWholeMessageEvent
DeleteMessageEvent
EditMessageEvent
ReplyMessageEvent
ReactToMessageEvent
AttachmentListAddEvent
AttachmentListDeleteEvent
AttachmentOpenEvent
FileBrowserBeginSearchEvent
FileBrowserSelectEnterEvent
FileBrowserSelectCurrentEvent
FileBrowserListPageUpEvent
FileBrowserListPageDownEvent
FileBrowserListHalfPageUpEvent
FileBrowserListHalfPageDownEvent
FileBrowserListTopEvent
FileBrowserListBottomEvent
FileBrowserListNextEvent
FileBrowserListPrevEvent
FormSubmitEvent
NextTeamEvent
PrevTeamEvent
MoveCurrentTeamLeftEvent
MoveCurrentTeamRightEvent

Instances

Instances details

Enum KeyEvent Source #
Instance details 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 Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods (==) :: KeyEvent -> KeyEvent -> Bool # (/=) :: KeyEvent -> KeyEvent -> Bool #
Ord KeyEvent Source #
Instance details 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 Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods showsPrec :: Int -> KeyEvent -> ShowS # show :: KeyEvent -> String # showList :: [KeyEvent] -> ShowS #

type KeyConfig = Map KeyEvent BindingState Source #

allEvents :: [KeyEvent] Source #

parseBinding :: Text -> Either String Binding Source #

keyEventName :: KeyEvent -> Text Source #

keyEventFromName :: Text -> Either String KeyEvent Source #

ensureKeybindingConsistency :: KeyConfig -> [(Text, [KeyEventHandler])] -> Either String () Source #

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!