clarified global and local config files behavior

[wxWidgets.git] / docs / latex / wx / helpevt.tex

diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex
index 90d43d529a8cef21d26f1caa8659fa7e4e2152c5..9d3d779bea47d76091eecfd427e4722019bef56b 100644 (file)
--- 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.
 
 <wx/event.h>
 
 
 <wx/event.h>
 

-\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
 \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}
 
 
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin}, \helpref{Help event origin}{wxhelpeventorigin}
+\helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin}

 
 
 \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}
 
 
 \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}


@@ -87,11 +85,11 @@ the application to position the help appropriately.
 
 \func{void}{SetOrigin}{\param{wxHelpEvent::Origin }{origin}}
 
 
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}, \helpref{Help event origin}{wxhelpeventorigin}
+\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}

 
 
 \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}
 
 
 \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}