xap_CocoaPlugin.h

Go to the documentation of this file.

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

/* AbiSource Application Framework
 * Copyright (C) 2004-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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef XAP_COCOAPLUGIN_H
#define XAP_COCOAPLUGIN_H

#define XAP_COCOAPLUGIN_INTERFACE 20050925 
#import <Cocoa/Cocoa.h>

#import "xap_CocoaCompat.h"

@class XAP_CocoaPlugin;

@protocol XAP_CocoaPlugin_Tool;
@protocol XAP_CocoaPlugin_ToolProvider;

@protocol XAP_CocoaPlugin_ToolInstance

- (id <NSObject, XAP_CocoaPlugin_Tool>)tool;

- (NSView *)toolbarButton;

- (NSMenuItem *)toolbarMenuItem;

- (NSString *)configWidth;

- (NSString *)configHeight;

- (NSString *)configImage;

- (NSString *)configAltImage;

- (void)setConfigWidth:(NSString *)width;

- (void)setConfigHeight:(NSString *)height;

- (void)setConfigImage:(NSString *)image;

- (void)setConfigAltImage:(NSString *)altImage;
@end

@protocol XAP_CocoaPlugin_Tool

- (NSString *)identifier;

- (NSString *)description;

- (void)setProvider:(id <NSObject, XAP_CocoaPlugin_ToolProvider>)provider;

- (id <NSObject, XAP_CocoaPlugin_ToolProvider>)provider;

- (id <NSObject, XAP_CocoaPlugin_ToolInstance>)tool;
@end

@protocol XAP_CocoaPlugin_ToolProvider

- (NSString *)name;

- (id <NSObject, XAP_CocoaPlugin_Tool>)toolWithIdentifier:(NSString *)identifier;

- (NSArray *)toolIdentifiers;

- (NSString *)toolDescription:(NSString *)identifier;

@end

@protocol XAP_CocoaPlugin_SimpleXML

- (BOOL)startElement:(NSString *)name attributes:(NSDictionary *)attributes;

- (BOOL)endElement:(NSString *)name;

- (BOOL)characterData:(NSString *)data;

@end

@protocol XAP_CocoaPlugin_MenuItem

- (void)setLabel:(NSString *)label;

- (NSString *)label;

#if 0 // YAGNI

- (void)setAction:(SEL)aSelector;

- (SEL)action;

- (void)setTarget:(id <NSObject>)target;

- (id <NSObject>)target;
#endif

- (void)setTag:(NSInteger)anInt;

- (NSInteger)tag;

- (void)setState:(int)state;

- (int)state;

- (void)setEnabled:(BOOL)enabled;

- (BOOL)isEnabled;

@end

@protocol XAP_CocoaPlugin_FramelessDocument

- (BOOL)exportDocumentToFile:(NSString *)path exportOptions:(NSDictionary *)options;

@end

@protocol XAP_CocoaPlugin_Document

- (BOOL)documentStillExists;

- (NSString *)title;

- (NSString *)selectWord;

- (NSString *)selectedText;

- (void)insertText:(NSString *)text;

/* Mail Merge interface
 */
- (NSString *)documentMailMergeSource; // may return nil
- (void)setDocumentMailMergeSource:(NSString *)path;

- (void)insertDocumentMailMergeField:(NSString *)field_name;

- (NSArray *)documentMailMergeFields;
- (void)setDocumentMailMergeFields:(NSArray *)field_array;
- (void)unsetDocumentMailMergeFields;

/* value_dictionary maps (NSString *) keys [field names] to (NSString *) values.
 */
- (void)setDocumentMailMergeValues:(NSDictionary *)value_dictionary;

@end

@protocol XAP_CocoaPluginDelegate

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

- (BOOL)pluginIsActive;

- (void)pluginActivate;   /* Add menuitems etc. */

- (void)pluginDeactivate; /* Remove them...     */

- (BOOL)pluginCanDeactivate;

- (void)pluginCurrentDocumentHasChanged;

- (NSString *)pluginName;

- (NSString *)pluginAuthor;

- (NSString *)pluginVersion;

- (NSString *)pluginDescription;

- (NSString *)pluginUsage;

@end

@interface XAP_CocoaPlugin : NSObject
{
    id <NSObject, XAP_CocoaPluginDelegate>  m_delegate; 
}

- (id)init;

- (void)dealloc;

- (BOOL)loadBundleWithPath:(NSString *)path;

- (void)setDelegate:(id <NSObject, XAP_CocoaPluginDelegate>)delegate;

- (id <NSObject, XAP_CocoaPluginDelegate>)delegate;

- (void)appendMenuItem:(NSMenuItem *)menuItem;

- (void)removeMenuItem:(NSMenuItem *)menuItem;

- (id <NSObject, XAP_CocoaPlugin_Document>)currentDocument; // may return nil;

- (NSArray *)documents;                                     // array of id <NSObject, XAP_CocoaPlugin_Document>

- (NSString *)selectMailMergeSource; // may return nil

- (NSMutableArray *)importMailMergeSource:(NSString *)path;

- (id <NSObject, XAP_CocoaPlugin_FramelessDocument>)importDocumentFromFile:(NSString *)path importOptions:(NSDictionary *)options;

- (id <NSObject, XAP_CocoaPlugin_MenuItem>)contextMenuItemWithLabel:(NSString *)label;

- (NSArray *)toolProviders;

- (id <NSObject, XAP_CocoaPlugin_ToolProvider>)toolProvider:(NSString *)name;

- (NSString *)findResourcePath:(NSString *)relativePath;

- (NSString *)userResourcePath:(NSString *)relativePath;

- (NSString *)parseFile:(NSString *)path simpleXML:(id <XAP_CocoaPlugin_SimpleXML>)callback;

@end

#endif /* XAP_COCOAPLUGIN_H */