Inheritance diagram for wx.HelpEvent:
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 wx.ContextHelp, 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 wx.Event.GetId to check the identity of the clicked-on window, and then either show some suitable help or call event.Skip() if the identifier is unrecognised.
Calling Skip is important because it allows wxWidgets 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 also
| Event Name | Description |
|---|---|
| wx.EVT_HELP(id, func) | Process a wx.wxEVT_HELP event. |
| wx.EVT_HELP_RANGE(id1, id2, func) | Process a wx.wxEVT_HELP event for a range of ids. |
Constructor.
Parameters:
Returns:
Get an optional link to further help
Returns:
string
Returns the origin of the help event which is one of the following values:
| Origin Flag | Description |
|---|---|
| Origin_Unknown | Unrecognized event source. |
| Origin_Keyboard | Event generated by F1 key press. |
| Origin_HelpButton | Event generated by wx.ContextHelp or using the “?” title bur button under MS Windows. |
The application may handle events generated using the keyboard or mouse differently, e.g. by using wx.GetMousePosition for the mouse events.
Returns:
int
See also
Returns the left-click position of the mouse, in screen coordinates. This allows the application to position the help appropriately.
Returns:
Get an optional target to display help in. E.g. a window specification
Returns:
string
Set an optional link to further help
Parameters:
Set the help event origin, only used internally by wxWidgets normally.
Parameters:
See also
Sets the left-click position of the mouse, in screen coordinates.
Parameters:
Set an optional target to display help in. E.g. a window specification
Parameters:
