MouseInputEventBase

class Event.MouseInputEventBase()

Accessors

  • viewKey

Methods

Accessors

Event.viewKey()

Get the ViewKey this event is associated with.

Return type:ViewKey

Methods

altDown

MouseInputEventBase.altDown()

gets the state of the alt key

Returns:whether the alt key was down when this event was generated
Return type:boolean

commandDown

MouseInputEventBase.commandDown()

gets the state of the command key

Returns:whether the command key was down when this event was generated
Return type:boolean

controlDown

MouseInputEventBase.controlDown()

gets the state of the control key

Returns:whether the control key was down when this event was generated
Return type:boolean

getDate

MouseInputEventBase.getDate()

Gets the Date this event occurred

Returns:the event Date
Return type:Date

getEventType

MouseInputEventBase.getEventType()

gets the event type

Returns:the type of mouse event
Return type:MouseInputType

getHandled

MouseInputEventBase.getHandled()

Gets the handled state of the event

Returns:whether the event has been handled
Return type:boolean

getModifiers

MouseInputEventBase.getModifiers()

gets the event modifiers

Returns:bitwise combination of KeyModifiers
Return type:KeyModifiers

getPosition

MouseInputEventBase.getPosition()

gets the window position of the mouse pointer for this event

Returns:the mouse position for this event
Return type:Point2

setHandled

MouseInputEventBase.setHandled(handled)
Arguments:
  • handled (boolean()) – Indicates whether this event has been handled.

Sets the handled state of the event. When an event has been handled it will not propagate any further

Return type:void

shiftDown

MouseInputEventBase.shiftDown()

gets the state of the shift key

Returns:whether the shift key was down when this event was generated
Return type:boolean