keyboardlayout

Documentation

Overview

Package keyboardlayout provides keyboard key interpretation and layout validation.

Index

• type KeyDefinition
• type KeyInput
• type KeyboardLayout
  • func GetKeyboardLayout(name string) KeyboardLayout
  • func (kl KeyboardLayout) KeyDefinition(key KeyInput) (KeyDefinition, bool)
  • func (kl KeyboardLayout) ShiftKeyDefinition(key KeyInput) KeyDefinition

Types

type KeyDefinition

type KeyDefinition struct {
	Code                   string
	Key                    string
	KeyCode                int64
	KeyCodeWithoutLocation int64
	ShiftKey               string
	ShiftKeyCode           int64
	Text                   string
	Location               int64
}

type KeyInput

type KeyInput string

type KeyboardLayout

type KeyboardLayout struct {
	ValidKeys map[KeyInput]bool
	Keys      map[KeyInput]KeyDefinition
}

func GetKeyboardLayout

func GetKeyboardLayout(name string) KeyboardLayout

GetKeyboardLayout returns the keyboard layout registered with name.

func (KeyboardLayout) KeyDefinition

func (kl KeyboardLayout) KeyDefinition(key KeyInput) (KeyDefinition, bool)

KeyDefinition returns true with the key definition of a given key input. It returns false and an empty key definition if it cannot find the key.

func (KeyboardLayout) ShiftKeyDefinition

func (kl KeyboardLayout) ShiftKeyDefinition(key KeyInput) KeyDefinition

ShiftKeyDefinition returns shift key definition of a given key input. It returns an empty key definition if it cannot find the key.