wx.NavigationKeyEvent

Inheritance diagram for 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 and wx.Panel, 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.

Derived From

• wx.Event
• wx.Object

Methods Summary

• __init__
• GetCurrentFocus
• GetDirection
• IsFromTab
• IsWindowChange
• SetCurrentFocus
• SetDirection
• SetFlags
• SetFromTab
• SetWindowChange

Properties Summary

• CurrentFocus
• Direction

Class API

Methods

__init__()

No docstrings available for this method.

---

GetCurrentFocus()

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

Returns:

wx.Window

---

GetDirection()

Returns True if the direction is forward, False otherwise.

Returns:

bool

---

IsFromTab()

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

Returns:

bool

---

IsWindowChange()

Returns True if window change is allowed.

Returns:

bool

---

SetCurrentFocus(win)

Set the window that has the focus.

Parameters:

• win (wx.Window)

---

SetDirection(forward)

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

Parameters:

• forward (bool)

---

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)

---

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)

---

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

CurrentFocus

See GetCurrentFocus and SetCurrentFocus

Direction

See GetDirection and SetDirection