remove C++ comment

[wxWidgets.git] / docs / latex / wx / navevent.tex

\section{\class{wxNavigationKeyEvent}}\label{wxnavigationkeyevent}\r
\r
This event class contains information about navigation events,\r
generated by navigation keys such as tab and page down.\r
\r
This event is mainly used by wxWidgets implementations. A\r
wxNavigationKeyEvent handler is automatically provided by wxWidgets\r
when you make a class into a control container with the macro WX\_DECLARE\_CONTROL\_CONTAINER.\r
\r
\wxheading{Derived from}\r
\r
\helpref{wxEvent}{wxevent}\\\r
\helpref{wxObject}{wxobject}\r
\r
\wxheading{Include files}\r
\r
<wx/event.h>\r
\r
\wxheading{Library}\r
\r
\helpref{wxCore}{librarieslist}\r
\r
\wxheading{Event table macros}\r
\r
To process a navigation command event, use these event handler macros to direct input to member\r
functions that take a wxNavigationKeyEvent argument.\r
\r
\twocolwidtha{7cm}\r
\begin{twocollist}\itemsep=0pt\r
\twocolitem{{\bf EVT\_NAVIGATION\_KEY(func)}}{Process a navigation key event.}\r
\end{twocollist}%\r
\r
\latexignore{\rtfignore{\wxheading{Types}}}\r
\r
\begin{verbatim}\r
    enum\r
    {\r
        IsBackward = 0x0000,\r
        IsForward = 0x0001,\r
        WinChange = 0x0002,\r
        FromTab = 0x0004\r
    };\r
\end{verbatim}\r
\r
\wxheading{See also}\r
\r
\helpref{wxWindow::Navigate}{wxwindownavigate}\\\r
\helpref{wxWindow::NavigateIn}{wxwindownavigatein}\r
\r
\r
\latexignore{\rtfignore{\wxheading{Members}}}\r
\r
\membersection{wxNavigationKeyEvent::wxNavigationKeyEvent}\label{wxnavigationkeyeventctor}\r
\r
\func{}{wxNavigationKeyEvent}{\void}\r
\r
\func{}{wxNavigationKeyEvent}{\param{const wxNavigationKeyEvent\&}{ event}}\r
\r
Constructor.\r
\r
\membersection{wxNavigationKeyEvent::GetCurrentFocus}\label{wxnavigationkeyeventgetcurrentfocus}\r
\r
\constfunc{wxWindow*}{GetCurrentFocus}{\void}\r
\r
Returns the child that has the focus, or NULL.\r
\r
\membersection{wxNavigationKeyEvent::GetDirection}\label{wxnavigationkeyeventgetdirection}\r
\r
\constfunc{bool}{GetDirection}{\void}\r
\r
Returns \true if the navigation was in the forward direction.\r
\r
\membersection{wxNavigationKeyEvent::IsWindowChange}\label{wxnavigationkeyeventiswindowchange}\r
\r
\constfunc{bool}{IsWindowChange}{\void}\r
\r
Returns \true if the navigation event represents a window change (for example, from Ctrl-Page Down\r
in a notebook).\r
\r
\membersection{wxNavigationKeyEvent::IsFromTab}\label{wxnavigationkeyeventisfromtab}\r
\r
\constfunc{bool}{IsFromTab}{\void}\r
\r
Returns \true if the navigation event was from a tab key. This is required for proper navigation over radio buttons.\r
\r
\membersection{wxNavigationKeyEvent::SetCurrentFocus}\label{wxnavigationkeyeventsetcurrentfocus}\r
\r
\func{void}{SetCurrentFocus}{\param{wxWindow* }{currentFocus}}\r
\r
Sets the current focus window member.\r
\r
\membersection{wxNavigationKeyEvent::SetDirection}\label{wxnavigationkeyeventsetdirection}\r
\r
\func{void}{SetDirection}{\param{bool }{direction}}\r
\r
Sets the direction to forward if {\it direction} is \true, or backward if \false.\r
\r
\membersection{wxNavigationKeyEvent::SetFlags}\label{wxnavigationkeyeventsetflags}\r
\r
\func{void}{SetFlags}{\param{long }{flags}}\r
\r
Sets the flags.\r
\r
\membersection{wxNavigationKeyEvent::SetFromTab}\label{wxnavigationkeyeventsetfromtab}\r
\r
\func{void}{SetFromTab}{\param{bool }{fromTab}}\r
\r
Marks the navigation event as from a tab key.\r
\r
\membersection{wxNavigationKeyEvent::SetWindowChange}\label{wxnavigationkeyeventsetwindowchange}\r
\r
\func{void}{SetWindowChange}{\param{bool }{windowChange}}\r
\r
Marks the event as a window change event.\r
\r