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


#############
KeyInputEvent
#############

.. js:class:: wv.Event.KeyInputEvent

   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Event.KeyInputEvent.viewKey`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Event.KeyInputEvent.getDate`
   * :js:meth:`~wv.Event.KeyInputEvent.getEventType`
   * :js:meth:`~wv.Event.KeyInputEvent.getHandled`
   * :js:meth:`~wv.Event.KeyInputEvent.getKeyCode`
   * :js:meth:`~wv.Event.KeyInputEvent.setHandled`
   
   



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

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


.. js:method:: wv.Event.KeyInputEvent.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.KeyInputEvent.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.KeyInputEvent.getEventType

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



.. js:method:: wv.Event.KeyInputEvent.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.KeyInputEvent.getKeyCode

      .. rst-class:: sig-pretty-signature
      
         | getKeyCode(): *number*
      
      gets the key code
      
      **Returns**\ : *number*
      
      
         the key code of the event
      
      



.. js:method:: wv.Event.KeyInputEvent.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*
      




