
##########
InputEvent
##########

.. js:class:: Event.InputEvent

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Event.InputEvent.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Event.InputEvent.viewKey`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Event.InputEvent.getDate`
   * :js:meth:`~Event.InputEvent.getHandled`
   * :js:meth:`~Event.InputEvent.setHandled`
   
   




Constructors
============

.. js:method:: Event.InputEvent.constructor

   .. rst-class:: sig-pretty-signature
   
      | InputEvent(**viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>`\ ?): :js:class:`InputEvent <Event.InputEvent>`
   
   **Parameters**
   
      **viewKey**\ : :js:data:`ViewKey <Sc.ViewKey>` = ViewKey.Default
   
         key for the View the event is occurring in
   
   
   
   **Returns**\ : :js:class:`InputEvent <Event.InputEvent>`
   





Accessors
=========

.. js:method:: Event.InputEvent.viewKey

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





Methods
=======

.. js:method:: Event.InputEvent.getDate

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



.. js:method:: Event.InputEvent.getHandled

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



.. js:method:: Event.InputEvent.setHandled

   .. 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*
   





