input

package
v0.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2024 License: GPL-3.0 Imports: 1 Imported by: 4

Documentation

Overview

Package input defines keyboard and mouse code constants.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Button

type Button int

Button represents a mouse button.

const (
	ButtonNone Button = iota

	Button1
	Button2
	Button3
	Button4
	Button5
	Button6
	Button7
	Button8
	Button9

	ButtonLeft    Button = Button1
	ButtonMiddle  Button = Button2
	ButtonRight   Button = Button3
	ButtonBack    Button = Button8
	ButtonForward Button = Button9
)

type Key

type Key int

Key represents a keyboard key.

const (
	KeyNone Key = 0

	KeyInsert      Key = 1
	KeyMenu        Key = 2
	KeyPrintScreen Key = 3
	KeyPause       Key = 4
	KeyCapsLock    Key = 5
	KeyScrollLock  Key = 6
	KeyNumLock     Key = 7
	KeyBackspace   Key = 8
	KeyTab         Key = 9
	KeyEnter       Key = 10
	KeyEscape      Key = 11

	KeyUp       Key = 12
	KeyDown     Key = 13
	KeyLeft     Key = 14
	KeyRight    Key = 15
	KeyPageUp   Key = 16
	KeyPageDown Key = 17
	KeyHome     Key = 18
	KeyEnd      Key = 19

	KeyLeftShift    Key = 20
	KeyRightShift   Key = 21
	KeyLeftControl  Key = 22
	KeyRightControl Key = 23
	KeyLeftAlt      Key = 24
	KeyRightAlt     Key = 25
	KeyLeftMeta     Key = 26
	KeyRightMeta    Key = 27
	KeyLeftSuper    Key = 28
	KeyRightSuper   Key = 29
	KeyLeftHyper    Key = 30
	KeyRightHyper   Key = 31

	KeyDelete Key = 127

	KeyDead Key = 128

	KeyF1  Key = 129
	KeyF2  Key = 130
	KeyF3  Key = 131
	KeyF4  Key = 132
	KeyF5  Key = 133
	KeyF6  Key = 134
	KeyF7  Key = 135
	KeyF8  Key = 136
	KeyF9  Key = 137
	KeyF10 Key = 138
	KeyF11 Key = 139
	KeyF12 Key = 140
	KeyF13 Key = 141
	KeyF14 Key = 142
	KeyF15 Key = 143
	KeyF16 Key = 144
	KeyF17 Key = 145
	KeyF18 Key = 146
	KeyF19 Key = 147
	KeyF20 Key = 148
	KeyF21 Key = 149
	KeyF22 Key = 150
	KeyF23 Key = 151
	KeyF24 Key = 152
)

func (Key) Printable

func (key Key) Printable() (printable bool)

Printable returns whether or not the key's character could show up on screen. If this function returns true, the key can be cast to a rune and used as such.

type Modifiers

type Modifiers struct {
	Shift   bool
	Control bool
	Alt     bool
	Meta    bool
	Super   bool
	Hyper   bool
}

Modifiers lists what modifier keys are being pressed. These should be used instead of attempting to track the state of the modifier keys, because there is no guarantee that one press event will be coupled with one release event.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL