Phoenix Logo

phoenix_title 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 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 Class Hierarchy

Inheritance diagram for class HelpControllerHelpProvider:

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

api Class API



class wx.HelpControllerHelpProvider(SimpleHelpProvider)

Possible constructors:

HelpControllerHelpProvider(hc=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) –


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) –

Properties



HelpController

See GetHelpController and SetHelpController