]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/helpevt.tex
corrected EVT_NOTIFY[_RANGE] docs (bug 1439078)
[wxWidgets.git] / docs / latex / wx / helpevt.tex
index 1fccfc1faa0614cf1218e2096e99f7b68359a96c..9d3d779bea47d76091eecfd427e4722019bef56b 100644 (file)
@@ -50,6 +50,30 @@ function that takes a wxHelpEvent argument.
 
 Constructor.
 
+\membersection{wxHelpEvent::GetOrigin}\label{wxhelpeventgetorigin}
+
+\constfunc{wxHelpEvent::Origin }{GetOrigin}{\void}
+
+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}
+
+
 \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}
 
 \constfunc{const wxPoint\&}{GetPosition}{\void}
@@ -57,6 +81,17 @@ Constructor.
 Returns the left-click position of the mouse, in screen coordinates. This allows
 the application to position the help appropriately.
 
+\membersection{wxHelpEvent::SetOrigin}\label{wxhelpeventsetorigin}
+
+\func{void}{SetOrigin}{\param{wxHelpEvent::Origin }{origin}}
+
+Set the help event origin, only used internally by wxWidgets normally.
+
+\wxheading{See also}
+
+\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}
+
+
 \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}
 
 \func{void}{SetPosition}{\param{const wxPoint\&}{ pt}}