keymap

Documentation

Index

• type Bind
  • func (b Bind) String() string
• type Key
  • func (k Key) String() string
• type Map
  • func (m Map) Resolve(event *tcell.EventKey) commands.Command

Types

type Bind

type Bind struct {
	Key         Key
	Cmd         commands.Command
	Description string
}

Struct that holds a key and a command

func (Bind) String

func (b Bind) String() string

type Key

type Key struct {
	Code tcell.Key // Special character codes.
	Char rune      // used when the key represents a single ascii char like "a" or "2".
}

Key is a structure that represents a key that can be bound to an command

func (Key) String

func (k Key) String() string

type Map

type Map []Bind

Map is a collection of keybinds

func (Map) Resolve

func (m Map) Resolve(event *tcell.EventKey) commands.Command

Resolve translates a tcell.EventKey to a command based on the bindings in the map.

If no binding could be found. commands.Noop is returned.