<XAP_CocoaPluginDelegate> Protocol Reference

In order for AbiWord to interact with the plug-in, the plug-in needs to implement this protocol. More...

#import <xap_CocoaPlugin.h>

List of all members.

Public Member Functions
(BOOL)	- pluginCanRegisterForAbiWord:version:interface:
	This will be called immediately after initialization;.
(BOOL)	- pluginIsActive
	Returns whether the plug-in is active or not.
(void)	- pluginActivate
	This is a request for the plug-in to activate.
(void)	- pluginDeactivate
	This is a request for the plug-in to deactivate.
(BOOL)	- pluginCanDeactivate
	The plug-in should attempt to save all files, etc., since it is about to be asked to deactivate.
(void)	- pluginCurrentDocumentHasChanged
	AbiWord will call this if the focus changes to a different document, or different window or panel, or if the current document is closed.
(NSString *)	- pluginName
	The name of the plug-in.
(NSString *)	- pluginAuthor
	The name(s) of the plug-in author(s).
(NSString *)	- pluginVersion
	The version of the plug-in.
(NSString *)	- pluginDescription
	A short description of what the plug-in does.
(NSString *)	- pluginUsage
	A short description of how to use the plug-in.

---

Detailed Description

In order for AbiWord to interact with the plug-in, the plug-in needs to implement this protocol.

As a minimum, the bundle's principal class must implement the NSObject protocol and the XAP_CocoaPluginDelegate's pluginCanRegisterForAbiWord:version:interface: method.

---

Member Function Documentation

- (void) pluginActivate

This is a request for the plug-in to activate.

- (NSString *) pluginAuthor

The name(s) of the plug-in author(s).

Returns:

The name(s) of the plug-in author(s).

- (BOOL) pluginCanDeactivate

The plug-in should attempt to save all files, etc., since it is about to be asked to deactivate.

Returning NO will not necessarily prevent the request to deactivate.

Returns:

Should return NO *only* if the user has answered "Cancel" to an alert about an unsaved document; otherwise YES.

- (BOOL) pluginCanRegisterForAbiWord:		(XAP_CocoaPlugin *)	AbiWord
version:		(NSString *)	version
interface:		(unsigned long)	interface

This will be called immediately after initialization;.

If the bundle's principal class implements *only* this method, it must immediately set the real XAP_CocoaPluginDelegate object as AbiWord's delegate using XAP_CocoaPlugin's setDelegate: method.

The plug-in should not activate - wait for XAP_CocoaPluginDelegate's pluginActivate: method to be called.

Parameters:

	AbiWord	The main interface to AbiWord.
	version	This is the AbiWord version string (e.g., "2.2.5").
	interface	This is the date (YYYYMMDD) that the CocoaPlugin API was last changed.

Returns:

Should return NO if for some reason the plug-in won't work with the current version of AbiWord.

- (void) pluginCurrentDocumentHasChanged

AbiWord will call this if the focus changes to a different document, or different window or panel, or if the current document is closed.

- (void) pluginDeactivate

This is a request for the plug-in to deactivate.

The plug-in *must* comply.

- (NSString *) pluginDescription

A short description of what the plug-in does.

Returns:

A short description of what the plug-in does.

- (BOOL) pluginIsActive

Returns whether the plug-in is active or not.

Returns:

Should return YES if the plug-in is active; otherwise NO.

- (NSString *) pluginName

The name of the plug-in.

Returns:

The name of the plug-in.

- (NSString *) pluginUsage

A short description of how to use the plug-in.

Returns:

A short description of how to use the plug-in.

- (NSString *) pluginVersion

The version of the plug-in.

Returns:

The version of the plug-in.

---

The documentation for this protocol was generated from the following file:

• xap_CocoaPlugin.h