keys

package

v0.0.0-...-40e63e7 Latest Latest Go to latest Published: Mar 25, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Binding holds a parsed, user provided key sequence.

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

Sequencer holds all the keyboard bindings and their action mappings.

func NewSequencer() *Sequencer

NewSequencer returns Sequencer.

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

AddBind creates a new key mapping.

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 (s *Sequencer) List() list.List

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

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

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

RemoveBind removes a key mapping.

func (s *Sequencer) String() string

String returns the current input sequence as a string.