KeyEvent

Top  Previous  Next

Message

 

KeyEvent: <key> on|off <document> [<timestamp>]

 

Originator

 

Server

 

Details

 

Notifies the client that a key has been pressed or released on the Server's keyboard (if a document for which a DisplayKeyboardEvents command has been received has the input focus on the server). See the section on DisplayKeyboardEvents.

 

SDK Control

 

WhiskerKeyEvent fires (Visual Basic: calls Control_WhiskerKeyEvent Sub), with the VKey, KeyDown, Document and Time parameters set to the appropriate values.

 

ClientLib

 

virtual CWhiskerTask::IncomingKeyEvent() is called – if your task overrides this function, the override will be called with the iKey, bDown, strDocument and lTime parameters set to the appropriate values.

 

Revision history

 

Implemented in WhiskerServer version 2.

 

Example

 

KeyEvent: 68 on fish

 

See also

 

DisplayKeyboardEvents