a701b45539
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48164 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
116 lines
3.4 KiB
TeX
116 lines
3.4 KiB
TeX
\section{\class{wxNavigationKeyEvent}}\label{wxnavigationkeyevent}
|
|
|
|
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 make a class into a control container with the macro WX\_DECLARE\_CONTROL\_CONTAINER.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxEvent}{wxevent}\\
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/event.h>
|
|
|
|
\wxheading{Library}
|
|
|
|
\helpref{wxCore}{librarieslist}
|
|
|
|
\wxheading{Event table macros}
|
|
|
|
To process a navigation command event, use these event handler macros to direct input to member
|
|
functions that take a wxNavigationKeyEvent argument.
|
|
|
|
\twocolwidtha{7cm}
|
|
\begin{twocollist}\itemsep=0pt
|
|
\twocolitem{{\bf EVT\_NAVIGATION\_KEY(func)}}{Process a navigation key event.}
|
|
\end{twocollist}%
|
|
|
|
\latexignore{\rtfignore{\wxheading{Types}}}
|
|
|
|
\begin{verbatim}
|
|
enum
|
|
{
|
|
IsBackward = 0x0000,
|
|
IsForward = 0x0001,
|
|
WinChange = 0x0002,
|
|
FromTab = 0x0004
|
|
};
|
|
\end{verbatim}
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxWindow::Navigate}{wxwindownavigate}\\
|
|
\helpref{wxWindow::NavigateIn}{wxwindownavigatein}
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxNavigationKeyEvent::wxNavigationKeyEvent}\label{wxnavigationkeyeventctor}
|
|
|
|
\func{}{wxNavigationKeyEvent}{\void}
|
|
|
|
\func{}{wxNavigationKeyEvent}{\param{const wxNavigationKeyEvent\&}{ event}}
|
|
|
|
Constructor.
|
|
|
|
\membersection{wxNavigationKeyEvent::GetCurrentFocus}\label{wxnavigationkeyeventgetcurrentfocus}
|
|
|
|
\constfunc{wxWindow*}{GetCurrentFocus}{\void}
|
|
|
|
Returns the child that has the focus, or NULL.
|
|
|
|
\membersection{wxNavigationKeyEvent::GetDirection}\label{wxnavigationkeyeventgetdirection}
|
|
|
|
\constfunc{bool}{GetDirection}{\void}
|
|
|
|
Returns \true if the navigation was in the forward direction.
|
|
|
|
\membersection{wxNavigationKeyEvent::IsWindowChange}\label{wxnavigationkeyeventiswindowchange}
|
|
|
|
\constfunc{bool}{IsWindowChange}{\void}
|
|
|
|
Returns \true if the navigation event represents a window change (for example, from Ctrl-Page Down
|
|
in a notebook).
|
|
|
|
\membersection{wxNavigationKeyEvent::IsFromTab}\label{wxnavigationkeyeventisfromtab}
|
|
|
|
\constfunc{bool}{IsFromTab}{\void}
|
|
|
|
Returns \true if the navigation event was from a tab key. This is required for proper navigation over radio buttons.
|
|
|
|
\membersection{wxNavigationKeyEvent::SetCurrentFocus}\label{wxnavigationkeyeventsetcurrentfocus}
|
|
|
|
\func{void}{SetCurrentFocus}{\param{wxWindow* }{currentFocus}}
|
|
|
|
Sets the current focus window member.
|
|
|
|
\membersection{wxNavigationKeyEvent::SetDirection}\label{wxnavigationkeyeventsetdirection}
|
|
|
|
\func{void}{SetDirection}{\param{bool }{direction}}
|
|
|
|
Sets the direction to forward if {\it direction} is \true, or backward if \false.
|
|
|
|
\membersection{wxNavigationKeyEvent::SetFlags}\label{wxnavigationkeyeventsetflags}
|
|
|
|
\func{void}{SetFlags}{\param{long }{flags}}
|
|
|
|
Sets the flags.
|
|
|
|
\membersection{wxNavigationKeyEvent::SetFromTab}\label{wxnavigationkeyeventsetfromtab}
|
|
|
|
\func{void}{SetFromTab}{\param{bool }{fromTab}}
|
|
|
|
Marks the navigation event as from a tab key.
|
|
|
|
\membersection{wxNavigationKeyEvent::SetWindowChange}\label{wxnavigationkeyeventsetwindowchange}
|
|
|
|
\func{void}{SetWindowChange}{\param{bool }{windowChange}}
|
|
|
|
Marks the event as a window change event.
|
|
|