Package wx :: Class NavigationKeyEvent
[frames | no frames]

Type NavigationKeyEvent

object --+        
         |        
    Object --+    
             |    
         Event --+
                 |
                NavigationKeyEvent


EVT_NAVIGATION_KEY events are used to control moving the focus between widgets, otherwise known as tab-traversal. You woudl 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.


Method Summary
NavigationKeyEvent __init__(self)
  __repr__(self)
Window GetCurrentFocus(self)
Returns the child window which currenty has the focus.
bool GetDirection(self)
Returns True if the direction is forward, False otherwise.
bool IsFromTab(self)
Returns True if the navigation event is originated from the Tab key.
bool IsWindowChange(self)
Returns True if window change is allowed.
  SetCurrentFocus(self, win)
Set the window that has the focus.
  SetDirection(self, forward)
Specify the direction that the navigation should take.
  SetFlags(self, flags)
Set the navigation flags to a combination of the following:
  SetFromTab(self, bIs)
Set to true under MSW if the event was generated using the tab key.
  SetWindowChange(self, ischange)
Specify if the navigation should be able to change parent windows.
    Inherited from Event
  __del__(self)
Event Clone(self)
Object GetEventObject(self)
Returns the object (usually a window) associated with the event, if any.
wxEventType GetEventType(self)
Returns the identifier of the given event type, such as wxEVT_COMMAND_BUTTON_CLICKED.
int GetId(self)
Returns the identifier associated with this event, such as a button command id.
bool GetSkipped(self)
Returns true if the event handler should be skipped, false otherwise.
long GetTimestamp(self)
bool IsCommandEvent(self)
Returns true if the event is or is derived from wx.CommandEvent else it returns false.
  ResumePropagation(self, propagationLevel)
Resume the event propagation by restoring the propagation level.
  SetEventObject(self, obj)
Sets the originating object, or in other words, obj is normally the object that is sending the event.
  SetEventType(self, typ)
Sets the specific type of the event.
  SetId(self, Id)
Set's the ID for the event.
  SetTimestamp(self, ts)
bool ShouldPropagate(self)
Test if this event should be propagated to the parent window or not, i.e.
  Skip(self, skip)
Called by an event handler, it controls whether additional event handlers bound to this event will be called after the current event handler returns.
int StopPropagation(self)
Stop the event from propagating to its parent window.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Class Variable Summary
int FromTab = 4                                                                     
int IsBackward = 0                                                                     
int IsForward = 1                                                                     
int WinChange = 2                                                                     

Method Details

GetCurrentFocus(self)

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

Returns:
Window

GetDirection(self)

Returns True if the direction is forward, False otherwise.

Returns:
bool

IsFromTab(self)

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

Returns:
bool

IsWindowChange(self)

Returns True if window change is allowed.

Returns:
bool

SetCurrentFocus(self, win)

Set the window that has the focus.

Parameters:
win
           (type=Window)

SetDirection(self, forward)

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

Parameters:
forward
           (type=bool)

SetFlags(self, 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
           (type=long)

SetFromTab(self, bIs)

Set to true under MSW if the event was generated using the tab key. This is required for proper navogation over radio buttons.

Parameters:
bIs
           (type=bool)

SetWindowChange(self, ischange)

Specify if the navigation should be able to change parent windows. For example, changing notebook pages, etc. This is usually implemented by using Control-Tab.

Parameters:
ischange
           (type=bool)


Class Variable Details

FromTab

Type:
int
Value:
4                                                                     

IsBackward

Type:
int
Value:
0                                                                     

IsForward

Type:
int
Value:
1                                                                     

WinChange

Type:
int
Value:
2                                                                     

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:00:58 2007 http://epydoc.sf.net