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 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 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.

Events Emitted by this Class

Handlers bound for the following event types will receive a HelpEvent parameter.

• EVT_HELP: Process a wxEVT_HELP event.
• EVT_HELP_RANGE: Process a wxEVT_HELP event for a range of ids.

See also

ContextHelp, Dialog, Events and Event Handling

Inheritance Diagram

Inheritance diagram for class HelpEvent

Methods Summary

__init__	Constructor.
GetOrigin	Returns the origin of the help event which is one of the HelpEventOrigin values.
GetPosition	Returns the left-click position of the mouse, in screen coordinates.
SetOrigin	Set the help event origin, only used internally by wxWidgets normally.
SetPosition	Sets the left-click position of the mouse, in screen coordinates.

Properties Summary

Position

See GetPosition and SetPosition

Class API

---

class HelpEvent(CommandEvent)

A help event is sent when the user has requested context-sensitive help.

Possible constructors:

HelpEvent(type=wxEVT_NULL, winid=0, pt=DefaultPosition,
          origin=Origin_Unknown)

Methods

---

__init__(self, type=wxEVT_NULL, winid=0, pt=DefaultPosition, origin=Origin_Unknown)

Constructor.

Parameters:

• type (EventType) –
• winid (int) –
• pt (Point) –
• origin (HelpEvent.Origin) –

---

GetOrigin(self)

Returns the origin of the help event which is one of the HelpEventOrigin values.

The application may handle events generated using the keyboard or mouse differently, e.g. by using GetMousePosition for the mouse events.

Return type:HelpEvent.Origin

See also

SetOrigin

---

GetPosition(self)

Returns the left-click position of the mouse, in screen coordinates.

This allows the application to position the help appropriately.

Return type: Point

---

SetOrigin(self, origin)

Set the help event origin, only used internally by wxWidgets normally.

Parameters:origin (HelpEvent.Origin) –

See also

GetOrigin

---

SetPosition(self, pt)

Sets the left-click position of the mouse, in screen coordinates.

Parameters:pt (Point) –

Properties

---

Position

See GetPosition and SetPosition