From d57725b5768cc7638a0ca35ec8c203cd3ee4a00e Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 18 Jun 2006 21:40:22 +0000 Subject: [PATCH] fixed incorrect reference to wxhelpeventorigin git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39782 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/helpevt.tex | 36 +++++++++++++++++------------------- docs/latex/wx/helpprov.tex | 2 +- docs/latex/wx/window.tex | 2 +- 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex index 90d43d529a..9d3d779bea 100644 --- a/docs/latex/wx/helpevt.tex +++ b/docs/latex/wx/helpevt.tex @@ -24,20 +24,6 @@ since processing would stop after the first window found. -\wxheading{Help event origin}\label{wxhelpeventorigin} - -Use \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin} to determine the origin of this help event, -it could be one of the following: - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf Origin\_Unknown}}{Unrecognized event source.} -\twocolitem{{\bf Origin\_Keyboard}}{Event generated by \texttt{F1} key press.} -\twocolitem{{\bf Origin\_HelpButton}}{Event generated by -\helpref{wxContextHelp}{wxcontexthelp} or using the "?" title bur button under -MS Windows.} -\end{twocollist}% - \wxheading{Event table macros} To process an activate event, use these event handler macros to direct input to a member @@ -68,12 +54,24 @@ Constructor. \constfunc{wxHelpEvent::Origin }{GetOrigin}{\void} -Returns the \helpref{origin}{wxhelpeventorigin} of the help event. This allows -to determine the source of the event and show the appropriate help to the user. +Returns the origin of the help event which is one of the following values: + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf Origin\_Unknown}}{Unrecognized event source.} +\twocolitem{{\bf Origin\_Keyboard}}{Event generated by \texttt{F1} key press.} +\twocolitem{{\bf Origin\_HelpButton}}{Event generated by +\helpref{wxContextHelp}{wxcontexthelp} or using the "?" title bur button under +MS Windows.} +\end{twocollist} + +The application may handle events generated using the keyboard or mouse +differently, e.g. by using \helpref{wxGetMousePosition()}{wxgetmouseposition} +for the mouse events. \wxheading{See also} -\helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin}, \helpref{Help event origin}{wxhelpeventorigin} +\helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin} \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition} @@ -87,11 +85,11 @@ the application to position the help appropriately. \func{void}{SetOrigin}{\param{wxHelpEvent::Origin }{origin}} -Set the help event \helpref{origin}{wxhelpeventorigin}. +Set the help event origin, only used internally by wxWidgets normally. \wxheading{See also} -\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}, \helpref{Help event origin}{wxhelpeventorigin} +\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin} \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition} diff --git a/docs/latex/wx/helpprov.tex b/docs/latex/wx/helpprov.tex index c05e2ee37b..950c939928 100644 --- a/docs/latex/wx/helpprov.tex +++ b/docs/latex/wx/helpprov.tex @@ -97,7 +97,7 @@ window. \docparam{point}{Coordinates of the mouse at the moment of help event emission.} -\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::Origin}{wxhelpeventorigin}.} +\docparam{origin}{Help event origin, see \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.} \newsince{2.7.0} diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 09d10e0072..019e5b90b1 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1028,7 +1028,7 @@ the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used. \docparam{point}{Coordinates of the mouse at the moment of help event emission.} -\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::Origin}{wxhelpeventorigin}.} +\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.} \newsince{2.7.0} -- 2.45.2