traitsui.help module

Defines the help interface for displaying the help associated with a Traits UI View object.

traitsui.help.default_show_help(info, control)

Default handler for showing the help associated with a view.

traitsui.help.on_help_call(new_show_help=None)

Sets a new global help provider function.

The help provider function must have a signature of function*(*info, control), where info is a UIInfo object for the current view, and control is the UI control that invokes the function (typically, a Help button). It is provided in case the help provider needs to position the help window relative to the Help button.

To retrieve the current help provider function, call this function with no arguments.

Parameters

new_show_help (function) – The function to set as the new global help provider

Returns

previous – The previous global help provider function

Return type

callable

traitsui.help.show_help(info, control)

Default handler for showing the help associated with a view.