GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing docs.wxpython.org — wx.HelpEvent — wxPython 4.3.2 Docs

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 wx.Event.Skip if the identifier is unrecognised.

Note that for some windows, such as wx.ToolBar, the event uses the ID of the tool that was under the mouse, if any, and not the ID of the window itself. If necessary, wx.Event.GetEventObject may be used to get the pointer to the toolbar itself.

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 wx.HelpEvent parameter.

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

Class Hierarchy¶

Inheritance diagram for class HelpEvent:

Methods Summary¶

`__init__`	Constructor.
`GetOrigin`	Returns the origin of the help event which is one of the wx.HelpEvent.Origin 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 wx.HelpEvent(CommandEvent)¶

Possible constructors:

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

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

Methods¶

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

Constructor.

Parameters:

type (wx.EventType)
winid (wx.WindowID)
pt (wx.Point)
origin (HelpEvent.Origin)

Return type:

None

GetOrigin(self)¶

Returns the origin of the help event which is one of the wx.HelpEvent.Origin values.

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

Return type:: wx.HelpEvent.Origin

Properties¶

Position¶: See GetPosition and SetPosition

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.