Android Guides | Samples

Android.Views.KeyEventFlags Enumeration

Enumerates values returned by several types and taken as a parameter of several methods of KeyEvent.

Syntax

[System.Flags]
public enum KeyEventFlags

Remarks

Members

Member NameDescription
CanceledWhen associated with up key events, this indicates that the key press has been canceled. Typically this is used with virtual touch screen keys, where the user can slide from the virtual key area on to the display: in that case, the application will receive a canceled up event and should not perform the action normally associated with the key. Note that for this to work, the application can not perform an action for a key until it receives an up or the long press timeout has expired.
CanceledLongPressSet when a key event has KeyEventFlags.Canceled set because a long press action was executed while it was down.
EditorActionThis mask is used for compatibility, to identify enter keys that are coming from an IME whose enter key has been auto-labelled "next" or "done". This allows TextView to dispatch these as normal enter keys for old applications, but still do the appropriate action when receiving them.
FallbackSet when a key event has been synthesized to implement default behavior for an event that the application did not handle. Fallback key events are generated by unhandled trackball motions (to emulate a directional keypad) and by certain unhandled key presses that are declared in the key map (such as special function numeric keypad keys when numlock is off).
FromSystemThis mask is set if an event was known to come from a trusted part of the system. That is, the event is known to come from the user, and could not have been spoofed by a third party component.
KeepTouchModeThis mask is set if we don't want the key event to cause us to leave touch mode.
LongPressThis flag is set for the first key repeat that occurs after the long press timeout.
SoftKeyboardThis mask is set if the key event was generated by a software keyboard.
TrackingSet for KeyEventActions.Up when this event's key code is still being tracked from its initial down. That is, somebody requested that tracking started on the key down and a long press has not caused the tracking to be canceled.
VirtualHardKeyThis key event was generated by a virtual (on-screen) hard key area. Typically this is an area of the touchscreen, outside of the regular display, dedicated to "hardware" buttons.
WokeHereThis mask is set if the device woke because of this key event.

Requirements

Namespace: Android.Views
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0

The members of Android.Views.KeyEventFlags are listed below.

See Also: Enum

Public Fields

CanceledKeyEventFlags. When associated with up key events, this indicates that the key press has been canceled. Typically this is used with virtual touch screen keys, where the user can slide from the virtual key area on to the display: in that case, the application will receive a canceled up event and should not perform the action normally associated with the key. Note that for this to work, the application can not perform an action for a key until it receives an up or the long press timeout has expired.
CanceledLongPressKeyEventFlags. Set when a key event has KeyEventFlags.Canceled set because a long press action was executed while it was down.
EditorActionKeyEventFlags. This mask is used for compatibility, to identify enter keys that are coming from an IME whose enter key has been auto-labelled "next" or "done". This allows TextView to dispatch these as normal enter keys for old applications, but still do the appropriate action when receiving them.
FallbackKeyEventFlags. Set when a key event has been synthesized to implement default behavior for an event that the application did not handle. Fallback key events are generated by unhandled trackball motions (to emulate a directional keypad) and by certain unhandled key presses that are declared in the key map (such as special function numeric keypad keys when numlock is off).
FromSystemKeyEventFlags. This mask is set if an event was known to come from a trusted part of the system. That is, the event is known to come from the user, and could not have been spoofed by a third party component.
KeepTouchModeKeyEventFlags. This mask is set if we don't want the key event to cause us to leave touch mode.
LongPressKeyEventFlags. This flag is set for the first key repeat that occurs after the long press timeout.
SoftKeyboardKeyEventFlags. This mask is set if the key event was generated by a software keyboard.
TrackingKeyEventFlags. Set for KeyEventActions.Up when this event's key code is still being tracked from its initial down. That is, somebody requested that tracking started on the key down and a long press has not caused the tracking to be canceled.
VirtualHardKeyKeyEventFlags. This key event was generated by a virtual (on-screen) hard key area. Typically this is an area of the touchscreen, outside of the regular display, dedicated to "hardware" buttons.
WokeHereKeyEventFlags. This mask is set if the device woke because of this key event.