key

Documentation

Overview

Package key enumerates keystrings for use in bindings.

Index

• Constants
• Variables
• func Binding(fn func(event.CID, Event) int) func(event.CID, interface{}) int
• type Code
• type Event
• type State
  • func NewState() State
  • func (ks *State) IsDown(key string) (k bool)
  • func (ks *State) IsHeld(key string) (k bool, d time.Duration)
  • func (ks *State) SetDown(key string)
  • func (ks *State) SetUp(key string)

Constants

const (
	// Down is sent when a key is pressed. It is sent both as
	// Down, and as Down + the key name.
	Down = "KeyDown"
	// Up is sent when a key is released. It is sent both as
	// Up, and as Up + the key name.
	Up = "KeyUp"
	// Held is sent when a key is held down. It is sent both as
	// Held, and as Held + the key name.
	Held = "KeyHeld"
)

const (
	Unknown = "Unknown"

	A = "A"
	B = "B"
	C = "C"
	D = "D"
	E = "E"
	F = "F"
	G = "G"
	H = "H"
	I = "I"
	J = "J"
	K = "K"
	L = "L"
	M = "M"
	N = "N"
	O = "O"
	P = "P"
	Q = "Q"
	R = "R"
	S = "S"
	T = "T"
	U = "U"
	V = "V"
	W = "W"
	X = "X"
	Y = "Y"
	Z = "Z"

	One   = "1"
	Two   = "2"
	Three = "3"
	Four  = "4"
	Five  = "5"
	Six   = "6"
	Seven = "7"
	Eight = "8"
	Nine  = "9"
	Zero  = "0"

	ReturnEnter        = "ReturnEnter"
	Enter              = ReturnEnter
	Escape             = "Escape"
	DeleteBackspace    = "DeleteBackspace"
	Tab                = "Tab"
	Spacebar           = "Spacebar"
	HyphenMinus        = "HyphenMinus"        //-
	EqualSign          = "EqualSign"          //=
	LeftSquareBracket  = "LeftSquareBracket"  //[
	RightSquareBracket = "RightSquareBracket" //]
	Backslash          = "Backslash"          //\
	Semicolon          = "Semicolon"          //;
	Apostrophe         = "Apostrophe"         //'
	GraveAccent        = "GraveAccent"        //`
	Comma              = "Comma"              //,
	FullStop           = "FullStop"           //.
	Period             = FullStop
	Slash              = "Slash" ///
	CapsLock           = "CapsLock"

	F1  = "F1"
	F2  = "F2"
	F3  = "F3"
	F4  = "F4"
	F5  = "F5"
	F6  = "F6"
	F7  = "F7"
	F8  = "F8"
	F9  = "F9"
	F10 = "F10"
	F11 = "F11"
	F12 = "F12"

	Pause         = "Pause"
	Insert        = "Insert"
	Home          = "Home"
	PageUp        = "PageUp"
	DeleteForward = "DeleteForward"
	End           = "End"
	PageDown      = "PageDown"

	RightArrow = "RightArrow"
	LeftArrow  = "LeftArrow"
	DownArrow  = "DownArrow"
	UpArrow    = "UpArrow"

	KeypadNumLock     = "KeypadNumLock"
	KeypadSlash       = "KeypadSlash"       ///
	KeypadAsterisk    = "KeypadAsterisk"    //*
	KeypadHyphenMinus = "KeypadHyphenMinus" //-
	KeypadPlusSign    = "KeypadPlusSign"    //+
	KeypadEnter       = "KeypadEnter"
	Keypad1           = "Keypad1"
	Keypad2           = "Keypad2"
	Keypad3           = "Keypad3"
	Keypad4           = "Keypad4"
	Keypad5           = "Keypad5"
	Keypad6           = "Keypad6"
	Keypad7           = "Keypad7"
	Keypad8           = "Keypad8"
	Keypad9           = "Keypad9"
	Keypad0           = "Keypad0"
	KeypadFullStop    = "KeypadFullStop" //.
	KeypadPeriod      = KeypadFullStop
	KeypadEqualSign   = "KeypadEqualSign" //=

	F13 = "F13"
	F14 = "F14"
	F15 = "F15"
	F16 = "F16"
	F17 = "F17"
	F18 = "F18"
	F19 = "F19"
	F20 = "F20"
	F21 = "F21"
	F22 = "F22"
	F23 = "F23"
	F24 = "F24"

	Help = "Help"

	Mute       = "Mute"
	VolumeUp   = "VolumeUp"
	VolumeDown = "VolumeDown"

	LeftControl  = "LeftControl"
	LeftShift    = "LeftShift"
	LeftAlt      = "LeftAlt"
	LeftGUI      = "LeftGUI"
	RightControl = "RightControl"
	RightShift   = "RightShift"
	RightAlt     = "RightAlt"
	RightGUI     = "RightGUI"
)

This lists the keys sent through oak's input events. This list is not used internally by oak, but was generated from the expected output from x/mobile/key.

These strings are sent as payloads to Key.Down and Key.Up events, and through "KeyDown"+$a, "KeyUp"+$a for any $a in the const.

Variables

var AllKeys = map[string]struct{}{}/* 119 elements not displayed */

AllKeys is the set of all defined key codes

Functions

func Binding

func Binding(fn func(event.CID, Event) int) func(event.CID, interface{}) int

Binding will convert a function that accepts a typecast key.Event into a generic event binding

Example:

bus.Bind(key.Down, key.Binding(keyHandler))

Types

type Code

type Code = key.Code

A code is a unique integer code for a given common key

type Event

type Event = key.Event

An Event is sent as the payload for all key bindings.

type State

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

A State tracks what keys of a keyboard are currently pressed and for how long they have been pressed if they are held down.

func NewState

func NewState() State

NewState creates a state object for tracking keyboard state.

func (*State) IsDown

func (ks *State) IsDown(key string) (k bool)

IsDown returns whether a key is held down

func (*State) IsHeld

func (ks *State) IsHeld(key string) (k bool, d time.Duration)

IsHeld returns whether a key is held down, and for how long it has been held.

func (*State) SetDown

func (ks *State) SetDown(key string)

SetDown will cause later IsDown calls to report true for the given key. This is called internally when events are sent from the real keyboard and mouse. Calling this can interrupt real input or cause unintended behavior and should be done cautiously.

func (*State) SetUp

func (ks *State) SetUp(key string)

SetUp will cause later IsDown calls to report false for the given key. This is called internally when events are sent from the real keyboard and mouse. Calling this can interrupt real input or cause unintended behavior and should be done cautiously.