package keyboard
import "github.com/eiannone/keyboard"
Index ¶
- func Close() (err error)
- func GetKeys(bufferSize int) (<-chan KeyEvent, error)
- func IsStarted(timeout time.Duration) bool
- func Open() (err error)
- type Key
- type KeyEvent
Functions ¶
func Close ¶
func Close() (err error)
Should be called after successful initialization when functionality isn't required anymore.
func GetKeys ¶
func IsStarted ¶
func Open ¶
func Open() (err error)
Types ¶
type Key ¶
type Key uint16
const ( KeyF1 Key = 0xFFFF - iota KeyF2 KeyF3 KeyF4 KeyF5 KeyF6 KeyF7 KeyF8 KeyF9 KeyF10 KeyF11 KeyF12 KeyInsert KeyDelete KeyHome KeyEnd KeyPgup KeyPgdn KeyArrowUp KeyArrowDown KeyArrowLeft KeyArrowRight )
Key constants, see GetKey() function.
const ( KeyCtrlTilde Key = 0x00 KeyCtrl2 Key = 0x00 KeyCtrlSpace Key = 0x00 KeyCtrlA Key = 0x01 KeyCtrlB Key = 0x02 KeyCtrlC Key = 0x03 KeyCtrlD Key = 0x04 KeyCtrlE Key = 0x05 KeyCtrlF Key = 0x06 KeyCtrlG Key = 0x07 KeyBackspace Key = 0x08 KeyCtrlH Key = 0x08 KeyTab Key = 0x09 KeyCtrlI Key = 0x09 KeyCtrlJ Key = 0x0A KeyCtrlK Key = 0x0B KeyCtrlL Key = 0x0C KeyEnter Key = 0x0D KeyCtrlM Key = 0x0D KeyCtrlN Key = 0x0E KeyCtrlO Key = 0x0F KeyCtrlP Key = 0x10 KeyCtrlQ Key = 0x11 KeyCtrlR Key = 0x12 KeyCtrlS Key = 0x13 KeyCtrlT Key = 0x14 KeyCtrlU Key = 0x15 KeyCtrlV Key = 0x16 KeyCtrlW Key = 0x17 KeyCtrlX Key = 0x18 KeyCtrlY Key = 0x19 KeyCtrlZ Key = 0x1A KeyEsc Key = 0x1B KeyCtrlLsqBracket Key = 0x1B KeyCtrl3 Key = 0x1B KeyCtrl4 Key = 0x1C KeyCtrlBackslash Key = 0x1C KeyCtrl5 Key = 0x1D KeyCtrlRsqBracket Key = 0x1D KeyCtrl6 Key = 0x1E KeyCtrl7 Key = 0x1F KeyCtrlSlash Key = 0x1F KeyCtrlUnderscore Key = 0x1F KeySpace Key = 0x20 KeyBackspace2 Key = 0x7F KeyCtrl8 Key = 0x7F )
func GetKey ¶
func GetSingleKey ¶
type KeyEvent ¶
type KeyEvent struct {
Key Key // One of Key* constants, invalid if 'Ch' is not 0
Rune rune // A unicode character
Err error // Error in case if input failed
}
Source Files ¶
keyboard.go keyboard_common.go syscalls_linux.go terminfo.go
- Version
- v0.0.0-20220611211555-0d226195f203 (latest)
- Published
- Jun 11, 2022
- Platform
- linux/amd64
- Imports
- 12 packages
- Last checked
- now –
Tools for package owners.