Package Pmv :: Module selectionCommands :: Class MVSaveSetCommand
[hide private]
[frames] | no frames]

Class MVSaveSetCommand

source code

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

Save a selection under a user specified name
    
Package : Pmv
    
Module  : selectionCommands
    
Class   : MVSaveSetCommand
    
Command : saveSet
    
Synopsis:

         None <- saveSet(nodes, name, comments='No description', **kw)
    
Required Arguments:
       
         nodes --- TreeNodeSet holding the current selection
         
name --- name under which the selected set will be saved
    
Optional Arguments:
           
         comments --- description of the saved set, default is 'No description'
         addToDashboard --whether to add set name to dashboard historylist, default is do not add
    



Instance Methods [hide private]
  doit(self, nodes, name, comments=None, addToDashboard=False)
virtual method.
  __call__(self, nodes, name, comments='No description', **kw)
None <- saveSet(nodes, name, comments='No description', **kw)
  buildFormDescr(self, formName)
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.
  guiCallback(self)
Default callback function called by the gui

Inherited from mvCommand.MVCommand: __init__, 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]

doit(self, nodes, name, comments=None, addToDashboard=False)

source code 
virtual method. Has to be implemented by the sub classes
Overrides: ViewerFramework.VFCommand.Command.doit
(inherited documentation)

__call__(self, nodes, name, comments='No description', **kw)
(Call operator)

source code 

None <- saveSet(nodes, name, comments='No description', **kw)

nodes --- TreeNodeSet holding the current selection

name --- name under which the selected set will be saved

comments --- description of the saved set, default is 'No description'
Overrides: ViewerFramework.VFCommand.Command.__call__

buildFormDescr(self, formName)

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.
Overrides: ViewerFramework.VFCommand.Command.buildFormDescr
(inherited documentation)

guiCallback(self)

source code 
Default callback function called by the gui
Overrides: mvCommand.MVCommand.guiCallback