keybind

README

keybind

Keybind is a library to register global OS Hotkeys and associate any function to it.

Simple usage

keys := keybind.StringsToKeys("LALT", "c")
keybind.KeyBind(func() {
    log.Println("hello from key bind - ALT + C")
}, keys...) // Alt, c

keybind.KeyBind(func() {
    log.Println("Ctrl, Alt, c")
}, 162, 164, 67) // Ctrl, Alt, C

keybind.Listen()

for range time.Tick(time.Second) {

}

If the key codes are updated then it *** file should be re generated

1. go get golang.org/x/tools/cmd/stringer
2. go generate

Documentation

Index

• Constants
• Variables
• func KeyBind(fn onKeyFunc, keys ...uint16)
• func Liten()
• func Register(fn onKeyFunc, keys ...KeyCode)
• func ShowRegister()
• func StringsToKeys(str ...string) []uint16
• type KeyCode
  • func (i KeyCode) String() string

Constants

const (
	KeyA uint16 = 4 + iota
	KeyB
	KeyC
	KeyD
	KeyE
	KeyF
	KeyG
	KeyH
	KeyI
	KeyJ
	KeyK
	KeyL
	KeyM
	KeyN
	KeyO
	KeyP
	KeyQ
	KeyR
	KeyS
	KeyT
	KeyU
	KeyV
	KeyW
	KeyX
	KeyY
	KeyZ
)

const (
	Key1 uint16 = 30 + iota
	Key2
	Key3
	Key4
	Key5
	Key6
	Key7
	Key8
	Key9
	Key0
)

const (
	// choice is to use Enter name instead of Return
	// and the key code is different from Keypad Enter
	KeyEnter uint16 = 40 + iota
	KeyEscape
	KeyBackspace
	KeyTab
	KeySpace
	// keypad minus has different key code
	KeyMinus
	KeyEquals
	KeyLeftBracket
	KeyRightBracket
	KeyBackslash
)

const (
	// different name from SDL2 for brevity
	KeyColon uint16 = 51 + iota
	KeyApostrophe
	// KeyTilde is an alias
	KeyGrave
	KeyCommad
	// KeyDot is an alias, keypad period is a different
	KeyPeriod
	Slash
	CapsLock
)

const (
	KeyF1 uint16 = 58 + iota
	KeyF2
	KeyF3
	KeyF4
	KeyF5
	KeyF6
	KeyF7
	KeyF8
	KeyF9
	KeyF10
	KeyF11
	KeyF12
)

const (
	KeyPrintScreen uint16 = 70 + iota
	KeyScrollLock
	KeyPause
	KeyInsert
	KeyHome
	KeyPageUp
	KeyDelete
	KeyEnd
	KeyPageDown
	KeyRight
	KeyLeft
	KeyDown
	KeyUp
)

const (
	KeyNumLock uint16 = 83 + iota
	KeyKpDivide
	KeyKpMultiply
	KeyKpMinus
	KeyKpPlus
	KeyKpEnter
	KeyKp1
	KeyKp2
	KeyKp3
	KeyKp4
	KeyKp5
	KeyKp6
	KeyKp7
	KeyKp8
	KeyKp9
	KeyKp0
	// KeyKpDot is an alias
	KeyKpPeriod
)

const (
	KeyLCtrl uint16 = 224 + iota
	KeyLShift
	KeyLAlt
	// KeyLWin is an alias
	KeyLGUI
	KeyRCtrl
	KeyRShift
	KeyRAlt
	// KeyRWin is an alias
	KeyRGUI
)

const KeyDot = KeyPeriod

const KeyKpDot = KeyKpPeriod

const KeyLWin = KeyLGUI

const KeyRWin = KeyRGUI

const KeyTilde = KeyGrave

Variables

var (

	// Debug flag (show logs what is pressed)
	Debug = false
)

Functions

func KeyBind

func KeyBind(fn onKeyFunc, keys ...uint16)

KeyBind func

func Liten

func Liten()

Liten for registered combinations

func Register

func Register(fn onKeyFunc, keys ...KeyCode)

Register keys combination

func ShowRegister

func ShowRegister()

ShowRegister func

func StringsToKeys

func StringsToKeys(str ...string) []uint16

StringsToKeys func

Types

type KeyCode

type KeyCode uint16

KeyCode struct

func (KeyCode) String

func (i KeyCode) String() string