API Reference for Enthought Tool Suite 3.2.0

Variables

• logger

  Setup a logger for this module.

  logger = logging.getLogger(__name__)
  
  

Function summary

• debug(msg)
• error(msg, parent = None)
• exception(msg = 'Exception', parent = None)
• get_engine(obj)
• get_object_path(object, parent, path = 'engine')
• handle_children_state(children, kids)
• process_ui_events()
• warning(msg, parent = None)

Functions

• debug(msg)

  Handle a debug message.

• error(msg, parent = None)

  Handle an error message.

• exception(msg = 'Exception', parent = None)

  This function handles any exception derived from Exception and prints out an error. The optional parent argument is passed along to the dialog box. The optional msg is printed and sent to the logger. So you could send extra information here.

• get_engine(obj)

  Try and return the engine given an object in the mayavi pipeline. This basically walks up the parent's of the object till the engine is found.

• get_object_path(object, parent, path = 'engine')

  Given a mayavi object on the tree view, this should find its "path" with respect to the parent object that contains it.

• handle_children_state(children, kids)

  Given a list of children (as children) of a particular object and their states in the kids argument, this function sets up the children by removing unnecessary ones, fixing existing ones and adding new children if necessary (depending on the state).

• process_ui_events()

  Process GUI events.

  This function merely abstracts the function so nothing is done when no UI is running.

• warning(msg, parent = None)

  Handle a warning message.

Imported Names

© Copyright 2002-2009 Enthought, Inc.