wxHelpEvent
generated from ../src/mod_gui/event/help.cpp
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 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 use id to check the identity of the clicked-on window,
and then either show some suitable help or set skip to true if the identifier is
unrecognised. Setting skip to true 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.
See onHelp, wxContextHelp and wxContextHelpButton
Constants
Properties
| Name | Type | Description |
|---|---|---|
| position | wxPoint | Get/Set the left-click position of the mouse in screen-coordinates. This helps the application to position the help appropriately. |
© 2002 - 2007 Franky Braem.