FxProgressAPI

Introduction

Defines the methods provided by the host application to let a plug-in report progress and to support user cancellation.

Discussion

NOTE: Some host applications may not implement this protocol.

Methods

-updateProgress:

Indicates whether or not the user has cancelled.

-userHasCancelled

Indicates whether or not the user has cancelled.

Indicates whether or not the user has cancelled.

- (BOOL)updateProgress:(float)percentDone; 

Parameters

percentDone

A floating-point number between 0.0 and 100.0, indicating the progress of the render operation.

Return Value

YES if the user has cancelled. NO otherwise.

Discussion

A plug-in should call this method (or the -userHasCancelled method) periodically (say, once every tenth of a second) during a slow render. If the user cancels, the method returns YES, and the plug-in should then abort the rest of the render, and return NO from its render method.

Indicates whether or not the user has cancelled.

- (BOOL)userHasCancelled;

Return Value

YES if the user has cancelled. NO otherwise.

Discussion

A plug-in should call this method (or the -updateProgress method) periodically (say, once every tenth of a second) during a slow render. If the user cancels, the method returns YES, and the plug-in should then abort the rest of the render and return NO from its render method.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-06-05