Android Guides | Samples

Android.Views.MotionEventActions Enumeration

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

Syntax

public enum MotionEventActions

Remarks

Members

Member NameDescription
CancelConstant for MotionEvent.ActionMasked: The current gesture has been aborted. You will not receive any more points in it. You should treat this as an up event, but not perform any action that you normally would.
Down

Constant for MotionEvent.ActionMasked: A pressed gesture has started, the motion contains the initial starting location.

This is also a good time to check the button state to distinguish secondary and tertiary button clicks and handle them appropriately. Use MotionEvent.ButtonState to retrieve the button state.

HoverEnter

Constant for MotionEvent.ActionMasked: The pointer is not down but has entered the boundaries of a window or view.

This action is always delivered to the window or view under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

HoverExit

Constant for MotionEvent.ActionMasked: The pointer is not down but has exited the boundaries of a window or view.

This action is always delivered to the window or view that was previously under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

HoverMove

Constant for MotionEvent.ActionMasked: A change happened but the pointer is not down (unlike MotionEventActions.Move). The motion contains the most recent point, as well as any intermediate points since the last hover move event.

This action is always delivered to the window or view under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

MaskBit mask of the parts of the action code that are the action itself.
MoveConstant for MotionEvent.ActionMasked: A change has happened during a press gesture (between MotionEventActions.Down and MotionEventActions.Up). The motion contains the most recent point, as well as any intermediate points since the last down or move event.
OutsideConstant for MotionEvent.ActionMasked: A movement has happened outside of the normal bounds of the UI element. This does not provide a full gesture, but only the initial location of the movement/touch.
Pointer1Down
Pointer1Up
Pointer2Down
Pointer2Up
Pointer3Down
Pointer3Up
PointerDown

Constant for MotionEvent.ActionMasked: A non-primary pointer has gone down.

Use MotionEvent.ActionIndex to retrieve the index of the pointer that changed.

The index is encoded in the MotionEventActions.PointerIndexMask bits of the unmasked action returned by MotionEvent.Action.

PointerIdMask
PointerIdShift
PointerIndexMaskBits in the action code that represent a pointer index, used with MotionEventActions.PointerDown and MotionEventActions.PointerUp. Shifting down by MotionEventActions.PointerIndexShift provides the actual pointer index where the data for the pointer going up or down can be found; you can get its identifier with MotionEvent.GetPointerId(Int32) and the actual data with MotionEvent.GetX(Int32) etc.
PointerIndexShiftBit shift for the action bits holding the pointer index as defined by MotionEventActions.PointerIndexMask.
PointerUp

Constant for MotionEvent.ActionMasked: A non-primary pointer has gone up.

Use MotionEvent.ActionIndex to retrieve the index of the pointer that changed.

The index is encoded in the MotionEventActions.PointerIndexMask bits of the unmasked action returned by MotionEvent.Action.

Scroll

Constant for MotionEvent.ActionMasked: The motion event contains relative vertical and/or horizontal scroll offsets. Use MotionEvent.GetAxisValue(Axis) to retrieve the information from Axis.Vscroll and Axis.Hscroll. The pointer may or may not be down when this event is dispatched.

This action is always delivered to the window or view under the pointer, which may not be the window or view currently touched.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

UpConstant for MotionEvent.ActionMasked: A pressed gesture has finished, the motion contains the final release location as well as any intermediate points since the last down or move event.

Requirements

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

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

See Also: Enum

Public Fields

CancelMotionEventActions. Constant for MotionEvent.ActionMasked: The current gesture has been aborted. You will not receive any more points in it. You should treat this as an up event, but not perform any action that you normally would.
DownMotionEventActions.

Constant for MotionEvent.ActionMasked: A pressed gesture has started, the motion contains the initial starting location.

This is also a good time to check the button state to distinguish secondary and tertiary button clicks and handle them appropriately. Use MotionEvent.ButtonState to retrieve the button state.

HoverEnterMotionEventActions.

Constant for MotionEvent.ActionMasked: The pointer is not down but has entered the boundaries of a window or view.

This action is always delivered to the window or view under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

HoverExitMotionEventActions.

Constant for MotionEvent.ActionMasked: The pointer is not down but has exited the boundaries of a window or view.

This action is always delivered to the window or view that was previously under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

HoverMoveMotionEventActions.

Constant for MotionEvent.ActionMasked: A change happened but the pointer is not down (unlike MotionEventActions.Move). The motion contains the most recent point, as well as any intermediate points since the last hover move event.

This action is always delivered to the window or view under the pointer.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

MaskMotionEventActions. Bit mask of the parts of the action code that are the action itself.
MoveMotionEventActions. Constant for MotionEvent.ActionMasked: A change has happened during a press gesture (between MotionEventActions.Down and MotionEventActions.Up). The motion contains the most recent point, as well as any intermediate points since the last down or move event.
OutsideMotionEventActions. Constant for MotionEvent.ActionMasked: A movement has happened outside of the normal bounds of the UI element. This does not provide a full gesture, but only the initial location of the movement/touch.
Pointer1DownMotionEventActions.
Pointer1UpMotionEventActions.
Pointer2DownMotionEventActions.
Pointer2UpMotionEventActions.
Pointer3DownMotionEventActions.
Pointer3UpMotionEventActions.
PointerDownMotionEventActions.

Constant for MotionEvent.ActionMasked: A non-primary pointer has gone down.

Use MotionEvent.ActionIndex to retrieve the index of the pointer that changed.

The index is encoded in the MotionEventActions.PointerIndexMask bits of the unmasked action returned by MotionEvent.Action.

PointerIdMaskMotionEventActions.
PointerIdShiftMotionEventActions.
PointerIndexMaskMotionEventActions. Bits in the action code that represent a pointer index, used with MotionEventActions.PointerDown and MotionEventActions.PointerUp. Shifting down by MotionEventActions.PointerIndexShift provides the actual pointer index where the data for the pointer going up or down can be found; you can get its identifier with MotionEvent.GetPointerId(Int32) and the actual data with MotionEvent.GetX(Int32) etc.
PointerIndexShiftMotionEventActions. Bit shift for the action bits holding the pointer index as defined by MotionEventActions.PointerIndexMask.
PointerUpMotionEventActions.

Constant for MotionEvent.ActionMasked: A non-primary pointer has gone up.

Use MotionEvent.ActionIndex to retrieve the index of the pointer that changed.

The index is encoded in the MotionEventActions.PointerIndexMask bits of the unmasked action returned by MotionEvent.Action.

ScrollMotionEventActions.

Constant for MotionEvent.ActionMasked: The motion event contains relative vertical and/or horizontal scroll offsets. Use MotionEvent.GetAxisValue(Axis) to retrieve the information from Axis.Vscroll and Axis.Hscroll. The pointer may or may not be down when this event is dispatched.

This action is always delivered to the window or view under the pointer, which may not be the window or view currently touched.

This action is not a touch event so it is delivered to View.OnGenericMotionEvent(MotionEvent) rather than View.OnTouchEvent(MotionEvent).

UpMotionEventActions. Constant for MotionEvent.ActionMasked: A pressed gesture has finished, the motion contains the final release location as well as any intermediate points since the last down or move event.