Contents Up Previous Next

wxHelpControllerHelpProvider

wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports both context identifiers and plain text help strings. If the help text is an integer, it is passed to wxHelpController::DisplayContextPopup. Otherwise, it shows the string in a tooltip as per wxSimpleHelpProvider. If you use this with a wxCHMHelpController instance on windows, it will use the native style of tip window instead of wxTipWindow.

You can use the convenience function wxContextId to convert an integer context id to a string for passing to wxWindow::SetHelpText.

Derived from

wxSimpleHelpProvider
wxHelpProvider

Include files

<wx/cshelp.h>

See also

wxHelpProvider, wxSimpleHelpProvider, wxContextHelp, wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint

Members

wxHelpControllerHelpProvider::wxHelpControllerHelpProvider
wxHelpControllerHelpProvider::SetHelpController
wxHelpControllerHelpProvider::GetHelpController


wxHelpControllerHelpProvider::wxHelpControllerHelpProvider

wxHelpControllerHelpProvider(wxHelpControllerBase* hc = NULL)

Note that the instance doesn't own the help controller. The help controller should be deleted separately.


wxHelpControllerHelpProvider::SetHelpController

void SetHelpController(wxHelpControllerBase* hc)

Sets the help controller associated with this help provider.


wxHelpControllerHelpProvider::GetHelpController

wxHelpControllerBase* GetHelpController() const

Returns the help controller associated with this help provider.