key-was-down-p

Arguments: virtual-key-code

Returns two values indicating whether a particular key on the keyboard was pressed at the time the event currently being handled occurred. The argument should be either the char-int of some graphic character or the value of one of the symbols beginning with vk-. This check is done asynchronously.

The first value indicates whether the key was down when the current event occurred. The second returned value indicates whether the key is toggled. A key is toggled if it has been pressed an odd number of times. For keys such as CAPS LOCK and NUM LOCK, this indicates whether the key is on.

For a letter key, the key code is the char-int of the uppercase character shown on the key (and NOT the corresponding lowercase character). For a numeral key, it is the char-int of the numeral character. For any other key, the key code is the value of the vk- constant for that key (see key-names for a list of vk- constants); for keys that show both a shifted character and an unshifted character, this constant will be named after the unshifted character.

GTK Note

The second value (which indicates whether the key has been pressed since the previous call) is not returned on GTK.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.