Package Pmv :: Module editCommands :: Class AddHydrogensGUICommand
[hide private]
[frames] | no frames]

Class AddHydrogensGUICommand

source code

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

This GUICOMMAND class calls the AddHydrogenCommand class. 
    
Package:Pmv
    
Module :editCommands
    
Class:AddHydrogensGUICommand
    
Command:add_hGC
    
Synopsis:

        None<---add_hGC(nodes, polarOnly=0, method='noBondOrder', renumber=1,**kw)

    
Required Arguments:

        nodes --- TreeNodeSet holding the current selection

        polarOnly --- default is 0

        method --- Hydrogen atoms can be added using 2 different methods, ex: method='withBondOrder', default is 'noBondOrder'

        renumber --- default is 1

    



Instance Methods [hide private]
  __init__(self, func=None)
  onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.
  __call__(self, nodes, polarOnly=False, method='noBondOrder', renumber=True, **kw)
None<---add_hGC(nodes, polarOnly=False, method='noBondOrder', renumber=1,**kw) nodes --- TreeNodeSet holding the current selection polarOnly --- default is False method --- Hydrogen atoms can be added using 2 different methods, ex: method='withBondOrder', default is 'noBondOrder' renumber --- Boolean flag when set to True the atoms are renumbered.
  doit(self, nodes, polarOnly, method, renumber)
None <- add_h(nodes, polarOnly=0, method='noBondOrder', renumber=1)
  guiCallback(self)

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildFormDescr, buildLogArgList, checkDependencies, cleanup, customizeGUI, doitWrapper, getArguments, getHelp, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, 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, func=None)
(Constructor)

source code 
None
Overrides: mvCommand.MVCommand.__init__

onAddCmdToViewer(self)

source code 
method called when an instance of this command is added to the viewer. This enable viewer-addition time initializations
Overrides: ViewerFramework.VFCommand.Command.onAddCmdToViewer
(inherited documentation)

__call__(self, nodes, polarOnly=False, method='noBondOrder', renumber=True, **kw)
(Call operator)

source code 
None<---add_hGC(nodes, polarOnly=False, method='noBondOrder',
                          renumber=1,**kw)
           
nodes ---    TreeNodeSet holding the current selection
           
polarOnly --- default is False
           
method ---    Hydrogen atoms can be added using 2 different methods,
                      ex: method='withBondOrder', default is 'noBondOrder'
           
renumber ---  Boolean flag when set to True the atoms are renumbered. (default is True)
           

Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, nodes, polarOnly, method, renumber)

source code 
None <- add_h(nodes, polarOnly=0, method='noBondOrder', renumber=1)
Overrides: ViewerFramework.VFCommand.Command.doit

guiCallback(self)

source code 
None
Overrides: mvCommand.MVCommand.guiCallback