Package cbind

Constants

Modifier labels

const (
    LabelCtrl  = "ctrl"
    LabelAlt   = "alt"
    LabelMeta  = "meta"
    LabelShift = "shift"
)

Variables

ErrInvalidKeyEvent is the error returned when encoding or decoding a key event fails.

var ErrInvalidKeyEvent = errors.New("invalid key event")

UnifyEnterKeys is a flag that determines whether or not KPEnter (keypad enter) key events are interpreted as Enter key events. When enabled, Ctrl+J key events are also interpreted as Enter key events.

var UnifyEnterKeys = true

func Decode ¶

func Decode(s string) (mod tcell.ModMask, key tcell.Key, ch rune, err error)

Decode decodes a string as a key or combination of keys.

func Encode ¶

func Encode(mod tcell.ModMask, key tcell.Key, ch rune) (string, error)

Encode encodes a key or combination of keys a string.

type Configuration ¶

Configuration maps keys to event handlers and processes key events.

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

func NewConfiguration ¶

func NewConfiguration() *Configuration

NewConfiguration returns a new input configuration.

// Create a new input configuration to store the key bindings.
c := NewConfiguration()

handleSave := func(ev *tcell.EventKey) *tcell.EventKey {
    // Save
    return nil
}

handleOpen := func(ev *tcell.EventKey) *tcell.EventKey {
    // Open
    return nil
}

handleExit := func(ev *tcell.EventKey) *tcell.EventKey {
    // Exit
    return nil
}

// Bind Alt+s.
if err := c.Set("Alt+s", handleSave); err != nil {
    log.Fatalf("failed to set keybind: %s", err)
}

// Bind Alt+o.
c.SetRune(tcell.ModAlt, 'o', handleOpen)

// Bind Escape.
c.SetKey(tcell.ModNone, tcell.KeyEscape, handleExit)

// Capture input. This will differ based on the framework in use (if any).
// When using tview or cview, call Application.SetInputCapture before calling
// Application.Run.
// app.SetInputCapture(c.Capture)

func (*Configuration) Capture ¶

func (c *Configuration) Capture(ev *tcell.EventKey) *tcell.EventKey

Capture handles key events.

// See the end of the NewConfiguration example.

func (*Configuration) Clear ¶

func (c *Configuration) Clear()

Clear removes all handlers.

func (*Configuration) Set ¶

func (c *Configuration) Set(s string, handler func(ev *tcell.EventKey) *tcell.EventKey) error

Set sets the handler for a key event string.

func (*Configuration) SetKey ¶

func (c *Configuration) SetKey(mod tcell.ModMask, key tcell.Key, handler func(ev *tcell.EventKey) *tcell.EventKey)

SetKey sets the handler for a key.

func (*Configuration) SetRune ¶

func (c *Configuration) SetRune(mod tcell.ModMask, ch rune, handler func(ev *tcell.EventKey) *tcell.EventKey)

SetRune sets the handler for a rune.

Subdirectories