@@ -31,7 +31,9 @@ import (
3131// high bit set, or in some cases, by sending an ESC prior to the rune.)
3232//
3333// If the value of Key() is KeyRune, then the actual key value will be
34- // available with the Rune() method. This will be the case for most keys.
34+ // available (as a grapheme cluster) with the Str() method.
35+ // This will be the case for most keys.
36+ //
3537// In most situations, the modifiers will not be set. For example, if the
3638// rune is 'A', this will be reported without the ModShift bit set, since
3739// really can't tell if the Shift key was pressed (it might have been CAPSLOCK,
@@ -66,7 +68,7 @@ func (ev *EventKey) Str() string {
6668// codes, such as KeyEnter, etc. Most control and function keys are reported
6769// with unique Key values. Normal alphanumeric and punctuation keys will
6870// generally return KeyRune here; the specific key can be further decoded
69- // using the Rune () function.
71+ // using the Str () function.
7072func (ev * EventKey ) Key () Key {
7173 return ev .key
7274}
@@ -328,7 +330,7 @@ const (
328330// Key is a generic value for representing keys, and especially special
329331// keys (function keys, cursor movement keys, etc.) For normal keys, like
330332// ASCII letters, we use KeyRune, and then expect the application to
331- // inspect the Rune () member of the EventKey.
333+ // inspect the Str () member of the EventKey.
332334type Key int16
333335
334336// This is the list of named keys. KeyRune is special however, in that it is
0 commit comments