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:

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: Optional[HelpControllerBase]=None) ->
                           None

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

Methods¶

__init__(self, hc: HelpControllerBase | None = 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: HelpControllerBase)¶

Sets the help controller associated with this help provider.

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

Properties¶

HelpController¶: See GetHelpController and SetHelpController

Navigation