| 1 | \section{\class{wxHelpEvent}}\label{wxhelpevent} |
| 2 | |
| 3 | A help event is sent when the user has requested context-sensitive help. |
| 4 | This can either be caused by the application requesting |
| 5 | context-sensitive help mode via \helpref{wxContextHelp}{wxcontexthelp}, or |
| 6 | (on MS Windows) by the system generating a WM\_HELP message when the user pressed F1 or clicked |
| 7 | on the query button in a dialog caption. |
| 8 | |
| 9 | A help event is sent to the window that the user clicked on, and is propagated up the |
| 10 | window hierarchy until the event is processed or there are no more event handlers. |
| 11 | The application should call wxEvent::GetId to check the identity of the clicked-on window, |
| 12 | and then either show some suitable help or call wxEvent::Skip if the identifier is unrecognised. |
| 13 | Calling Skip is important because it allows wxWidgets to generate further events for ancestors |
| 14 | of the clicked-on window. Otherwise it would be impossible to show help for container windows, |
| 15 | since processing would stop after the first window found. |
| 16 | |
| 17 | \wxheading{Derived from} |
| 18 | |
| 19 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
| 20 | \helpref{wxEvent}{wxevent}\\ |
| 21 | \helpref{wxObject}{wxobject} |
| 22 | |
| 23 | \wxheading{Include files} |
| 24 | |
| 25 | <wx/event.h> |
| 26 | |
| 27 | \wxheading{Event table macros} |
| 28 | |
| 29 | To process an activate event, use these event handler macros to direct input to a member |
| 30 | function that takes a wxHelpEvent argument. |
| 31 | |
| 32 | \twocolwidtha{7cm} |
| 33 | \begin{twocollist}\itemsep=0pt |
| 34 | \twocolitem{{\bf EVT\_HELP(id, func)}}{Process a wxEVT\_HELP event.} |
| 35 | \twocolitem{{\bf EVT\_HELP\_RANGE(id1, id2, func)}}{Process a wxEVT\_HELP event for a range of ids.} |
| 36 | \end{twocollist}% |
| 37 | |
| 38 | \wxheading{See also} |
| 39 | |
| 40 | \helpref{wxContextHelp}{wxcontexthelp},\rtfsp |
| 41 | \helpref{wxDialog}{wxdialog},\rtfsp |
| 42 | \helpref{Event handling overview}{eventhandlingoverview} |
| 43 | |
| 44 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 45 | |
| 46 | \membersection{wxHelpEvent::wxHelpEvent}\label{wxhelpeventctor} |
| 47 | |
| 48 | \func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{wxWindowID }{id = 0}, |
| 49 | \param{const wxPoint\& }{point}} |
| 50 | |
| 51 | Constructor. |
| 52 | |
| 53 | \membersection{wxHelpEvent::GetOrigin}\label{wxhelpeventgetorigin} |
| 54 | |
| 55 | \constfunc{wxHelpEvent::Origin }{GetOrigin}{\void} |
| 56 | |
| 57 | Returns the origin of the help event which is one of the following values: |
| 58 | |
| 59 | \twocolwidtha{7cm} |
| 60 | \begin{twocollist}\itemsep=0pt |
| 61 | \twocolitem{{\bf Origin\_Unknown}}{Unrecognized event source.} |
| 62 | \twocolitem{{\bf Origin\_Keyboard}}{Event generated by \texttt{F1} key press.} |
| 63 | \twocolitem{{\bf Origin\_HelpButton}}{Event generated by |
| 64 | \helpref{wxContextHelp}{wxcontexthelp} or using the "?" title bur button under |
| 65 | MS Windows.} |
| 66 | \end{twocollist} |
| 67 | |
| 68 | The application may handle events generated using the keyboard or mouse |
| 69 | differently, e.g. by using \helpref{wxGetMousePosition()}{wxgetmouseposition} |
| 70 | for the mouse events. |
| 71 | |
| 72 | \wxheading{See also} |
| 73 | |
| 74 | \helpref{wxHelpEvent::SetOrigin}{wxhelpeventsetorigin} |
| 75 | |
| 76 | |
| 77 | \membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition} |
| 78 | |
| 79 | \constfunc{const wxPoint\&}{GetPosition}{\void} |
| 80 | |
| 81 | Returns the left-click position of the mouse, in screen coordinates. This allows |
| 82 | the application to position the help appropriately. |
| 83 | |
| 84 | \membersection{wxHelpEvent::SetOrigin}\label{wxhelpeventsetorigin} |
| 85 | |
| 86 | \func{void}{SetOrigin}{\param{wxHelpEvent::Origin }{origin}} |
| 87 | |
| 88 | Set the help event origin, only used internally by wxWidgets normally. |
| 89 | |
| 90 | \wxheading{See also} |
| 91 | |
| 92 | \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin} |
| 93 | |
| 94 | |
| 95 | \membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition} |
| 96 | |
| 97 | \func{void}{SetPosition}{\param{const wxPoint\&}{ pt}} |
| 98 | |
| 99 | Sets the left-click position of the mouse, in screen coordinates. |
| 100 | |