OnKeyListener
interface OnKeyListener
| android.view.View.OnKeyListener |
Interface definition for a callback to be invoked when a hardware key event is dispatched to this view. The callback will be invoked before the key event is given to the view. This is only useful for hardware keyboards; a software input method has no obligation to trigger this listener.
Summary
| Public methods | |
|---|---|
| abstract Boolean |
Called when a hardware key is dispatched to a view. |
Public methods
onKey
abstract fun onKey(
v: View!,
keyCode: Int,
event: KeyEvent!
): Boolean
Called when a hardware key is dispatched to a view. This allows listeners to get a chance to respond before the target view.
Key presses in software keyboards will generally NOT trigger this method, although some may elect to do so in some situations. Do not assume a software input method has to be key-based; even if it is, it may use key presses in a different way than you expect, so there is no way to reliably catch soft input key presses.
| Parameters | |
|---|---|
v |
View!: The view the key has been dispatched to. |
keyCode |
Int: The code for the physical key that was pressed |
event |
KeyEvent!: The KeyEvent object containing full information about the event. |
| Return | |
|---|---|
Boolean |
True if the listener has consumed the event, false otherwise. |