GeezerVison

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

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

wx.ContextHelp¶

This class changes the cursor to a query and puts the application into a ‘context-sensitive help mode’.

When the user left-clicks on a window within the specified window, a wxEVT_HELP event is sent to that control, and the application may respond to it by popping up some help.

For example:

contextHelp = wx.ContextHelp(myWindow)

There are a couple of ways to invoke this behaviour implicitly:

Use the wx.DIALOG_EX_CONTEXTHELP style for a dialog (Windows only). This will put a question mark in the titlebar, and Windows will put the application into context-sensitive help mode automatically, with further programming.
Create a wx.ContextHelpButton, whose predefined behaviour is to create a context help object. Normally you will write your application so that this button is only added to a dialog for non-Windows platforms (use wx.DIALOG_EX_CONTEXTHELP on Windows).

Note that on macOS, the cursor does not change when in context-sensitive help mode.

Class Hierarchy¶

Inheritance diagram for class ContextHelp:

Methods Summary¶

`__init__`	Constructs a context help object, calling `BeginContextHelp` if doNow is `True` (the default).
`BeginContextHelp`	Puts the application into context-sensitive help mode.
`EndContextHelp`	Ends context-sensitive help mode.

Class API¶

class wx.ContextHelp(Object)¶

Possible constructors:

ContextHelp(window=None, doNow=True) -> None

This class changes the cursor to a query and puts the application into a ‘context-sensitive help mode’.

Methods¶

__init__(self, window=None, doNow=True)¶

Constructs a context help object, calling BeginContextHelp if doNow is True (the default).

If window is nullptr, the top window is used.

Parameters:

window (wx.Window)
doNow (bool)

Return type:

None

BeginContextHelp(self, window)¶

Puts the application into context-sensitive help mode.

window is the window which will be used to catch events; if nullptr, the top window will be used.

Returns True if the application was successfully put into context-sensitive help mode. This function only returns when the event loop has finished.

Parameters:: window (wx.Window)
Return type:: bool

EndContextHelp(self)¶

Ends context-sensitive help mode.

Not normally called by the application.

Return type:: bool

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.