IPreflightObjectModelService.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.
// 
// 
// This service provides the DOM and mapping to real (or derived) InDesign elements.
// 
// TBD: Split this up into separate services for mapping vs hierarchy? Seems like
// overkill since in most cases the two will be tightly bound
// 
//========================================================================================


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

#include "IPreflightObject.h"

class IDocument;
class IPreflightExpansionHelper;

class IPreflightObjectModelService : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTOBJECTMODELSERVICE };

public:
 //-----------------------
 // MAPPING

 virtual PreflightObjectClassIDVector GetMappedClasses() 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;

 //-----------------------
 // HIERARCHY

 virtual PreflightObjectClassIDVector GetHierarchyClasses() const = 0;

 virtual PreflightObjectClassIDVector GetChildClasses(PreflightObjectClassID parentClass) const = 0;
 
 virtual PreflightObjectClassIDVector GetParentClasses(PreflightObjectClassID childClass) const = 0;
 
 //-----------------------
 // EXPANSION

 virtual PreflightObjectClassIDVector GetExpansionClasses() const = 0;

 virtual PreflightObjectClassIDVector GetExpandsIntoClasses(PreflightObjectClassID parentClass) const = 0;
 
 virtual void Expand(IPreflightExpansionHelper& helper) const = 0;

 //-----------------------
 // NOTIFICATION (to update caches etc)

 virtual void OnCloseDocument(IDocument* iDoc) = 0;
 
 virtual void OnInvalidateObject(const PreflightObjectID& objID) = 0;

 //-----------------------
 // UTILITY

 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;
};