NAME

       wxNavigationKeyEvent - Functions for wxNavigationKeyEvent class

DESCRIPTION

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

       See: wxWindow:navigate/2, wxWindow::NavigateIn (not implemented in wx)

       This class is derived (and can use functions) from: wxEvent

       wxWidgets docs: wxNavigationKeyEvent

EVENTS

       Use wxEvtHandler:connect/3 with wxNavigationKeyEventType to subscribe to  events  of  this
       type.

DATA TYPES

       wxNavigationKeyEvent() = wx:wx_object()

       wxNavigationKey() =
           #wxNavigationKey{type =
                                wxNavigationKeyEvent:wxNavigationKeyEventType(),
                            dir = boolean(),
                            focus = wxWindow:wxWindow()}

       wxNavigationKeyEventType() = navigation_key

EXPORTS

       getDirection(This) -> boolean()

              Types:

                 This = wxNavigationKeyEvent()

              Returns true if the navigation was in the forward direction.

       setDirection(This, Direction) -> ok

              Types:

                 This = wxNavigationKeyEvent()
                 Direction = boolean()

              Sets the direction to forward if direction is true, or backward if false.

       isWindowChange(This) -> boolean()

              Types:

                 This = wxNavigationKeyEvent()

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

       setWindowChange(This, WindowChange) -> ok

              Types:

                 This = wxNavigationKeyEvent()
                 WindowChange = boolean()

              Marks the event as a window change event.

       isFromTab(This) -> boolean()

              Types:

                 This = wxNavigationKeyEvent()

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

              This is required for proper navigation over radio buttons.

       setFromTab(This, FromTab) -> ok

              Types:

                 This = wxNavigationKeyEvent()
                 FromTab = boolean()

              Marks the navigation event as from a tab key.

       getCurrentFocus(This) -> wxWindow:wxWindow()

              Types:

                 This = wxNavigationKeyEvent()

              Returns the child that has the focus, or NULL.

       setCurrentFocus(This, CurrentFocus) -> ok

              Types:

                 This = wxNavigationKeyEvent()
                 CurrentFocus = wxWindow:wxWindow()

              Sets the current focus window member.