summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2020-11-16 17:23:16 -0500
committerDavid Thompson <dthompson2@worcester.edu>2020-11-16 17:27:10 -0500
commitba0c8932395a05187824ce2835eb33331967a45a (patch)
tree22eaafd293bf1212fb969125e2162740bebf46a3 /doc
parentf2f23c968ccc3e16163ad561cb3395bd2e02f966 (diff)
Remove scancode argument from key-press and key-release handlers.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.texi17
1 files changed, 3 insertions, 14 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 70c3016..cf82b6f 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -75,15 +75,8 @@ the keyboard:
@enumerate
@item
-@var{key}: The symbolic name of the ``virtual'' key that was pressed.
-For example: @code{backspace}. It's called a virtual key because the
-operating system may map a physical keyboard key to another key
-entirely, such as how the author likes to bind the ``caps lock'' key
-to mean ``control''.
-
-@item
-@var{scancode}: The symbolic name of the physical key that was
-pressed.
+@var{key}: The symbolic name of the key that was pressed. For
+example: @code{backspace}.
@item
@var{modifiers}: A list of the symbolic names of modifier keys that
@@ -101,11 +94,7 @@ on the keyboard:
@enumerate
@item
-@var{key}: The symbolic name of the ``virtual'' key that was released.
-
-@item
-@var{scancode}: The symbolic name of the physical key that was
-released.
+@var{key}: The symbolic name of the key that was released.
@item
@var{modifiers}: A list of the symbolic names of modifier keys that