keys

Documentation

Overview

Package keys deals with nicely representing keypresses.

Index

• type Key
  • func (i Key) String() string
• type Keypress
  • func FromTermbox(e termbox.Event) Keypress
• type Modifier
  • func (i Modifier) String() string

Types

type Key

type Key rune

const (
	F1 Key = utf8.MaxRune + iota
	F2
	F3
	F4
	F5
	F6
	F7
	F8
	F9
	F10
	F11
	F12
	Insert
	Delete
	Home
	End
	Up
	Down
	Left
	Right
	PgDn
	PgUp
	Backspace
	Tab
	Enter
	Esc
)

These constants represent nonprinting keys on the keyboard

func (Key) String

func (i Key) String() string

type Keypress

type Keypress struct {
	Mod Modifier
	Key Key
}

a Key represents a keypress event

func FromTermbox

func FromTermbox(e termbox.Event) Keypress

FromTermbox creates a Key from a termbox event

type Modifier

type Modifier byte

const (
	Shift Modifier = 1 << iota
	Ctrl
	Alt
)

func (Modifier) String

func (i Modifier) String() string