DBProgressProtocol documentation

Software documentation for the DBProgressProtocol protocol

Declared in:

DBProgressProtocol.h

Conforms to:

NSObject

Description forthcoming.

Method summary

- (void) incrementCurrentValue: (unsigned long)amount;

increments the current value by given amount

- (void) reset;

reinitializes internal status (current, maxmimum and percentage)

- (void) setCurrentDescription: (NSString*)desc;

Sets a description of the current phase

- (void) setCurrentValue: (unsigned long)current;

Sets the current progress, e.g. the current count

- (void) setEnd;

Forces completion

- (void) setMaximumValue: (unsigned long)max;

Sets the maximum value expected on which to calculate progress on.
E.g. it could be the maximum expected number of records.

- (void) setShouldStop: (BOOL)flag;

marks if the process associated should stop

- (BOOL) shouldStop;

if the process the progress is associated should stop