|
/ . / chimera / extension / base.py / EMO
EMO stands for Extension Management Object
This class defines the protocol used by the Extension Manager to
communicate with tools and should be the base class for all
package tools.
Extension names are assumed to be unique and may present in more
than one category.
|
Methods
|
|
|
|
showOnToolbar
|
showOnToolbar ( self )
|
|
|
hasUI
|
hasUI ( self )
Return whether tool activation starts a UI
|
|
|
description
|
description ( self )
Return short description (appropriate for balloon help)
|
|
|
menuActivate
|
menuActivate ( self, cat )
Activate tool from menu
|
|
|
documentation
|
documentation ( self )
Return full documention URL
|
|
|
restoreSession
|
restoreSession ( self, xmlObj )
Restore tool from session XML object
|
|
|
module
|
module ( self, modName=None )
Return a module in the package (empty name -> package itself)
|
|
|
removeFromToolbar
|
removeFromToolbar ( self )
|
|
|
activate
|
activate ( self )
Activate tool and return an instance (if appropriate)
|
|
|
saveSession
|
saveSession ( self )
Save tool as session XML object
|
|
|
categoryDescriptions
|
categoryDescriptions ( self )
Return a dictionary of categories and descriptions.
When available, this method will be used in preference
to "categories". Descriptions from this dictionary will
be used for balloon help text in the Tools menu (but tool
bar help will always be from "description" method).
|
|
|
__init__
|
__init__ ( self, path )
|
|
|
path
|
path ( self, file=None )
Return the path to a file in the package
|
|
|
icon
|
icon ( self )
Return image or file/URL to represent tool
|
|
|
packageName
|
packageName ( self )
Return the name of the package that this EMO came from
|
|
|
categories
|
categories ( self )
Return list of category names in which this tool belongs
|
|
|
name
|
name ( self )
Return unique display name for this tool
|
|
|