.. include:: headings.inc



.. _NavigationKeyEvent:

==========================================================================================================================================
|phoenix_title|  **NavigationKeyEvent**
==========================================================================================================================================

This event class contains information about navigation events, generated by navigation keys such as tab and page down.          

This event is mainly used by wxWidgets implementations. A :ref:`NavigationKeyEvent`  handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from NavigationEnabled<>. 





.. _NavigationKeyEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`NavigationKeyEvent` parameter.

- EVT_NAVIGATION_KEY: Process a navigation key event.  








         



.. seealso:: :meth:`Window.Navigate` , :meth:`Window.NavigateIn`     







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **NavigationKeyEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/NavigationKeyEvent_inheritance.png" alt="Inheritance diagram of NavigationKeyEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node4" href="NavigationKeyEvent.html" title="This event class contains information about navigation events, generated by navigation keys such as tab and page down." alt="" coords="247,5,412,35"/> <area shape="rect" id="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~NavigationKeyEvent.__init__`                                             
:meth:`~NavigationKeyEvent.GetCurrentFocus`                                      Returns the child that has the focus, or ``None``.
:meth:`~NavigationKeyEvent.GetDirection`                                         Returns ``True`` if the navigation was in the forward direction.
:meth:`~NavigationKeyEvent.IsFromTab`                                            Returns ``True`` if the navigation event was from a tab key.
:meth:`~NavigationKeyEvent.IsWindowChange`                                       Returns ``True`` if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).
:meth:`~NavigationKeyEvent.SetCurrentFocus`                                      Sets the current focus window member.
:meth:`~NavigationKeyEvent.SetDirection`                                         Sets the direction to forward if `direction`  is ``True``, or backward if ``False``.
:meth:`~NavigationKeyEvent.SetFlags`                                             Sets the flags for this event.
:meth:`~NavigationKeyEvent.SetFromTab`                                           Marks the navigation event as from a tab key.
:meth:`~NavigationKeyEvent.SetWindowChange`                                      Marks the event as a window change event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~NavigationKeyEvent.CurrentFocus`                                         See :meth:`~NavigationKeyEvent.GetCurrentFocus` and :meth:`~NavigationKeyEvent.SetCurrentFocus`
:attr:`~NavigationKeyEvent.Direction`                                            See :meth:`~NavigationKeyEvent.GetDirection` and :meth:`~NavigationKeyEvent.SetDirection`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: NavigationKeyEvent(Event)

   This event class contains information about navigation events, generated by navigation keys such as tab and page down.
   
   **Possible constructors**::

       NavigationKeyEvent()
       
       NavigationKeyEvent(event)
       



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, event)`
      
      
      
      
      :param `event`: 
      :type `event`: NavigationKeyEvent
      
      
      
      
      
      
      **~~~**






   .. method:: GetCurrentFocus(self)

      Returns the child that has the focus, or ``None``.                  

      :rtype: :ref:`Window`








   .. method:: GetDirection(self)

      Returns ``True`` if the navigation was in the forward direction.                  

      :rtype: `bool`








   .. method:: IsFromTab(self)

      Returns ``True`` if the navigation event was from a tab key.                  

      This is required for proper navigation over radio buttons.                  

      :rtype: `bool`








   .. method:: IsWindowChange(self)

      Returns ``True`` if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).                  

      :rtype: `bool`








   .. method:: SetCurrentFocus(self, currentFocus)

      Sets the current focus window member.                  


      :param `currentFocus`: 
      :type `currentFocus`: Window







   .. method:: SetDirection(self, direction)

      Sets the direction to forward if `direction`  is ``True``, or backward if ``False``.                  


      :param `direction`: 
      :type `direction`: bool







   .. method:: SetFlags(self, flags)

      Sets the flags for this event.                  

      The `flags`  can be a combination of the NavigationKeyEventFlags values.                  


      :param `flags`: 
      :type `flags`: long







   .. method:: SetFromTab(self, fromTab)

      Marks the navigation event as from a tab key.                  


      :param `fromTab`: 
      :type `fromTab`: bool







   .. method:: SetWindowChange(self, windowChange)

      Marks the event as a window change event.                  


      :param `windowChange`: 
      :type `windowChange`: bool







   .. attribute:: CurrentFocus

      See :meth:`~NavigationKeyEvent.GetCurrentFocus` and :meth:`~NavigationKeyEvent.SetCurrentFocus`


   .. attribute:: Direction

      See :meth:`~NavigationKeyEvent.GetDirection` and :meth:`~NavigationKeyEvent.SetDirection`