keys

Documentation

Index

• type Binding
• type Sequencer
  • func NewSequencer() *Sequencer
  • func (s *Sequencer) AddBind(binding Binding) error
  • func (s *Sequencer) KeyInput(ev *tcell.EventKey, contexts []string) bool
  • func (s *Sequencer) List() list.List
  • func (s *Sequencer) Match(contexts []string) *Binding
  • func (s *Sequencer) RemoveBind(context string, seq keysequence.KeySequence) error
  • func (s *Sequencer) String() string

Types

type Binding

type Binding struct {
	Command  string
	Context  string
	Sequence keysequence.KeySequence
}

Binding holds a parsed, user provided key sequence.

type Sequencer

type Sequencer struct {
	// contains filtered or unexported fields
}

Sequencer holds all the keyboard bindings and their action mappings.

func NewSequencer

func NewSequencer() *Sequencer

NewSequencer returns Sequencer.

func (*Sequencer) AddBind

func (s *Sequencer) AddBind(binding Binding) error

AddBind creates a new key mapping.

func (*Sequencer) KeyInput

func (s *Sequencer) KeyInput(ev *tcell.EventKey, contexts []string) bool

KeyInput feeds a keypress to the sequencer. Returns true if there is one match or more, or false if there is no match.

func (*Sequencer) List

func (s *Sequencer) List() list.List

func (*Sequencer) Match

func (s *Sequencer) Match(contexts []string) *Binding

Match returns a key binding if the current input sequence is found.

func (*Sequencer) RemoveBind

func (s *Sequencer) RemoveBind(context string, seq keysequence.KeySequence) error

RemoveBind removes a key mapping.

func (*Sequencer) String

func (s *Sequencer) String() string

String returns the current input sequence as a string.