*********************
wx.NavigationKeyEvent
*********************

Inheritance diagram for `wx.NavigationKeyEvent`:

|

.. inheritance-diagram:: wx.NavigationKeyEvent

|

Description
===========

``wx.EVT_NAVIGATION_KEY`` events are used to control moving the focus between widgets, otherwise known as tab-traversal. You would normally not catch navigation events 
in applications as there are already appropriate handlers in `wx.Dialog <../Widgets/wx.Dialog.html>`_ and `wx.Panel <../Widgets/wx.Panel.html>`_, but you may find it 
useful to send navigation events in certain situations to change the focus in certain ways, although it's probably easier to just call 
`wx.Window.Navigate <../Widgets/wx.Window.Navigate.html>`_.


Derived From
^^^^^^^^^^^^^

* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetCurrentFocus <#GetCurrentFocus>`_ 
* `GetDirection <#GetDirection>`_ 
* `IsFromTab <#IsFromTab>`_ 
* `IsWindowChange <#IsWindowChange>`_ 
* `SetCurrentFocus <#SetCurrentFocus>`_ 
* `SetDirection <#SetDirection>`_ 
* `SetFlags <#SetFlags>`_ 
* `SetFromTab <#SetFromTab>`_ 
* `SetWindowChange <#SetWindowChange>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `CurrentFocus <#CurrentFocus>`_ 
* `Direction <#Direction>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


.. method:: GetCurrentFocus()

   Returns the child window which currenty has the focus. May be ``None``.

   |

   **Returns:**

   `wx.Window <../Widgets/wx.Window.html>`_
 

--------

.. method:: GetDirection()

   Returns ``True`` if the direction is forward, ``False`` otherwise.

   |

   **Returns:**

   `bool` 

--------

.. method:: IsFromTab()

   Returns ``True`` if the navigation event is originated from the ``Tab`` key.

   |

   **Returns:**

   `bool` 

--------

.. method:: IsWindowChange()

   Returns ``True`` if window change is allowed.

   |

   **Returns:**

   `bool` 

--------

.. method:: SetCurrentFocus(win)

   Set the window that has the focus.

   **Parameters:**

   * `win` (`wx.Window <../Widgets/wx.Window.html>`_)


--------

.. method:: SetDirection(forward)

   Specify the direction that the navigation should take. Usually the
   difference between using ``Tab`` and ``Shift-Tab``.

   **Parameters:**

   * `forward` (bool)


--------

.. method:: SetFlags(flags)

   Set the navigation flags to a combination of the following:
   
   * ``wx.NavigationKeyEvent.IsBackward``
   * ``wx.NavigationKeyEvent.IsForward``
   * ``wx.NavigationKeyEvent.WinChange``
   * ``wx.NavigationKeyEvent.FromTab``

   **Parameters:**

   * `flags` (long)


--------

.. method:: SetFromTab(bIs)

   Set to true under MSW if the event was generated using the ``Tab`` key.

   This is required for proper navigation over radio buttons.

   **Parameters:**

   * `bIs` (bool)


--------

.. method:: SetWindowChange(ischange)

   Specify if the navigation should be able to change parent windows.
   For example, changing notebook pages, etc...

   This is usually implemented by using ``Ctrl-Tab``.

   **Parameters:**

   * `ischange` (bool)


--------

Properties
^^^^^^^^^^


.. attribute:: CurrentFocus

   See `GetCurrentFocus <#GetCurrentFocus>`_ and `SetCurrentFocus <#SetCurrentFocus>`_

.. attribute:: Direction

   See `GetDirection <#GetDirection>`_ and `SetDirection <#SetDirection>`_