ApertureEditPlugIn

Declared In:

ApertureEditPlugIn.h

Overview

Protocol definition for an Aperture Edit plug-in session.

Methods

-beginEditSession: Notifies a plug-in that Aperture is ready for editing.
-editManager:didImportImageAtPath:versionUniqueID:: A callback for the Edit manager's import method.
-editManager:didNotImportImageAtPath:error:: A callback for the Edit manager's import method.
-editWindow: Returns the window that contains the plug-in's entire UI.
-initWithAPIManager:: Brokers version management between a plug-in and the host application.

beginEditSession

Notifies a plug-in that Aperture is ready for editing.

- (void)beginEditSession;

Discussion

Notification can take place even though Aperture has not yet asked for the plug-in's UI. The plug-in can begin making calls, getting properties, and so on.

editManager:didImportImageAtPath:versionUniqueID:

A callback for the Edit manager's import method.

- (void)editManager:(id<ApertureEditManager>)editManager 
        didImportImageAtPath:(NSString *)path versionUniqueID:(NSString *)versionUniqueID;

Parameters

editManager
path
versionUniqueID

Discussion

Aperture calls this method after the successful completion of an import. If a plug-in does request imports, it should not end or cancel the edit session until it receives one of the import callbacks.

editManager:didNotImportImageAtPath:error:

A callback for the Edit manager's import method.

- (void)editManager:(id<ApertureEditManager>)editManager 
        didNotImportImageAtPath:(NSString *)path error:(NSError *)error;

Parameters

editManager
path
error

Discussion

Aperture calls this method after an import failure. If your plug-in does request imports, it should not end or cancel the edit session until it receives one of the import callbacks.

editWindow

Returns the window that contains the plug-in's entire UI.

- (NSWindow *)editWindow;

Return Value

An NSWindow. Returning nil indicates an error condition. Aperture deallocates the plug-in.

Discussion

Aperture places this window on screen, centers it over the Aperture window, and runs it modally.

initWithAPIManager:

Brokers version management between a plug-in and the host application.

- (id)initWithAPIManager:(id<PROAPIAccessing>)apiManager;

Parameters

apiManager: The ProPlug plug-in manager object.

Return Value

id An initialized plug-in controller object.

Discussion

The apiManager object is the protocol broker between a plug-in and the host. It ensures that a plug-in supporting a particular version of the API is given the host objects that correspond to this version. A plug-in should call -apiForProtocol on the apiManager object to obtain a reference to the host edit manager for use throughout the editing process. If the plug-in fails to obtain a reference to the host edit manager, it should fail to initialize.

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-04-18