/* -*- mode: C++; tab-width: 4; c-basic-offset: 4; -*- */

/* AbiSource Application Framework
 * Copyright (C) 2005 Francis James Franklin
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  
 * 02111-1307, USA.
 */

#ifndef COCOAPLUGIN_ABIMAILMAN_H
#define COCOAPLUGIN_ABIMAILMAN_H

#import <Cocoa/Cocoa.h>

#import "xap_CocoaPlugin.h"

@class AbiMailMan_Controller;

@interface AbiMailMan : NSObject <XAP_CocoaPluginDelegate>
{
	XAP_CocoaPlugin *	m_AbiWord;

	AbiMailMan_Controller *	m_Controller;
}
- (id)init;
- (void)dealloc;

- (XAP_CocoaPlugin *)AbiWord;

/* Bundle plugins must implement this, which will be called immediately after initialization;
 * return NO if for some reason the plugin won't work with the current version of AbiWord.
 */
- (BOOL)pluginCanRegisterForAbiWord:(XAP_CocoaPlugin *)AbiWord version:(NSString *)version interface:(unsigned long)interface;

/* All plugins should implement the following methods:
 */

- (BOOL)pluginIsActive;
- (void)pluginActivate;   /* Add menuitems etc. */
- (void)pluginDeactivate; /* Remove them...     */

/* Plugin should attempt to save all files, and return NO *only* if the user has answered
 * "Cancel" to an alert about an unsaved document.
 */
- (BOOL)pluginCanDeactivate;

/* 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)pluginCurrentDocumentHasChanged;

- (NSString *)pluginName;
- (NSString *)pluginAuthor;
- (NSString *)pluginVersion;
- (NSString *)pluginDescription;
- (NSString *)pluginUsage;
@end

#endif /* ! COCOAPLUGIN_ABIMAILMAN_H */