Package mrv :: Package maya :: Package ui :: Module dialog :: Class ProgressWindow

Class ProgressWindow

              object --+        
                       |        
     interface.Interface --+    
                           |    
interface.iProgressIndicator --+
                               |
                              ProgressWindow

Simple progress window wrapping the default maya progress window

Instance Methods

[hide private]

Inherited from interface.Interface: supports

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Initialization

__init__(self, **kwargs)
Everything that iProgress indicator and Maya Progress Window support

source code

begin(self)
Show our window

source code

end(self)
Close the progress window

source code

Edit

refresh(self, message=None)
Finally show the progress window

source code

setAbortable(self, state)
If state is True, the progress may be interrupted, if false it cannot be interrupted

source code

Inherited from interface.iProgressIndicator: set, setRange, setRelative, setRoundRobin, setup

Query

isCancelRequested(self)
Returns: True if the action should be cancelled, False otherwise

source code

isAbortable(self)
:return : true if the process can be aborted

source code

Inherited from interface.iProgressIndicator: get, isRelative, prefix, range, roundRobin, value

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **kwargs)
(Constructor)

source code

Everything that iProgress indicator and Maya Progress Window support

Parameters:

min - the minimum progress value
max - the maximum progress value
is_relative - if True, the values given will be scaled to a range of 0-100, if False no adjustments will be done
round_robin - see setRoundRobin
kwargs - additional arguments being ignored

Overrides: object.__init__