Type Event Dispatch chain ▸ Runtime Revision Current Public Release (2016.2992) Keywords key
Key events occur when a keyboard key or gamepad/joystick button has been pressed down or released.
In your key event listener, you can return
true to indicate that your app will be handling the received key and overriding the operating system's default behavior. For example, on Android, returning
true for the back key will prevent the operating system from backing out of your app.
false in the key event listener indicates that your app is not overriding the key and allows the operating system to execute its default behavior.
In the Corona Simulator, you can simulate a back key event while simulating an Android or Windows Phone device via the
"back": one with event.phase equal to
"down" and the other
"up". Note that if you do not return
true on the
"up" phase to override the key, the Corona Simulator will exit the app, just like how it works on a real device.
Android raises key events for all keyboard keys, navigation buttons, volume buttons, and gamepad/joystick buttons. Android does not raise key events for the Home navigation button, Task Manager button, or Power button.
Only supports key events from an MFi game controller (guide). Does not support key events from a keyboard.
The Corona Simulator for OS X and OS X desktop apps support all keyboard keys and gamepad/joystick buttons. Note that the Corona Simulator will provide key events when simulating an iOS device, however iOS itself does not support key events.
The Corona Simulator for Windows and Win32 desktop apps support all keyboard keys. The Corona Simulator for Windows only provides key events when simulating an Android or Windows Phone device, as iOS does not support key events.
Only the back key is supported on Windows Phone.
Key events will not be received if a native object such as a TextField, TextBox, or WebView handles them. This can only happen if these native objects have the focus and if they choose to override that key. For example, a TextField and TextBox typically handles all keyboard keys, preventing the application from receiving those key events, but will not handle a back key event.