wxRuby Documentation Home

Wx::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#set_help_text.

Derived from

SimpleHelpProvider

HelpProvider

See also

HelpProvider, SimpleHelpProvider, ContextHelp, Window#set_help_text, Window#get_help_text

Methods

HelpControllerHelpProvider.new

HelpControllerHelpProvider.new(HelpControllerBase hc = nil)

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

HelpControllerHelpProvider#set_help_controller

set_help_controller(HelpControllerBase hc)

Sets the help controller associated with this help provider.

HelpControllerHelpProvider#get_help_controller

HelpControllerBase get_help_controller()

Returns the help controller associated with this help provider.

[This page automatically generated from the Textile source at Fri Oct 31 16:06:43 +0000 2008]