.. role:: ts-api-decorator

###################
MouseInputEventBase
###################

.. js:module:: Event
   :noindex:

.. container:: ts-api-section

   .. js:class:: MouseInputEventBase



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~Event.MouseInputEventBase.viewKey`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Event.MouseInputEventBase.altDown`
   * :js:meth:`~Event.MouseInputEventBase.commandDown`
   * :js:meth:`~Event.MouseInputEventBase.controlDown`
   * :js:meth:`~Event.MouseInputEventBase.getDate`
   * :js:meth:`~Event.MouseInputEventBase.getEventType`
   * :js:meth:`~Event.MouseInputEventBase.getHandled`
   * :js:meth:`~Event.MouseInputEventBase.getModifiers`
   * :js:meth:`~Event.MouseInputEventBase.getPosition`
   * :js:meth:`~Event.MouseInputEventBase.setHandled`
   * :js:meth:`~Event.MouseInputEventBase.shiftDown`





------------

Accessors
=========

.. container:: ts-api-section

   .. js:function:: viewKey()
      :noindex:



      Get the ViewKey this event is associated with.


      :rtype: ViewKey



Methods
=======

.. rst-class:: ts-api-section

altDown
-------

.. js:method:: MouseInputEventBase.altDown()



   gets the state of the alt key

   :returns: whether the alt key was down when this event was generated


   :rtype: boolean

.. rst-class:: ts-api-section

commandDown
-----------

.. js:method:: MouseInputEventBase.commandDown()



   gets the state of the command key

   :returns: whether the command key was down when this event was generated


   :rtype: boolean

.. rst-class:: ts-api-section

controlDown
-----------

.. js:method:: MouseInputEventBase.controlDown()



   gets the state of the control key

   :returns: whether the control key was down when this event was generated


   :rtype: boolean

.. rst-class:: ts-api-section

getDate
-------

.. js:method:: MouseInputEventBase.getDate()



   Gets the Date this event occurred

   :returns: the event Date


   :rtype: Date

.. rst-class:: ts-api-section

getEventType
------------

.. js:method:: MouseInputEventBase.getEventType()



   gets the event type

   :returns: the type of mouse event


   :rtype: MouseInputType

.. rst-class:: ts-api-section

getHandled
----------

.. js:method:: MouseInputEventBase.getHandled()



   Gets the handled state of the event

   :returns: whether the event has been handled


   :rtype: boolean

.. rst-class:: ts-api-section

getModifiers
------------

.. js:method:: MouseInputEventBase.getModifiers()



   gets the event modifiers

   :returns: bitwise combination of KeyModifiers


   :rtype: KeyModifiers

.. rst-class:: ts-api-section

getPosition
-----------

.. js:method:: MouseInputEventBase.getPosition()



   gets the window position of the mouse pointer for this event

   :returns: the mouse position for this event


   :rtype: Point2

.. rst-class:: ts-api-section

setHandled
----------

.. js:method:: MouseInputEventBase.setHandled( handled)

   :param handled: Indicates whether this event has been handled.
   :type handled: boolean


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


   :rtype: void

.. rst-class:: ts-api-section

shiftDown
---------

.. js:method:: MouseInputEventBase.shiftDown()



   gets the state of the shift key

   :returns: whether the shift key was down when this event was generated


   :rtype: boolean

