MouseWheelInputEvent

class Communicator.Event.MouseWheelInputEvent()

Methods

altDown
commandDown
controlDown
getButtons
getDate
getEventType
getHandled
getModifiers
getPosition
getWheelDelta
setHandled
shiftDown

Methods

altDown

MouseWheelInputEvent.altDown()

gets the state of the alt key

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

commandDown

MouseWheelInputEvent.commandDown()

gets the state of the command key

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

controlDown

MouseWheelInputEvent.controlDown()

gets the state of the control key

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

getButtons

MouseWheelInputEvent.getButtons()

gets the mouse buttons currently pressed with this event

Return type: Buttons
Returns: the mouse buttons currently pressed for this event

getDate

MouseWheelInputEvent.getDate()

Gets the Date this event occurred

Return type: Date
Returns: the event Date

getEventType

MouseWheelInputEvent.getEventType()

gets the event type

Return type: MouseInputType
Returns: the type of mouse event

getHandled

MouseWheelInputEvent.getHandled()

Gets the handled state of the event

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

getModifiers

MouseWheelInputEvent.getModifiers()

gets the event modifiers

Return type: KeyModifiers
Returns: bitwise combination of KeyModifiers

getPosition

MouseWheelInputEvent.getPosition()

gets the window position of the mouse pointer for this event

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

getWheelDelta

MouseWheelInputEvent.getWheelDelta()

Gets the wheel delta for this event. A positive value indicates that the wheel was scrolled Up, while a negative value indicated the wheel was scrolled down.

Return type: number
Returns: Wheel dela value

setHandled

MouseWheelInputEvent.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

MouseWheelInputEvent.shiftDown()

gets the state of the shift key

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