fixed incorrect reference to wxhelpeventorigin

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39782 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2006-06-18 21:40:22 +00:00
parent 9413e1e34a
commit d57725b576
3 changed files with 19 additions and 21 deletions

View File

@@ -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} \wxheading{Event table macros}
To process an activate event, use these event handler macros to direct input to a member 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 Returns the origin of the help event which is one of the following values:
to determine the source of the event and show the appropriate help to the user.
\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}

View File

@@ -97,7 +97,7 @@ window.
\docparam{point}{Coordinates of the mouse at the moment of help event emission.} \docparam{point}{Coordinates of the mouse at the moment of help event emission.}
\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::Origin}{wxhelpeventorigin}.} \docparam{origin}{Help event origin, see \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.}
\newsince{2.7.0} \newsince{2.7.0}

View File

@@ -1028,7 +1028,7 @@ the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used.
\docparam{point}{Coordinates of the mouse at the moment of help event emission.} \docparam{point}{Coordinates of the mouse at the moment of help event emission.}
\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::Origin}{wxhelpeventorigin}.} \docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.}
\newsince{2.7.0} \newsince{2.7.0}