package cbind

Import Path
	code.rocketnine.space/tslocum/cbind (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 2 packages

Involved Source Files

	    configuration.go
	  d doc.go
		Package cbind provides tcell key event encoding, decoding and handling.
		
		The NewConfiguration example demonstrates how to use cbind.
		
		There are some limitations on reading keyboard input, which is explained in the tcell.EventKey documentation:
		
		https://godoc.org/github.com/gdamore/tcell#EventKey

	    key.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Configuration (struct)
		Configuration maps keys to event handlers and processes key events.

		Methods (total 5)
			(*Configuration) Capture(ev *tcell.EventKey) *tcell.EventKey
				Capture handles key events.

			(*Configuration) Clear()
				Clear removes all handlers.

			(*Configuration) Set(s string, handler func(ev *tcell.EventKey) *tcell.EventKey) error
				Set sets the handler for a key event string.

			(*Configuration) SetKey(mod tcell.ModMask, key tcell.Key, handler func(ev *tcell.EventKey) *tcell.EventKey)
				SetKey sets the handler for a key.

			(*Configuration) SetRune(mod tcell.ModMask, ch rune, handler func(ev *tcell.EventKey) *tcell.EventKey)
				SetRune sets the handler for a rune.

		As Outputs Of (at least one exported)
			func NewConfiguration() *Configuration


Package-Level Functions (total 3)

	 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(mod tcell.ModMask, key tcell.Key, ch rune) (string, error)
		Encode encodes a key or combination of keys a string.

	 func NewConfiguration() *Configuration
		NewConfiguration returns a new input configuration.


Package-Level Variables (total 2)

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

	  var UnifyEnterKeys bool
		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.


Package-Level Constants (total 4)

	const LabelAlt = "alt"
		Modifier labels

	const LabelCtrl = "ctrl"
		Modifier labels

	const LabelMeta = "meta"
		Modifier labels

	const LabelShift = "shift"
		Modifier labels

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.