GeezerVison

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

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

wx.HelpControllerHelpProvider¶

wx.HelpControllerHelpProvider is an implementation of wx.HelpProvider which supports both context identifiers and plain text help strings.

If the help text is an integer, it is passed to wx.HelpController.DisplayContextPopup . Otherwise, it shows the string in a tooltip as per wx.SimpleHelpProvider. If you use this with a CHMHelpController instance on windows, it will use the native style of tip window instead of wx.TipWindow.

You can use the convenience function ContextId() to convert an integer context id to a string for passing to wx.Window.SetHelpText .

Class Hierarchy¶

Inheritance diagram for class HelpControllerHelpProvider:

Inheritance diagram of HelpControllerHelpProvider

Methods Summary¶

`__init__`	Note that the instance doesn’t own the help controller.
`GetHelpController`	Returns the help controller associated with this help provider.
`SetHelpController`	Sets the help controller associated with this help provider.

Properties Summary¶

HelpController

See GetHelpController and SetHelpController

Class API¶

class wx.HelpControllerHelpProvider(SimpleHelpProvider)¶

Possible constructors:

HelpControllerHelpProvider(hc=None) -> None

HelpControllerHelpProvider is an implementation of HelpProvider which supports both context identifiers and plain text help strings.

Methods¶

__init__(self, hc=None)¶

Note that the instance doesn’t own the help controller.

The help controller should be deleted separately.

Parameters:: hc (wx.HelpControllerBase)
Return type:: None

GetHelpController(self)¶

Returns the help controller associated with this help provider.

Return type:: wx.HelpControllerBase

SetHelpController(self, hc)¶

Sets the help controller associated with this help provider.

Parameters:: hc (wx.HelpControllerBase)
Return type:: None

Properties¶

HelpController¶: See GetHelpController and SetHelpController

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.