Class: Toybox.WatchUi.KeyEvent

Inherits:

Toybox.Lang.Object

• Toybox.Lang.Object
• Toybox.WatchUi.KeyEvent

Overview

KeyEvent is an object sent to an InputDelegate when a physical button on the device is pressed.

See Also:

• Toybox.WatchUi.InputDelegate

Example:

using Toybox.System;
using Toybox.WatchUi;

class InputDelegate extends WatchUi.BehaviorDelegate {
    function onKey(keyEvent) {
        System.println(keyEvent.getKey());  // e.g. KEY_MENU = 7
        System.println(keyEvent.getType()); // e.g. PRESS_TYPE_DOWN = 0
        return true;
    }
}

Since:

API Level 1.0.0

Instance Method Summary

• getKey() as WatchUi.Key

  Get the key value of this event.

• getType() as WatchUi.KeyPressType

  Get the type of click event.

Instance Method Details

getKey() as WatchUi.Key

Get the key value of this event.

Returns:

• WatchUi.Key —

  A WatchUi.KEY_* value

Since:

API Level 1.0.0

getType() as WatchUi.KeyPressType

Get the type of click event.

Returns:

• WatchUi.KeyPressType —

  A WatchUi.PRESS_TYPE_* value

Since:

API Level 1.1.2