Added documentation for wxNavigationKeyEvent

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48164 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex
index edf7a2dc9e9eae6cb00afde197265ce05ab974e8..dc084919002f87011d9978babb7724123b9d28d4 100644 (file)
--- a/docs/latex/wx/category.tex
+++ b/docs/latex/wx/category.tex
@@ -285,6 +285,7 @@ An event object contains information about a specific event. Event handlers
 \twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event}
 \twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event}
 \twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
+\twocolitem{\helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}}{An event set by navigation keys such as tab}
 \twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
 \twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed}
 \twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 5866232c2059730d93959255e9992741fe696660..a0861e361c43b6a9efe92143ebe004f4261df978 100644 (file)
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -278,6 +278,7 @@
 \input mltchdlg.tex
 \input mutex.tex
 \input mutexlck.tex
+\input navevent.tex
 \input node.tex
 \input notebook.tex
 \input noteevt.tex

diff --git a/docs/latex/wx/navevent.tex b/docs/latex/wx/navevent.tex
new file mode 100644 (file)
index 0000000..863bb7c
--- /dev/null
+++ b/docs/latex/wx/navevent.tex
@@ -0,0 +1,115 @@
+\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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index e7a4f6618371cde7e37afe539273a154fe3c6f15..7fad11545aeb2ab6a42943539dcfa4cc70c5acd1 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1810,7 +1810,7 @@ changed.
 You may wish to call this from a text control custom keypress handler to do the default
 navigation behaviour for the tab key, since the standard default behaviour for
 a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab
-and not navigate to the next control.
+and not navigate to the next control. See also \helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}.
 
 
 \membersection{wxWindow::NavigateIn}\label{wxwindownavigatein}