Package ViewerFramework :: Module dejaVuCommands :: Class RenderLargeImageCommand
[hide private]
[frames] | no frames]

Class RenderLargeImageCommand

source code

VFCommand.Command --+
                    |
                   RenderLargeImageCommand


Package : ViewerFramework
Module  : dejaVuCommands
Class   : RenderLargeImageCommand
Command : renderLargeImage

Description:
This command allows the user to enable the rendering of images
larger than the screen.

Synopsis:
None <- renderLargeImage(width=None, height=None, border=0,
                          outputFile='test.jpg', backbuffer=True)
width, height   : to specify either the width or the height.
border          : (default 0) specify the size of a border can be any
                  any small integer between 1 and 20.
outputFile      : path to a output file. Use .tif to avoid compression
backBuffer      : default True, Boolean flag turn to False to see
                  the tiles render.
checkeredBackground: (False)

Keywords : large, image, tile rendering



Instance Methods [hide private]
  doit(self, width=None, height=None, border=0, outputFile='test.tif', backBuffer=True, checkeredBackground=False)
virtual method.
  __call__(self, width=None, height=None, border=0, outputFile='test.jpg', backBuffer=True, checkeredBackground=False, **kw)
None <- commandName( *args, **kw)
  guiCallback(self)
Default callback function called by the gui
  getConstrainedWidth(self, mode, height, width)
  getConstrainedHeight(self, mode, width, height)
  fixHeight_cb(self, event=None)
  fixWidth_cb(self, event=None)
  buildFormDescr(self, formName)
descr <- buildFormDescr(self, formName): this virtual method is implemented in the classes derived from Command.
  setEntry_cb(self, filename)
  cancel_cb(self)

Inherited from VFCommand.Command: __init__, __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, strArg, tkCb, updateGeom, warningMsg

Inherited from VFCommand.Command (private): _strArg


Class Variables [hide private]

Inherited from VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

doit(self, width=None, height=None, border=0, outputFile='test.tif', backBuffer=True, checkeredBackground=False)

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

__call__(self, width=None, height=None, border=0, outputFile='test.jpg', backBuffer=True, checkeredBackground=False, **kw)
(Call operator)

source code 
None <- commandName( *args, **kw)
Overrides: VFCommand.Command.__call__
(inherited documentation)

guiCallback(self)

source code 
Default callback function called by the gui
Overrides: VFCommand.Command.guiCallback
(inherited documentation)

getConstrainedWidth(self, mode, height, width)

source code 
None

getConstrainedHeight(self, mode, width, height)

source code 
None

fixHeight_cb(self, event=None)

source code 
None

fixWidth_cb(self, event=None)

source code 
None

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

setEntry_cb(self, filename)

source code 
None

cancel_cb(self)

source code 
None