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 wx.NavigationKeyEvent handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from NavigationEnabled<>.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.NavigationKeyEvent parameter.

  • EVT_NAVIGATION_KEY: Process a navigation key event.


class_hierarchy Class Hierarchy

Inheritance diagram for class NavigationKeyEvent:

method_summary Methods Summary

__init__

GetCurrentFocus

Returns the child that has the focus, or None.

GetDirection

Returns True if the navigation was in the forward direction.

IsFromTab

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

IsWindowChange

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

SetCurrentFocus

Sets the current focus window member.

SetDirection

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

SetFlags

Sets the flags for this event.

SetFromTab

Marks the navigation event as from a tab key.

SetWindowChange

Marks the event as a window change event.


property_summary Properties Summary

CurrentFocus

See GetCurrentFocus and SetCurrentFocus

Direction

See GetDirection and SetDirection


api Class API

class wx.NavigationKeyEvent(Event)

Possible constructors:

NavigationKeyEvent()

NavigationKeyEvent(event)

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

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)



__init__ (self, event)

Parameters

event (wx.NavigationKeyEvent) –



GetCurrentFocus(self)

Returns the child that has the focus, or None.

Return type

wx.Window

GetDirection(self)

Returns True if the navigation was in the forward direction.

Return type

bool

IsFromTab(self)

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

This is required for proper navigation over radio buttons.

Return type

bool

IsWindowChange(self)

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

Return type

bool

SetCurrentFocus(self, currentFocus)

Sets the current focus window member.

Parameters

currentFocus (wx.Window) –

SetDirection(self, direction)

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

Parameters

direction (bool) –

SetFlags(self, flags)

Sets the flags for this event.

The flags can be a combination of the NavigationKeyEvent.__init__ values.

Parameters

flags (long) –

SetFromTab(self, fromTab)

Marks the navigation event as from a tab key.

Parameters

fromTab (bool) –

SetWindowChange(self, windowChange)

Marks the event as a window change event.

Parameters

windowChange (bool) –

CurrentFocus

See GetCurrentFocus and SetCurrentFocus

Direction

See GetDirection and SetDirection