ITool.OnKeyDown Method
Called when a key is pressed.
Thread safety: This method does not have to be thread-safe, it will only be called by Carmenta Engine from the GUI thread.
OnKeyDown(System.Int32 key, System.Boolean shift, System.Boolean ctrl, System.Boolean alt)
Called when a key is pressed.Syntax
public System.Boolean OnKeyDown (
System.Int32 key,
System.Boolean shift,
System.Boolean ctrl,
System.Boolean alt
)Parameters
key
Type: System.Int32
The key code of the key that was pressed.
The key code of the key that was pressed.
shift
Type: System.Boolean
True if the SHIFT key was pressed.
True if the SHIFT key was pressed.
ctrl
Type: System.Boolean
True if the CTRL key was pressed.
True if the CTRL key was pressed.
alt
Type: System.Boolean
True if the ALT key was pressed.
True if the ALT key was pressed.
Return Value
Type: System.Boolean
True if the tool handles the event; False otherwise.
True if the tool handles the event; False otherwise.
Platforms
Windows, Linux, Android