The P4.Progress
class is a handler class that
provides access to progress indicators from the server. After defining
the progress class, set P4.progress
to an instance of
a subclass of P4.Progress
, use
p4.using_progress( MyProgress() )
, or pass the progress
indicator as a named parameter for one statement only.
You must implement all five of the following methods:
init()
, setDescription()
,
update()
, setTotal()
, and done()
,
even if the implementation consists of trivially returning
0
.
None.
Constructs a new subclass of P4.Progress
.
Initialize progress indicator.
Description and type of units to be used for progress reporting.
If non-zero, user has requested a cancellation of the operation.
Total number of units expected (if known).
If non-zero, operation has failed.