Safe Haskell	None
Language	Haskell2010

Matterhorn.Types.KeyEvents

Contents

Types
Data
Parsing and pretty-printing
Key event name resolution

Synopsis

data KeyEvent
type KeyConfig = Map KeyEvent BindingState
data Binding = Binding {
- kbMods :: [Modifier]
- kbKey :: Key
}
data BindingState
- = BindingList [Binding]
- | Unbound
allEvents :: [KeyEvent]
parseBinding :: Text -> Either String Binding
parseBindingList :: Text -> Either String BindingState
ppBinding :: Binding -> Text
nonCharKeys :: [Text]
eventToBinding :: Event -> Binding
keyEventFromName :: Text -> Either String KeyEvent
keyEventName :: KeyEvent -> Text

Types

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

data Binding Source #

Constructors

Binding
Fields kbMods :: [Modifier] kbKey :: Key

Instances

Instances details

Eq Binding Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods (==) :: Binding -> Binding -> Bool # (/=) :: Binding -> Binding -> Bool #
Ord Binding Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods compare :: Binding -> Binding -> Ordering # (<) :: Binding -> Binding -> Bool # (<=) :: Binding -> Binding -> Bool # (>) :: Binding -> Binding -> Bool # (>=) :: Binding -> Binding -> Bool # max :: Binding -> Binding -> Binding # min :: Binding -> Binding -> Binding #
Show Binding Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods showsPrec :: Int -> Binding -> ShowS # show :: Binding -> String # showList :: [Binding] -> ShowS #

data BindingState Source #

Constructors

BindingList [Binding]
Unbound

Instances

Instances details

Eq BindingState Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods (==) :: BindingState -> BindingState -> Bool # (/=) :: BindingState -> BindingState -> Bool #
Ord BindingState Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods compare :: BindingState -> BindingState -> Ordering # (<) :: BindingState -> BindingState -> Bool # (<=) :: BindingState -> BindingState -> Bool # (>) :: BindingState -> BindingState -> Bool # (>=) :: BindingState -> BindingState -> Bool # max :: BindingState -> BindingState -> BindingState # min :: BindingState -> BindingState -> BindingState #
Show BindingState Source #
Instance details Defined in Matterhorn.Types.KeyEvents Methods showsPrec :: Int -> BindingState -> ShowS # show :: BindingState -> String # showList :: [BindingState] -> ShowS #

Data

allEvents :: [KeyEvent] Source #

Parsing and pretty-printing

parseBinding :: Text -> Either String Binding Source #

parseBindingList :: Text -> Either String BindingState Source #

ppBinding :: Binding -> Text Source #

nonCharKeys :: [Text] Source #

eventToBinding :: Event -> Binding Source #

Key event name resolution

keyEventFromName :: Text -> Either String KeyEvent Source #

keyEventName :: KeyEvent -> Text Source #