API Reference for Enthought Tool Suite 3.2.0

Variables

• show_help

  The default handler for showing help

  show_help = default_show_help
  
  

Function summary

• default_show_help(info, control)
• on_help_call(new_show_help = None)

Functions

• default_show_help(info, control)

  Default handler for showing the help associated with a view.

• on_help_call(new_show_help = None)

  Sets a new global help provider function.

  Parameters

  new_show_help : function

  The function to set as the new global help provider

  Returns

  The previous global help provider function

  Description

  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.

Imported Names

© Copyright 2002-2009 Enthought, Inc.