X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f2f8871a2e9d69432c39b5f4aa4ee8060b0f4ab1..7f5426f09c68bf42e58e3932e2bcb0322caa6b41:/docs/latex/wx/helpevt.tex 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}