Package Pmv :: Module displayCommands :: Class ShowMolecules

Class ShowMolecules

ViewerFramework.VFCommand.Command --+    
                                    |    
                  mvCommand.MVCommand --+
                                        |
                                       ShowMolecules

The showMolecules command allows the user to show or hide chosen molecules.
    
Package : Pmv
    
Module  : displayCommands
    
Class   : ShowMolecules
    
Command : showMolecules
    
Synopsis:

        None <--- showMolecules(molName, negate = 0, **kw)

        molName --- list of the string representing the name of the molecules to be hidden or shown

        negate --- Boolean Flag when True the molecules corresponding to the given names are hidden, when set to 0 they will be shown

        keywords --- show hide molecules

Instance Methods

[hide private]

__init__(self)

addCallback(self, f, event=None)
add a callback function to be called when the visibility flag of a molecule is toggled.

removeCallback(self, f, event=None)
remove a callback function called when the visibility flag of a molecule is toggled.

onRemoveObjectFromViewer(self, obj)

onAddObjectToViewer(self, obj)

doit(self, molName, negate=False)
virtual method.

__call__(self, molName, negate=False, **kw)
None <- showMolecules(molName, negate=0, **kw)

buildFormDescr(self, formName='default')
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.

checkButton_cb(self, molName)

showHideAll_cb(self)

guiCallback(self)

dismissForm(self)

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildLogArgList, checkDependencies, cleanup, customizeGUI, doitWrapper, getArguments, getHelp, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, onAddCmdToViewer, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, setupUndoBefore, showForm, tkCb, updateGeom, warningMsg

Class Variables

[hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly

Method Details

[hide private]

init(self)
(Constructor)

source code

None

Overrides: mvCommand.MVCommand.__init__

addCallback(self, f, event=None)

source code

add a callback function to be called when the visibility flag of a molecule is toggled. The function is called after the flag has been toggled and takes one argument which is the molecule

removeCallback(self, f, event=None)

source code

remove a callback function called when the visibility flag of a molecule is toggled.

onRemoveObjectFromViewer(self, obj)

source code

None

onAddObjectToViewer(self, obj)

source code

None

doit(self, molName, negate=False)

source code

virtual method. Has to be implemented by the sub classes

Overrides: ViewerFramework.VFCommand.Command.doit: (inherited documentation)

call(self, molName, negate=False, **kw)
(Call operator)

source code

None <- showMolecules(molName, negate=0, **kw)

molName : list of string name of molecules (mol.name)

negate : flag when set to 1 hide the given molecule

Overrides: ViewerFramework.VFCommand.Command.__call__

buildFormDescr(self, formName='default')

source code

descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command. This is where the inputFormDescr is created and the description of the widgets appended. If a command has several inputForm buildFormDescr should build all the inputFormDescr and you do a if / elif check to know which one to create. formName : string name of the form corresponding to this descr.