ISpreadFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Bob Freeman
// 
// $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 __ISpreadFacade__
#define __ISpreadFacade__

// ----- Interfaces -----
#include "ILayoutObject.h"
#include "Utils.h"

// ----- ID.h files -----
#include "SpreadID.h"

namespace Facade
 {
 class ISpreadFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_ISPREADFACADE };
 
 virtual ErrorCode SetPageColorLabel
 (
 UIDList pagesOrSpreads, 
 UIDRef color
 ) = 0;


 virtual const UID GetPageColorLabel
 (
 UIDRef page
 ) = 0;

 virtual void GetEffectiveLayoutPolicy(const UIDList& pageList, ILayoutObject::LayoutPolicyList& outList) const = 0;
 
 virtual void GetLayoutPolicy(const UIDList& pageList, ILayoutObject::LayoutPolicyList& outList) const = 0;

 virtual ErrorCode SetLayoutPolicy(const UIDList& pageList, ILayoutObject::LayoutPolicy policy) = 0;
 
 virtual bool32 CanApplyBasedOnMasterPolicy(const UIDList& pageList) const = 0;

 virtual void GetOptionalPage(const UIDList& pageList, K2Vector<bool16>& outList) const = 0;

 virtual ErrorCode SetOptionalPage(const UIDList& pageList, bool16 optional) = 0;
 };
}

#endif // __ISpreadFacade__