HelpProvider is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.
The current help provider must be explicitly set by the application using HelpProvider::Set().
No base class
ContextHelp, ContextHelpButton, SimpleHelpProvider, HelpControllerHelpProvider, Window#set_help_text, Window#get_help_text
Virtual destructor for any base class.
add_help(WindowBase window, String text)Associates the text with the given window or id. Although all help providers have these functions to allow making Window#set_help_text work, not all of them implement the functions.
HelpProvider get()Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application.
String get_help(WindowBase window)Gets the help string for this window. Its interpretation is dependent on the help provider except that empty string always means that no help is associated with the window.
add_help(Integer id, String text)This version associates the given text with all windows with this id. May be used to set the same help string for all Cancel buttons in the application, for example.
remove_help(WindowBase window)Removes the association between the window pointer and the help text. This is called by the Window destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found.
HelpProvider set(HelpProvider helpProvider)Get/set the current, application-wide help provider. Returns the previous one.
Boolean show_help(WindowBase window)Shows help for the given window. Uses get_help internally if applicable.
Returns true if it was done, or false if no help was available for this window.
[This page automatically generated from the Textile source at Fri Oct 31 16:06:43 +0000 2008]