Table of Contents

Module: help chimera/help.py

Chimera GUI Help Support

Help should be registered for all modeless dialogs. Registering help makes help on context work. Specific help can be registered for widgets within the dialog.

Chimera does not support help in modal dialogs.

Imported modules   
import chimera
import os
import replyobj
import sys
import urlparse
Functions   
contextCB
display
dump
register
  contextCB 
contextCB ( app )

Display help for selected widget.

contextCB(app) => None

  display 
display (
        widgetOrURL,
        package=chimera,
        newWindow=False,
        )

Display given html help file.

display(widgetOrURL, package=chimera, newWindow=False) => None

The url may be either a string, or a "widget" that has been registered. In the latter case it is mapped according to how it was registered.

  dump 
dump ( dumpfile )

dump contents of help map to file

  register 
register (
        widget,
        urlAndPackage=None,
        balloon=None,
        )

Register URL for context sensitive help.

register(widget, urlAndPackage, balloon) => None

urlAndPackage

can be a URL or (URL, package) balloon -- balloon help text

While it is expected that the widget argument will be a (Tk) widget, it can be any python object.


Table of Contents

This document was automatically generated on Wed Mar 26 19:02:49 2003 by HappyDoc version 2.1