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

\section{\class{wxHelpEvent}}\label{wxhelpevent}

A help event is sent when the user has requested context-sensitive help.
This can either be caused by the application requesting
context-sensitive help mode via \helpref{wxContextHelp}{wxcontexthelp}, or
(on MS Windows) by the system generating a WM\_HELP message when the user pressed F1 or clicked
on the query button in a dialog caption.

A help event is sent to the window that the user clicked on, and is propagated up the
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
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.

\wxheading{Derived from}

\helpref{wxCommandEvent}{wxcommandevent}\\
\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Event table macros}

To process an activate event, use these event handler macros to direct input to a member
function that takes a wxHelpEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_HELP(id, func)}}{Process a wxEVT\_HELP event.}
\twocolitem{{\bf EVT\_HELP\_RANGE(id1, id2, func)}}{Process a wxEVT\_HELP event for a range of ids.}
\end{twocollist}%

\wxheading{See also}

\helpref{wxContextHelp}{wxcontexthelp},\rtfsp
\helpref{wxDialog}{wxdialog},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxHelpEvent::wxHelpEvent}

\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{wxWindowID }{id = 0},
 \param{const wxPoint\& }{point}}

Constructor.

\membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}

\constfunc{const wxPoint\&}{GetPosition}{\void}

Returns the left-click position of the mouse, in screen coordinates. This allows
the application to position the help appropriately.

\membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}

\func{void}{SetPosition}{\param{const wxPoint\&}{ pt}}

Sets the left-click position of the mouse, in screen coordinates.
Commit	Line	Data
0460407f JS	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 wxWindows 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}
	47
	48	\func{}{wxHelpEvent}{\param{WXTYPE }{eventType = 0}, \param{bool}{ active = TRUE}, \param{wxWindowID }{id = 0},
	49	\param{const wxPoint\& }{point}}
	50
	51	Constructor.
	52
	53	\membersection{wxHelpEvent::GetPosition}\label{wxhelpeventgetposition}
	54
	55	\constfunc{const wxPoint\&}{GetPosition}{\void}
	56
	57	Returns the left-click position of the mouse, in screen coordinates. This allows
	58	the application to position the help appropriately.
	59
	60	\membersection{wxHelpEvent::SetPosition}\label{wxhelpeventsetposition}
	61
	62	\func{void}{SetPosition}{\param{const wxPoint\&}{ pt}}
	63
	64	Sets the left-click position of the mouse, in screen coordinates.
65