Instance Property

pausable

Indicates whether the receiver is tracking work that can be paused.

Declaration

@property(getter=isPausable) BOOL pausable;

Discussion

By default, NSProgress objects are not pausable.

You typically use this property to communicate whether controls for pausing should appear in a progress reporting user interface. NSProgress itself does not do anything with this property other than help pass the value from progress reporters to progress observers.

If an NSProgress is pausable, you should implement the ability to pause either by setting a block for the pausingHandler property, or by polling the paused property periodically while performing the relevant work.

It is valid for the value of this property to change during the lifetime of an NSProgress object. By default, NSProgress is KVO-compliant for this property, sending notifications on the same thread that updates the property.

See Also

Controlling Progress

cancellable

Indicates whether the receiver is tracking work that can be cancelled.

cancelled

Indicates whether the receiver is tracking work that has been cancelled.

- cancel

Cancel progress tracking.

cancellationHandler

The block to invoke when progress is cancelled.

paused

Indicates whether the receiver is tracking work that has been paused.

- pause

Pause progress tracking.

pausingHandler

The block to invoke when progress is paused.

- resume

Resume progress tracking.

resumingHandler

The block to invoke when progress is resumed.