Mouse Event

This table describes all fields of mouse-related component events.

Field

Name

Type

Description

ID

id

Integer

Event type ID.

When

when

Date

Event timestamp.

Modifiers

modifiers

Integer

The modifier mask for this event. Modifiers represent the state of all modal keys, such as ALT, CTRL, META, just after the event occurred. This value is a bitwise OR of the following constants:

  • 1 - Shift key
  • 2 - Control key
  • 4 - Meta key
  • 8 - Alt key
  • 32 - Alt Graph key

Alt Down

altDown

Boolean

True if Alt key was down when an event occurred.

Alt Graph Down

altGraphDown

Boolean

True if Alt Graph key was down when an event occurred.

Control Down

controlDown

Boolean

True if Control key was down when an event occurred.

Shift Down

shiftDown

Boolean

True if Shift key was down when an event occurred.

Meta Down

metaDown

Boolean

True if Meta key was down when an event occurred.

X

x

Integer

The horizontal x position of the event relative to the source component.

Y

y

Integer

The horizontal y position of the event relative to the source component.

X on Screen

xOnScreen

Integer

The absolute horizontal x position of the event. In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, this coordinate is relative to the virtual coordinate system.

Y on Screen

yOnScreen

Integer

The absolute horizontal y position of the event. See note above.

Button

button

Integer

Defines which of the mouse buttons has changed state:

  • 0 - no buttons
  • 1 - button #1
  • 2 - button #2
  • 3 - button #3

Click Count

clickCount

Integer

The number of mouse clicks associated with this event.

Extended Modifiers

modifiersEx

Integer

The extended modifier mask for this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred. This value is a bitwise OR of the following constants:

  • 64 - Shift key
  • 128 - Ctrl key
  • 256 - Meta key
  • 512 - Alt key
  • 1024 - Mouse button 1
  • 2048 - Mouse button 2
  • 4096 - Mouse button 3

Popup Trigger

popupTrigger

Integer

Defines whether or not this mouse event is the popup menu trigger event for the platform.

Was this page helpful?