IContentMgr.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.
// 
// 
// Purpose:
// Manages all content added to the document. Keeps track of what classes
// and tags are in the document, what plug-ins added them, etc.
// 
//========================================================================================

#ifndef __IContentMgr__
#define __IContentMgr__

// ----- Interfaces -----

#include "IPMUnknown.h"
#include "ITagRegistry.h"
#include "PluginMetadata.h"

// ----- Includes -----

#include "K2Vector.h"


class PMString;
class FormatID;
class IDocument;
class IGatherIDStreamData;

class IContentMgr : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ICONTENTMGR };
 
 struct PluginInfo {
 PMString fPluginName; // name of the plug-in
 int32 fDocMajorVersion; // version number of the plug-in
 int32 fDocMinorVersion;
 bool16 fIsMissing; // kTrue if the plugin is not running.
 ITagRegistry::TagPriority fPriority; // default, critical, or ignore
 
 PluginMetadata fMetadata; // extra plug-in info: company name, url, alert
 PluginID fPluginID;
 };

 typedef K2Vector<PluginID> PluginIDList;
 
 virtual ErrorCode GetStatus() const = 0;
 
 virtual bool16 AlertMissingPlugins(const IDFile *sourcePub, const PluginIDList& alertOnList, std::string assetRef = "") = 0;

 virtual void GatherMissingPlugins(PluginIDList* alertOnList) = 0;

 virtual void CheckForMissingPlugins(const K2Vector<PluginID> *removedPlugins = nil, const K2Vector<PluginID> *ignoredPlugins = nil) = 0;
 
 virtual void FixupMissingPlugins(IDocument *doc, const K2Vector<PluginID> &list) = 0;

 virtual bool16 IgnoreAllMissingPlugins() const = 0;

 virtual void SetIgnoreAllMissingPlugins() = 0;

 virtual void MarkAllPluginsUntouched() = 0;
 virtual void RemoveUntouchedPlugins() = 0;
 
 virtual void AddTag(ImplementationID newTag, ClassID context) = 0;
 
 virtual void AddClass(ClassID clsID) = 0;
 
 virtual int32 GetMissingPluginCount() const = 0;
 
 virtual PluginID GetNthMissingPlugin(int32 n, PluginInfo *info) const = 0;

 virtual void GetMissingPlugins(K2Vector<PluginID> &list) const = 0;
 
 virtual int32 GetPluginCount() const = 0;

 virtual PluginID GetFirstPlugin(PluginInfo *info = nil) const = 0;

 virtual PluginID GetNextPlugin(PluginID plugin, PluginInfo *info = nil) const = 0;
 
 virtual bool16 GetPluginInfo(PluginID plugin, PluginInfo *info) const = 0;
 
 virtual bool16 IsMissingCriticalPlugins() const = 0;
 
 virtual bool16 IsMissingDefaultPlugins() const = 0;

 virtual ErrorCode GetPluginForClass(ClassID clsID, PluginID &plugin) const = 0;

 virtual ErrorCode GetPluginForImplementation(ImplementationID implID, PluginID &plugin) const = 0;
 
 virtual void SetCheckUIDsOnNextOpen(bool16 doIt) = 0;

 virtual bool16 GetCheckUIDsOnNextOpen() const = 0;
 
 virtual void VerifyPluginFormatNumber(PluginID plugin, const FormatID &format) = 0;

 virtual void RemovePlugin(PluginID plugin) = 0;

 virtual void IgnorePlugin(PluginID plugin) = 0;

 virtual void ProcessDeferredContent() = 0;

 virtual void Clear() = 0;

 virtual const PMString& GetApplicationName() const = 0;

 virtual void SetApplicationName(const PMString& newName) = 0;

#ifdef DEBUG

 virtual void VerifyContentMgr(IGatherIDStreamData *data) = 0;
 
 virtual void DumpMissingPluginData() = 0;
 
 virtual void DumpContentMgrData() = 0;
#endif
};


#endif // __IContentMgr__