]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/helpevt.tex
fix LaTeX error (escape underscores); don't abuse bold face
[wxWidgets.git] / docs / latex / wx / helpevt.tex
index 90d43d529a8cef21d26f1caa8659fa7e4e2152c5..9e79145b5b90db20f08315b9f1f51d12b1ebe928 100644 (file)
@@ -24,19 +24,9 @@ since processing would stop after the first window found.
 
 <wx/event.h>
 
-\wxheading{Help event origin}\label{wxhelpeventorigin}
+\wxheading{Library}
 
-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}%
+\helpref{wxCore}{librarieslist}
 
 \wxheading{Event table macros}
 
@@ -68,12 +58,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 +89,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}