IPreflightObjectModel.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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.
// 
//========================================================================================


#include "IPMUnknown.h"
#include "PackageAndPreflightID.h"
#include "IPreflightObject.h"

class IDocument;
class ISpread;
class IPage;
class IShape;
class IPreflightExpansionHelper;

class IPreflightObjectModel : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTOBJECTMODEL };

public:
 virtual void Startup() = 0;

 virtual void Shutdown() = 0;

 virtual void OnCloseDocument(IDocument* iDoc) = 0;

 virtual void OnInvalidateObject(const PreflightObjectID& objID) const = 0;

 virtual bool IsValidObject(const PreflightObjectID& objID) const = 0;

 virtual IPreflightObject* QueryObject(const PreflightObjectID& objID) const = 0;

 virtual WideString GetClassScriptingString(PreflightObjectClassID classID) const = 0;

 virtual PreflightObjectClassID GetClassFromScriptingString(const WideString& scriptString) const = 0;

 virtual PMString GetObjectDescription(const PreflightObjectID& objID) const = 0;

 virtual PMString GetObjectSortValue(const PreflightObjectID& objID) const = 0;

 virtual bool CanBeSelected(const PreflightObjectID& objID) const = 0;
 
 virtual bool SelectObject(const PreflightObjectID& objID) const = 0;

 virtual PMString GetPage(const PreflightObjectID& objID) const = 0;

 virtual PMString GetSubpartName(ClassID subpartID) const = 0;

 virtual PreflightObjectClassIDVector GetAllKnownClasses() const = 0;

 virtual bool ParentChildRelationshipExists(PreflightObjectClassID parentClass, PreflightObjectClassID childClass) const = 0;

 virtual void GetHierarchyAncestorsOfClass
 (
 PreflightObjectClassID childClass, 
 PreflightObjectClassIDVector& ancestorClasses
 ) const = 0;
 
 virtual void GetHierarchyAncestorsOfClass
 (
 const PreflightObjectClassIDVector& childClasses, 
 PreflightObjectClassIDVector& ancestorClasses
 ) const = 0; 
 
 virtual void GetExpansionAncestorsOfClass
 (
 PreflightObjectClassID childClass, 
 PreflightObjectClassIDVector& ancestorClasses
 ) const = 0;
 
 virtual void GetExpansionAncestorsOfClass
 (
 const PreflightObjectClassIDVector& childClasses, 
 PreflightObjectClassIDVector& ancestorClasses
 ) const = 0; 
 
 virtual void Expand(IPreflightExpansionHelper& helper) const = 0;
};