.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


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

.. js:class:: wv.Event.MouseInputEventBase

   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Event.MouseInputEventBase.viewKey`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Event.MouseInputEventBase.altDown`
   * :js:meth:`~wv.Event.MouseInputEventBase.commandDown`
   * :js:meth:`~wv.Event.MouseInputEventBase.controlDown`
   * :js:meth:`~wv.Event.MouseInputEventBase.getDate`
   * :js:meth:`~wv.Event.MouseInputEventBase.getEventType`
   * :js:meth:`~wv.Event.MouseInputEventBase.getHandled`
   * :js:meth:`~wv.Event.MouseInputEventBase.getModifiers`
   * :js:meth:`~wv.Event.MouseInputEventBase.getPosition`
   * :js:meth:`~wv.Event.MouseInputEventBase.setHandled`
   * :js:meth:`~wv.Event.MouseInputEventBase.shiftDown`
   
   



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: wv.Event.MouseInputEventBase.viewKey

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | *get* viewKey(): :js:data:`ViewKey <wv.Sc.ViewKey>`
      
      Get the ViewKey this event is associated with.
      
      **Returns**\ : :js:data:`ViewKey <wv.Sc.ViewKey>`
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: wv.Event.MouseInputEventBase.altDown

      .. rst-class:: sig-pretty-signature
      
         | altDown(): *boolean*
      
      gets the state of the alt key
      
      **Returns**\ : *boolean*
      
      
         whether the alt key was down when this event was generated
      
      



.. js:method:: wv.Event.MouseInputEventBase.commandDown

      .. rst-class:: sig-pretty-signature
      
         | commandDown(): *boolean*
      
      gets the state of the command key
      
      **Returns**\ : *boolean*
      
      
         whether the command key was down when this event was generated
      
      



.. js:method:: wv.Event.MouseInputEventBase.controlDown

      .. rst-class:: sig-pretty-signature
      
         | controlDown(): *boolean*
      
      gets the state of the control key
      
      **Returns**\ : *boolean*
      
      
         whether the control key was down when this event was generated
      
      



.. js:method:: wv.Event.MouseInputEventBase.getDate

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getDate(): *Date*
      
      Gets the Date this event occurred
      
      **Returns**\ : *Date*
      
      
         the event Date
      
      



.. js:method:: wv.Event.MouseInputEventBase.getEventType

      .. rst-class:: sig-pretty-signature
      
         | getEventType(): :js:data:`MouseInputType <wv.MouseInputType>`
      
      gets the event type
      
      **Returns**\ : :js:data:`MouseInputType <wv.MouseInputType>`
      
      
         the type of mouse event
      
      



.. js:method:: wv.Event.MouseInputEventBase.getHandled

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getHandled(): *boolean*
      
      Gets the handled state of the event
      
      **Returns**\ : *boolean*
      
      
         whether the event has been handled
      
      



.. js:method:: wv.Event.MouseInputEventBase.getModifiers

      .. rst-class:: sig-pretty-signature
      
         | getModifiers(): :js:data:`KeyModifiers <wv.KeyModifiers>`
      
      gets the event modifiers
      
      **Returns**\ : :js:data:`KeyModifiers <wv.KeyModifiers>`
      
      
         bitwise combination of KeyModifiers
      
      



.. js:method:: wv.Event.MouseInputEventBase.getPosition

      .. rst-class:: sig-pretty-signature
      
         | getPosition(): :js:class:`Point2 <wv.Point2>`
      
      gets the window position of the mouse pointer for this event
      
      **Returns**\ : :js:class:`Point2 <wv.Point2>`
      
      
         the mouse position for this event
      
      



.. js:method:: wv.Event.MouseInputEventBase.setHandled

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setHandled(**handled**\ : *boolean*\ ): *void*
      
      Sets the handled state of the event. When an event has been handled it will not propagate any further
      
      **Parameters**
      
      
         **handled**\ : *boolean*
      
      
            Indicates whether this event has been handled.
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Event.MouseInputEventBase.shiftDown

      .. rst-class:: sig-pretty-signature
      
         | shiftDown(): *boolean*
      
      gets the state of the shift key
      
      **Returns**\ : *boolean*
      
      
         whether the shift key was down when this event was generated
      
      




