.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.NavigationKeyEvent:
==========================================================================================================================================
|phoenix_title| **wx.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:`wx.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:`wx.NavigationKeyEvent` parameter.
- EVT_NAVIGATION_KEY: Process a navigation key event.
.. seealso:: :meth:`wx.Window.Navigate` , :meth:`wx.Window.NavigateIn`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
NavigationKeyEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.NavigationKeyEvent.__init__`
:meth:`~wx.NavigationKeyEvent.GetCurrentFocus` Returns the child that has the focus, or ``None``.
:meth:`~wx.NavigationKeyEvent.GetDirection` Returns ``True`` if the navigation was in the forward direction.
:meth:`~wx.NavigationKeyEvent.IsFromTab` Returns ``True`` if the navigation event was from a tab key.
:meth:`~wx.NavigationKeyEvent.IsWindowChange` Returns ``True`` if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook).
:meth:`~wx.NavigationKeyEvent.SetCurrentFocus` Sets the current focus window member.
:meth:`~wx.NavigationKeyEvent.SetDirection` Sets the direction to forward if `direction` is ``True``, or backward if ``False``.
:meth:`~wx.NavigationKeyEvent.SetFlags` Sets the flags for this event.
:meth:`~wx.NavigationKeyEvent.SetFromTab` Marks the navigation event as from a tab key.
:meth:`~wx.NavigationKeyEvent.SetWindowChange` Marks the event as a window change event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.NavigationKeyEvent.CurrentFocus` See :meth:`~wx.NavigationKeyEvent.GetCurrentFocus` and :meth:`~wx.NavigationKeyEvent.SetCurrentFocus`
:attr:`~wx.NavigationKeyEvent.Direction` See :meth:`~wx.NavigationKeyEvent.GetDirection` and :meth:`~wx.NavigationKeyEvent.SetDirection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.NavigationKeyEvent(Event)
**Possible constructors**::
NavigationKeyEvent() -> None
NavigationKeyEvent(event : NavigationKeyEvent) -> None
This event class contains information about navigation events,
generated by navigation keys such as tab and page down.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
:rtype: `None`
:html:`
`
**__init__** `(self, event : NavigationKeyEvent)`
:param `event`:
:type `event`: wx.NavigationKeyEvent
:rtype: `None`
:html:`
`
.. method:: GetCurrentFocus(self)
Returns the child that has the focus, or ``None``.
:rtype: :ref:`wx.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 : Window)
Sets the current focus window member.
:param `currentFocus`:
:type `currentFocus`: wx.Window
:rtype: `None`
.. method:: SetDirection(self, direction : bool)
Sets the direction to forward if `direction` is ``True``, or backward if ``False``.
:param `direction`:
:type `direction`: bool
:rtype: `None`
.. method:: SetFlags(self, flags : int)
Sets the flags for this event.
The `flags` can be a combination of the :meth:`NavigationKeyEvent.__init__` values.
:param `flags`:
:type `flags`: long
:rtype: `None`
.. method:: SetFromTab(self, fromTab : bool)
Marks the navigation event as from a tab key.
:param `fromTab`:
:type `fromTab`: bool
:rtype: `None`
.. method:: SetWindowChange(self, windowChange : bool)
Marks the event as a window change event.
:param `windowChange`:
:type `windowChange`: bool
:rtype: `None`
.. attribute:: CurrentFocus
See :meth:`~wx.NavigationKeyEvent.GetCurrentFocus` and :meth:`~wx.NavigationKeyEvent.SetCurrentFocus`
.. attribute:: Direction
See :meth:`~wx.NavigationKeyEvent.GetDirection` and :meth:`~wx.NavigationKeyEvent.SetDirection`
.. toctree::
:maxdepth: 1
:hidden:
wx.NavigationKeyEvent.NavigationKeyEventFlags.enumeration