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
.
See also
wx.HelpProvider, wx.SimpleHelpProvider, wx.ContextHelp, wx.Window.SetHelpText
, wx.Window.GetHelpTextAtPoint
Class Hierarchy¶
Methods Summary¶
Note that the instance doesn’t own the help controller. |
|
Returns the help controller associated with this help provider. |
|
Sets the help controller associated with this help provider. |
Properties Summary¶
See |
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:
- Return type:
None
- GetHelpController(self)¶
Returns the help controller associated with this help provider.
- Return type:
- SetHelpController(self, hc)¶
Sets the help controller associated with this help provider.
- Parameters:
- Return type:
None
Properties¶
- HelpController¶
See
GetHelpController
andSetHelpController