document GetAnimation() (patch 1695722)

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

diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex
index 253ab1b66ea563d92b3b7fb857b30ca3956c3c81..9d3d779bea47d76091eecfd427e4722019bef56b 100644 (file)
--- a/docs/latex/wx/helpevt.tex
+++ b/docs/latex/wx/helpevt.tex
@@ -10,7 +10,7 @@ A help event is sent to the window that the user clicked on, and is propagated u
 window hierarchy until the event is processed or there are no more event handlers.
 The application should call wxEvent::GetId to check the identity of the clicked-on window,
 and then either show some suitable help or call wxEvent::Skip if the identifier is unrecognised.
-Calling Skip is important because it allows wxWindows to generate further events for ancestors
+Calling Skip is important because it allows wxWidgets to generate further events for ancestors
 of the clicked-on window. Otherwise it would be impossible to show help for container windows,
 since processing would stop after the first window found.
 
@@ -43,13 +43,37 @@ function that takes a wxHelpEvent argument.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxHelpEvent::wxHelpEvent}
+\membersection{wxHelpEvent::wxHelpEvent}\label{wxhelpeventctor}
 
-\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = true}, \param{wxWindowID }{id = 0},
+\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{wxWindowID }{id = 0},
  \param{const wxPoint\& }{point}}
 
 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}}