KeyPressed (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

To manage all the keyboard keys with KeyPressed:
Running the test of a key combination
Interrupting a process in a browse loop
Asynchronous status report
Using the KeyPressed function
Keys of Pocket PCs and Smartphones

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

KeyPressed (Function)

In french: ToucheEnfoncée

Checks which key is pressed.

Versions 15 and later

This function is now available for Java applications.

New in version 15

This function is now available for Java applications.

Example

// Include the "KeyConst.wl" file to manage the keyboard keys
EXTERN "KeyConst.WL"
FOR I = 1 TO 5000
HourGlass(True)
Multitask(-1)
// Check Space key
IF KeyPressed(VK_SPACE) = True THEN Info("Space key down")
// Check A key
IF KeyPressed(Asc("A")) = True THEN Trace("A key down")
END
HourGlass(False)

// -- Initialization code of project
// Include the "KeyConst.WL" and "WinConst.WL" files
EXTERN "KeyConst.WL"
EXTERN "WinConst.WL"

// -- Initialization code of window
// Intercept the Pocket PC key that is pressed
Event("MoveImage", "Window1.*", WM_KEYDOWN)

// -- "MoveImage" procedure
PROCÉDURE MoveImage()
// Move the "IMG_MyImage" Image control with the arrows of the Smartphone or Pocket PC
// Right arrow: move to the right
IF KeyPressed(VK_RIGHT) THEN IMG_MyImage.X = IMG_MyImage.X + 10
// Left arrow: move to the left
IF KeyPressed(VK_LEFT) THEN IMG_MyImage.X = IMG_MyImage.X - 10
// Up arrow: move to the top
IF KeyPressed(VK_UP) THEN IMG_MyImage.Y = IMG_MyImage.Y + 10
// Down arrow: move to the bottom
IF KeyPressed(VK_DOWN) THEN IMG_MonImage.Y = IMG_MonImage.Y - 10

Syntax

<Result> = KeyPressed(<Constant> [, <Change of status>])

<Result>: Boolean

True if the control key is pressed or if its status changed since the last call to KeyPressed,
False otherwise.
Specific operating mode:
True if the control key is currently pressed,
False otherwise.

<Constant>: Integer constant

Identifies the control key:
kpAlt Alt key.
kpLButton Left mouse button.
This constant is not available.
kpRButton Right mouse button.
This constant is not available.
kpControl Ctrl key.
kpEscape Esc key.
kpShift Shift key.

Additional constants are available in the "KeyConst.wl" file. These constants are used to identify all the keyboard keys. This file is available in the "\Personal\Extern" directory of WINDEV or WINDEV Mobile. See remarks for more details.

<Change of status>: Optional boolean

True (default value) to get a synchronous status: key currently pressed,
False to get an asynchronous status: the key status changed since the last call to KeyPressed.
This parameter is ignored. The status code is always synchronous.

Remarks

To manage all the keyboard keys with KeyPressed:

Include the KeyConst.WL file in your project. This file associates a specific constant with each keyboard key. This file is available in the \Personal\Extern directory of WINDEV. To integrate this file into your applications, it is necessary to use the keyword EXTERN as follows:

EXTERN "KEYCONST.wl"
Use the constants in KeyPressed:

IF KeyPressed(VK_Space) THEN...

Remarks:

To manage the character keys, use the ASCII code of the character (returned by Asc).
All the constants found in the KeyConst.WL file start with the letters VK_. These constants are proposed by the automatic completion in the code editor as soon as the file was included by the EXTERN keyword.

Running the test of a key combination

To run the test of a key combination, run the test of two keys pressed:

IF KeyPressed(kpShift) AND KeyPressed(VK_TAB) THEN
Trace("OK")
END

Interrupting a process in a browse loop

In a loop, to interrupt the process by pressing Esc, Multitask must be called before KeyPressed.

Example:

HReadFirst(Customer, CustNum)
WHILE HOut() = False
// Abandon via Esc?
Multitask(-1)
IF KeyPressed(kpEscape) = True THEN BREAK
// Process
HReadNext(Customer, CustNum)
END

Asynchronous status report

To avoid retrieving a key that was pressed beforehand (in another process for example), the status of the key to test must be reinitialized by the following code line:

KeyPressed(<Key>, False)

Using the KeyPressed function

The application must have focus in order for KeyPressed to check that the specified key is down.

Keys of Pocket PCs and Smartphones

The diagrams below present the WLanguage constants associated with the keys.

Component: wd260std.dll