.TH wxNavigationKeyEvent 3erl "wx 2.2.2.1" "wxWidgets team." "Erlang Module Definition"
.SH NAME
wxNavigationKeyEvent \- Functions for wxNavigationKeyEvent class
.SH DESCRIPTION
.LP
This event class contains information about navigation events, generated by navigation keys such as tab and page down\&.
.LP
This event is mainly used by wxWidgets implementations\&. A \fIwxNavigationKeyEvent\fR\& handler is automatically provided by wxWidgets when you enable keyboard navigation inside a window by inheriting it from wxNavigationEnabled<>\&.
.LP
See: \fIwxWindow:navigate/2\fR\&, \fIwxWindow::NavigateIn\fR\& (not implemented in wx)
.LP
This class is derived (and can use functions) from: \fIwxEvent\fR\&
.LP
wxWidgets docs: wxNavigationKeyEvent
.SH "EVENTS"

.LP
Use \fIwxEvtHandler:connect/3\fR\& with \fIwxNavigationKeyEventType\fR\& to subscribe to events of this type\&.
.SH DATA TYPES
.nf

\fBwxNavigationKeyEvent()\fR\& = wx:wx_object()
.br
.fi
.nf

\fBwxNavigationKey()\fR\& = 
.br
    #wxNavigationKey{type =
.br
                         wxNavigationKeyEvent:wxNavigationKeyEventType(),
.br
                     dir = boolean(),
.br
                     focus = wxWindow:wxWindow()}
.br
.fi
.nf

\fBwxNavigationKeyEventType()\fR\& = navigation_key
.br
.fi
.SH EXPORTS
.LP
.nf

.B
getDirection(This) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
.RE
.RE
.RS
.LP
Returns true if the navigation was in the forward direction\&.
.RE

.LP
.nf

.B
setDirection(This, Direction) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
Direction = boolean()
.br
.RE
.RE
.RS
.LP
Sets the direction to forward if \fIdirection\fR\& is true, or backward if false\&.
.RE

.LP
.nf

.B
isWindowChange(This) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
.RE
.RE
.RS
.LP
Returns true if the navigation event represents a window change (for example, from Ctrl-Page Down in a notebook)\&.
.RE

.LP
.nf

.B
setWindowChange(This, WindowChange) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
WindowChange = boolean()
.br
.RE
.RE
.RS
.LP
Marks the event as a window change event\&.
.RE

.LP
.nf

.B
isFromTab(This) -> boolean()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
.RE
.RE
.RS
.LP
Returns true if the navigation event was from a tab key\&.
.LP
This is required for proper navigation over radio buttons\&.
.RE

.LP
.nf

.B
setFromTab(This, FromTab) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
FromTab = boolean()
.br
.RE
.RE
.RS
.LP
Marks the navigation event as from a tab key\&.
.RE

.LP
.nf

.B
getCurrentFocus(This) -> wxWindow:wxWindow()
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
.RE
.RE
.RS
.LP
Returns the child that has the focus, or NULL\&.
.RE

.LP
.nf

.B
setCurrentFocus(This, CurrentFocus) -> ok
.br
.fi
.br
.RS
.LP
Types:

.RS 3
This = wxNavigationKeyEvent()
.br
CurrentFocus = wxWindow:wxWindow()
.br
.RE
.RE
.RS
.LP
Sets the current focus window member\&.
.RE