HelpControllerHelpProvider

HelpControllerHelpProvider is an implementation of 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 SimpleHelpProvider. If you use this with a CHMHelpController instance on windows, it will use the native style of tip window instead of TipWindow.

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

See also

HelpProvider, SimpleHelpProvider, ContextHelp, Window.SetHelpText , Window.GetHelpTextAtPoint

Inheritance Diagram

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 HelpControllerHelpProvider(SimpleHelpProvider)

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

Possible constructors:

HelpControllerHelpProvider(hc=None)

Methods

---

__init__(self, hc=None)

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

The help controller should be deleted separately.

Parameters:hc (HelpControllerBase) –

---

GetHelpController(self)

Returns the help controller associated with this help provider.

Return type: HelpControllerBase

---

SetHelpController(self, hc)

Sets the help controller associated with this help provider.

Parameters:hc (HelpControllerBase) –

Properties

---

HelpController

See GetHelpController and SetHelpController