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 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.
See also
Class Hierarchy¶
Methods Summary¶
Returns the child that has the focus, or |
|
Returns |
|
Returns |
|
Returns |
|
Sets the current focus window member. |
|
Sets the direction to forward if direction is |
|
Sets the flags for this event. |
|
Marks the navigation event as from a tab key. |
|
Marks the event as a window change event. |
Properties Summary¶
See |
|
See |
Class API¶
- class wx.NavigationKeyEvent(Event)¶
Possible constructors:
NavigationKeyEvent() -> None NavigationKeyEvent(event) -> None
This event class contains information about navigation events, generated by navigation keys such as tab and page down.
Methods¶
- __init__(self, *args, **kw)¶
-
__init__ (self)
- Return type:
None
__init__ (self, event)
- Parameters:
event (wx.NavigationKeyEvent)
- Return type:
None
- 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)
- Return type:
None
- SetDirection(self, direction)¶
Sets the direction to forward if direction is
True
, or backward ifFalse
.- Parameters:
direction (bool)
- Return type:
None
- SetFlags(self, flags)¶
Sets the flags for this event.
The flags can be a combination of the
NavigationKeyEvent.__init__
values.- Parameters:
flags (long)
- Return type:
None
- SetFromTab(self, fromTab)¶
Marks the navigation event as from a tab key.
- Parameters:
fromTab (bool)
- Return type:
None
- SetWindowChange(self, windowChange)¶
Marks the event as a window change event.
- Parameters:
windowChange (bool)
- Return type:
None
Properties¶
- CurrentFocus¶
See
GetCurrentFocus
andSetCurrentFocus
- Direction¶
See
GetDirection
andSetDirection