X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f0e8a2d07799ba3a8d03487dfc181d7f5a38a2ad..5814e8ba4e57839acd1eb7491ed392b07e382593:/docs/latex/wx/helpevt.tex?ds=sidebyside diff --git a/docs/latex/wx/helpevt.tex b/docs/latex/wx/helpevt.tex index a894797344..9d3d779bea 100644 --- a/docs/latex/wx/helpevt.tex +++ b/docs/latex/wx/helpevt.tex @@ -45,11 +45,35 @@ function that takes a wxHelpEvent argument. \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}}