IPlugIn.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPLUGIN__
#define __IPLUGIN__

class ISession;
class IPlugIn;
class IDocument;

typedef IPlugIn *(*GetPlugInFunc)();


class IPlugIn {
public:
 typedef enum { kUnknownThreadingPolicy=0, kMainThreadOnly=1, kMultipleThreads=2 } ThreadingPolicy;
 virtual bool16 Load(ISession* theSession) = 0;
 
 virtual bool16 Unload() = 0;
 
 virtual bool16 LoadAtStartup() = 0;
 
 virtual bool16 CanUnload() const = 0;
 
 virtual void FixUpData(IDocument *doc) = 0;

 virtual PluginID GetPluginID() const = 0;

 // Called by the ObjectModel to inform the plugin of it's pluginID.
 // do not override this method -- use the default implementation in PlugIn.
 virtual void SetPluginID(PluginID pluginID) = 0;

#ifdef MACINTOSH

 // Called by the ObjectModel to inform the plugin of it's CFBundleRef.
 // do not override this method -- use the default implementation in PlugIn.
 virtual void SetBundleRef(CFBundleRef bundle) = 0;
#endif

 // Returns the resource file of the plugin. You should not need 
 // to override this method -- use the default implementation in PlugIn.
 virtual IDFile GetResourceFile() const = 0;
 
 // The plugin should install the factory methods for the
 // classes it contains. You should not need to override
 // this method -- use the default implementation in PlugIn.
 virtual void LoadFactories(PluginID ownerComponent, ISession *theSession) = 0;
 

protected:
 virtual ~IPlugIn(); 
};


#endif // __IPLUGIN__