MouseInputEventBase

class Communicator.Event.MouseInputEventBase()

Methods

altDown

MouseInputEventBase.altDown()

gets the state of the alt key

Return type

boolean

Returns

whether the alt key was down when this event was generated

commandDown

MouseInputEventBase.commandDown()

gets the state of the command key

Return type

boolean

Returns

whether the command key was down when this event was generated

controlDown

MouseInputEventBase.controlDown()

gets the state of the control key

Return type

boolean

Returns

whether the control key was down when this event was generated

getDate

MouseInputEventBase.getDate()

Gets the Date this event occurred

Return type

Date

Returns

the event Date

getEventType

MouseInputEventBase.getEventType()

gets the event type

Return type

MouseInputType

Returns

the type of mouse event

getHandled

MouseInputEventBase.getHandled()

Gets the handled state of the event

Return type

boolean

Returns

whether the event has been handled

getModifiers

MouseInputEventBase.getModifiers()

gets the event modifiers

Return type

KeyModifiers

Returns

bitwise combination of KeyModifiers

getPosition

MouseInputEventBase.getPosition()

gets the window position of the mouse pointer for this event

Return type

Point2()

Returns

the mouse position for this event

setHandled

MouseInputEventBase.setHandled(handled)

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

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

Return type

void

shiftDown

MouseInputEventBase.shiftDown()

gets the state of the shift key

Return type

boolean

Returns

whether the shift key was down when this event was generated