From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 13 Jun 2006 22:05:23 +0000 (+0000)
Subject: document wxHelpEvent::Set/GetOrigin()
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/f2f8871a2e9d69432c39b5f4aa4ee8060b0f4ab1

document wxHelpEvent::Set/GetOrigin()


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39702 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex
index 1fccfc1faa..90d43d529a 100644
--- a/docs/latex/wx/helpevt.tex
+++ b/docs/latex/wx/helpevt.tex
@@ -24,6 +24,20 @@ since processing would stop after the first window found.
 
 <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
@@ -50,6 +64,18 @@ function that takes a wxHelpEvent argument.
 
 Constructor.
 
+\membersection{wxHelpEvent::GetOrigin}\label{wxhelpeventgetorigin}
+
+\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.
+
+\wxheading{See also}
+
+\helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin}, \helpref{Help event origin}{wxhelpeventorigin}
+
+
 \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}
 
 \constfunc{const wxPoint\&}{GetPosition}{\void}
@@ -57,6 +83,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 \helpref{origin}{wxhelpeventorigin}.
+
+\wxheading{See also}
+
+\helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}, \helpref{Help event origin}{wxhelpeventorigin}
+
+
 \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}
 
 \func{void}{SetPosition}{\param{const wxPoint\&}{ pt}}