From a701b455397bb5891482c22fe7d6a6d4b294e41b Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sat, 18 Aug 2007 13:04:41 +0000 Subject: [PATCH] Added documentation for wxNavigationKeyEvent git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48164 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 1 + docs/latex/wx/classes.tex | 1 + docs/latex/wx/navevent.tex | 115 +++++++++++++++++++++++++++++++++++++ docs/latex/wx/window.tex | 2 +- 4 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 docs/latex/wx/navevent.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index edf7a2dc9e..dc08491900 100644 --- 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 5866232c20..a0861e361c 100644 --- 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 index 0000000000..863bb7c0a7 --- /dev/null +++ b/docs/latex/wx/navevent.tex @@ -0,0 +1,115 @@ +\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} + + + +\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. + diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index e7a4f66183..7fad11545a 100644 --- 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} -- 2.45.2